[Home] [Help]
PACKAGE: APPS.FEM_INTG_PL_PKG
Source
1 PACKAGE FEM_INTG_PL_PKG AUTHID CURRENT_USER as
2 /* $Header: fem_intg_pl.pls 120.0 2005/06/06 19:47:56 appldev noship $ */
3 --
4 -- Package
5 -- fem_intg_pl_pkg
6 -- Purpose
7 -- Process locking wrapper procedures for OGL-FEM integration
8 -- History
9 -- 27-SEP-04 M Ward Created
10 --
11
12 --
13 -- Function
14 -- obj_def_data_edit_lock_exists
15 -- Purpose
16 -- Check whether an edit lock exists on an object definition
17 -- Arguments
18 -- p_object_definition_id Object definition to check
19 -- Return Value
20 -- 'T' if a lock exists, and 'F' if there is no lock
21 -- Example
22 -- FEM_INTG_PL_PKG.obj_def_data_edit_lock_exists(
23 -- p_object_definition_id => 100)
24 -- Notes
25 --
26 FUNCTION Obj_Def_Data_Edit_Lock_Exists(p_object_definition_id NUMBER)
27 RETURN VARCHAR2;
28
29 --
30 -- Function
31 -- Can_Delete_Object_Def
32 -- Purpose
33 -- Check whether an object definition can be deleted
34 -- Arguments
35 -- p_object_definition_id Object definition to check
36 -- Return Value
37 -- 'T' if it can be deleted, and 'F' if it cannot be deleted
38 -- Example
39 -- FEM_INTG_PL_PKG.Can_Delete_Object_Def(
40 -- p_object_definition_id => 100)
41 -- Notes
42 --
43 FUNCTION Can_Delete_Object_Def(p_object_definition_id NUMBER)
44 RETURN VARCHAR2;
45
46 --
47 -- Function
48 -- Dimension_Rules_Have_Been_Run
49 -- Purpose
50 -- Check whether all dimension rules for the chart of accounts
51 -- have been run successfully
52 -- Arguments
53 -- p_chart_of_accounts_id The chart of accounts to check
54 -- Return Value
55 -- 'T' if a the rules have all been run successfully, and 'F' otherwise
56 -- Example
57 -- FEM_INTG_PL_PKG.Dimension_Rules_Have_Been_Run(
58 -- p_chart_of_accounts_id => 101)
59 -- Notes
60 --
61 FUNCTION Dimension_Rules_Have_Been_Run(p_chart_of_accounts_id NUMBER)
62 RETURN VARCHAR2;
63
64 --
65 -- Function
66 -- Effective_Date_Incl_Rslt_Data
67 -- Purpose
68 -- Check whether the effective dates given cover the range of all
69 -- runs by this object definition
70 -- Arguments
71 -- p_object_definition_id Object definition to check
72 -- p_new_effective_start_date New start date
73 -- p_new_effective_end_date New end date
74 -- Return Value
75 -- 'T' if all runs are included, and 'F' otherwise
76 -- Example
77 -- FEM_INTG_PL_PKG.Effective_Date_Incl_Rslt_Data(
78 -- p_object_definition_id => 100,
79 -- p_new_effective_start_date => sysdate-1,
80 -- p_new_effective_end_date => sysdate+1)
81 -- Notes
82 --
83 FUNCTION Effective_Date_Incl_Rslt_Data(
84 p_object_definition_id NUMBER,
85 p_new_effective_start_date DATE,
86 p_new_effective_end_date DATE)
87 RETURN VARCHAR2;
88
89
90 --
91 -- Procedure
92 -- Register_Process_Execution
93 -- Purpose
94 -- Registers the concurrent request and all processing parameters into
95 --- the FEM Process Logging architecture
96 -- Arguments
97 -- p_obj_id Object id
98 -- p_obj_def_id Object definition id
99 -- p_req_id Request id
100 -- p_user_id User id
101 -- p_login_id Login id
102 -- p_pgm_id Program id
103 -- p_pgm_app_id Program application id
104 -- p_module_name Module name
105 -- p_hierarchy_name Hierarchy name
106 -- x_completion_code Completion code
107 -- Example
108 -- Register_Process_Execution(
109 -- p_obj_id => 1,
110 -- p_obj_def_id => 10,
111 -- p_req_id => 100,
112 -- p_user_id => 1000,
113 -- p_login_id => 200,
114 -- p_pgm_id => 120,
115 -- p_pgm_app_id => 274
116 -- p_module_name => 'abc',
117 -- p_hierarchy_name => 'abc',
118 -- x_completion_code => v_completion_code
119 -- );
120 -- Notes
121 --
122 PROCEDURE Register_Process_Execution(
123 p_obj_id IN NUMBER,
124 p_obj_def_id IN NUMBER,
125 p_req_id IN NUMBER,
126 p_user_id IN NUMBER,
127 p_login_id IN NUMBER,
128 p_pgm_id IN NUMBER,
129 p_pgm_app_id IN NUMBER,
130 p_module_name IN VARCHAR2,
131 p_hierarchy_name IN VARCHAR2 DEFAULT NULL,
132 x_completion_code OUT NOCOPY NUMBER
133 );
134
135
136 --
137 -- Procedure
138 -- Final_Process_Logging
139 -- Purpose
140 -- Performs all required post-execution process logging operations
141 -- Arguments
142 -- p_obj_id Object id
143 -- p_obj_def_id Object definition id
144 -- p_req_id Request id
145 -- p_user_id User id
146 -- p_login_id Login id
147 -- p_exec_status Execution status
148 -- p_row_num_loaded Number of rows loaded
149 -- p_err_num_count Number of errors encountered
150 -- p_final_msg_name Final message name
151 -- p_module_name Module name
152 -- x_completion_code Completion code
153 -- Example
154 -- Final_Process_Logging(
155 -- p_obj_id => 1,
156 -- p_obj_def_id => 10,
157 -- p_req_id => 100,
158 -- p_user_id => 1000,
159 -- p_login_id => 200,
160 -- p_exec_status => 'SUCCESS'
161 -- p_row_num_loaded => 100000,
162 -- p_err_num_count => 0,
163 -- p_final_msg_name => 'Final Message',
164 -- p_module_name => 'abc',
165 -- x_completion_code => v_completion_code
166 -- );
167 -- Notes
168 --
169 PROCEDURE Final_Process_Logging(
170 p_obj_id IN NUMBER,
171 p_obj_def_id IN NUMBER,
172 p_req_id IN NUMBER,
173 p_user_id IN NUMBER,
174 p_login_id IN NUMBER,
175 p_exec_status IN VARCHAR2,
176 p_row_num_loaded IN NUMBER,
177 p_err_num_count IN NUMBER,
178 p_final_msg_name IN VARCHAR2,
179 p_module_name IN VARCHAR2,
180 x_completion_code OUT NOCOPY NUMBER
181 );
182
183 END FEM_INTG_PL_PKG;