1 PACKAGE ZPB_FEM_UTILS_PKG AS
2 /* $Header: ZPBVFEMS.pls 120.4 2007/12/04 14:39:23 mbhat noship $ */
3
4 ----------------------------------------------------------------------------
5 -- GET_MEMBER_NAME
6 --
7 -- Returns a member's name and description given the dimension ID, member ID
8 -- and member valueset. User primarily for views
9 --
10 -- IN: p_dimension_id - The FEM dimension ID
11 -- p_member_id - The member ID
12 -- p_valueset_id - The member valueset ID
13 --
14 -- OUT: The translated (to current language) name of the member
15 ----------------------------------------------------------------------------
16 function GET_MEMBER_NAME (p_dimension_id NUMBER,
17 p_member_id VARCHAR2,
18 p_valueset_id NUMBER)
19 return VARCHAR2;
20
21 ----------------------------------------------------------------------------
22 -- GET_MEMBER_DESC
23 --
24 -- Returns a member's description and description given the dimension ID,
25 -- member ID and member valueset. User primarily for views
26 --
27 -- IN: p_dimension_id - The FEM dimension ID
28 -- p_member_id - The member ID
29 -- p_valueset_id - The member valueset ID
30 --
31 -- OUT: The translated (to current language) description of the member
32 ----------------------------------------------------------------------------
33 function GET_MEMBER_DESC (p_dimension_id NUMBER,
34 p_member_id VARCHAR2,
35 p_valueset_id NUMBER)
36 return VARCHAR2;
37
38 ----------------------------------------------------------------------------
39 -- GET_MEMBERS
40 --
41 -- Returns the name, description pair of the dimension members in the given
42 -- dimension. Expected to be used via a TABLE function call. Function is
43 -- pipelined
44 --
45 -- IN: p_dimension_id - The IF of the dimension to get the members from
46 --
47 -- OUT: ZPB_MEMBER_TABLE_T - each dimension member, description pair
48 ----------------------------------------------------------------------------
49 function GET_MEMBERS (p_dimension_id NUMBER)
50 return ZPB_MEMBER_TABLE_T PIPELINED;
51
52 ----------------------------------------------------------------------------
53 -- GET_VARCHAR_MEMBERS
54 --
55 -- Same as GET_MEMBERS, but returns the members with varchar ID's
56 --
57 -- IN: p_dimension_id - The IF of the dimension to get the members from
58 --
59 -- OUT: ZPB_MEMBER_TABLE_T - each dimension member, description pair
60 ----------------------------------------------------------------------------
61 function GET_VARCHAR_MEMBERS (p_dimension_id NUMBER)
62 return ZPB_VAR_MEMBER_TABLE_T PIPELINED;
63
64 ----------------------------------------------------------------------------
65 -- GET_FEM_HIER_MEMBERS
66 --
67 -- Returns the name, description of the top level hierarchy members
68 --
69 -- IN: p_hier_vers_id - The hierarchy version ID
70 -- OUT: ZPB_MEMBER_TABLE_T - each dimension member, description pair
71 ----------------------------------------------------------------------------
72 function GET_TOP_HIER_MEMBERS (p_hier_vers_id IN NUMBER)
73 return ZPB_MEMBER_TABLE_T PIPELINED;
74
75 ----------------------------------------------------------------------------
76 -- GET_BUSAREA_HIERARCHIES
77 --
78 -- Returns the different hierarchy ID's, version IDs, and whether the
79 -- version should be considered the "effective" version. Function is
80 -- pipelined
81 --
82 -- IN: p_business_area - Option Business Area ID. Defaults to sys_context
83 -- p_version_type - Version draft type
84 -- OUT: ZPB_HIER_VERS_T - each dimension member, description pair
85 ----------------------------------------------------------------------------
86 function GET_BUSAREA_HIERARCHIES(p_business_area IN number := null,
87 p_version_type IN VARCHAR2 := 'P')
88 return ZPB_HIER_VERS_T PIPELINED;
89
90 ----------------------------------------------------------------------------
91 -- GET_HIERARCHY_MEMBERS
92 --
93 -- Returns the hierarchy (and hier version) member information for a given
94 -- dimension. You must call INIT_HIER_MEMBER_CACHE before you call this
95 -- function!
96 --
97 -- IN: p_logical_dim_id - The logical dimension ID to get the hier members for
98 -- (Replaced p_dimension_id with p_logical_dim_id for "Consistent Dimension"
99 -- p_business_area - Option Business Area ID. Defaults to sys_context
100 -- p_version_type - Version draft type
101 -- OUT: ZPB_HIER_MEMBER_T - each hierarchy node information
102 ----------------------------------------------------------------------------
103 function GET_HIERARCHY_MEMBERS(p_logical_dim_id IN NUMBER,
104 p_business_area IN NUMBER := null,
105 p_version_type IN VARCHAR2 := 'P')
106 return ZPB_HIER_MEMBER_T PIPELINED;
107
108 ----------------------------------------------------------------------------
109 -- GET_LIST_DIM_MEMBERS
110 --
111 -- Returns the members of a list dimension for a business area
112 --
113 -- IN: p_dimension_id - The dimension ID to get the hier members for
114 -- p_logical_dim_id - Logical Dim ID added for "Consistent Dimension"
115 -- p_business_area - Option Business Area ID. Defaults to sys_context
116 -- p_version_type - Version draft type
117 -- OUT: each dimension member ID information
118 ----------------------------------------------------------------------------
119 function GET_LIST_DIM_MEMBERS(p_dimension_id IN NUMBER,
120 p_logical_dim_id IN NUMBER,
121 p_business_area IN NUMBER := null,
122 p_version_type IN VARCHAR2 := 'P')
123 return ZPB_VAR_MEMBER_TABLE_T PIPELINED;
124
125 ----------------------------------------------------------------------------
126 -- INIT_HIER_MEMBER_CACHE
127 --
128 -- Initializes the cache which is used as part of GET_HIERARCHY_MEMBERS.
129 -- Must be called before you call GET_HIERARCHY_MEMBERS. Will initialize
130 -- for all dimensions of the business area passed in
131 --
132 -- IN: p_business_area - Option Business Area ID. Defaults to sys_context
133 -- p_version_type - Version draft type
134 ----------------------------------------------------------------------------
135 procedure INIT_HIER_MEMBER_CACHE(p_business_area IN NUMBER := null,
136 p_version_type IN VARCHAR2 := 'P');
137
138 end ZPB_FEM_UTILS_PKG;
[Home] [Help]