1 PACKAGE FND_OAM_DSCFG_PROCS_PKG as
2 /* $Header: AFOAMDSCPROCS.pls 120.1 2005/11/23 17:02 yawu noship $ */
3
4 ---------------
5 -- Constants --
6 ---------------
7 -- Procedure Types are stored in DS_API_PKG
8
9 ---------------------------------
10 -- Public Procedures/Functions --
11 ---------------------------------
12
13 -- Accessor function, checks if internal state is initialized.
14 -- Invariants:
15 -- None
16 -- Parameters:
17 -- None
18 -- Returns:
19 -- Boolean where TRUE=Initialized
20 -- Exceptions:
21 -- None
22 FUNCTION IS_INITIALIZED
23 RETURN BOOLEAN;
24
25 -- Accessor function, obtains the in-progress proc_id.
26 -- Invariants:
27 -- Only has a value during proc execution after GET_NEXT_PROC or SET_CURRENT_PROC has been called.
28 -- Parameters:
29 -- None
30 -- Returns:
31 -- The proc_id stored in the package state.
32 -- Exceptions:
33 -- If the proc state isn't initialized, a NO_DATA_FOUND exception is thrown.
34 FUNCTION GET_CURRENT_ID
35 RETURN NUMBER;
36
37 -- Accessor function, obtains the in-progress proc_type.
38 -- Invariants:
39 -- Only has a value during proc execution after GET_NEXT_PROC or SET_CURRENT_PROC has been called.
40 -- Parameters:
41 -- None
42 -- Returns:
43 -- The proc_type stored in the package state.
44 -- Exceptions:
45 -- If the proc state isn't initialized, a NO_DATA_FOUND exception is thrown.
46 FUNCTION GET_CURRENT_TYPE
47 RETURN VARCHAR2;
48
49 -- Accessor function, obtains the in-progress error_is_fatal_flag
50 -- Invariants:
51 -- Only has a value during proc execution after GET_NEXT_PROC or SET_CURRENT_PROC has been called.
52 -- Parameters:
53 -- None
54 -- Returns:
55 -- The error_is_fatal_flag stored in the package state.
56 -- Exceptions:
57 -- If the proc state isn't initialized, a NO_DATA_FOUND exception is thrown.
58 FUNCTION GET_CURRENT_ERROR_IS_FATAL
59 RETURN VARCHAR2;
60
61 -- Accessor function, obtains the currently executing proc's location
62 -- Invariants:
63 -- Only has a value during proc execution after GET_NEXT_PROC or SET_CURRENT_PROC has been called.
64 -- Parameters:
65 -- None
66 -- Returns:
67 -- The proc location stored in the package state.
68 -- Exceptions:
69 -- If the proc state isn't initialized, a NO_DATA_FOUND exception is thrown.
70 FUNCTION GET_CURRENT_LOCATION
71 RETURN VARCHAR2;
72
73 -- Accessor function, obtains the currently executing proc executable
74 -- Invariants:
75 -- Only has a value during proc execution after GET_NEXT_PROC or SET_CURRENT_PROC has been called.
76 -- Parameters:
77 -- None
78 -- Returns:
79 -- The proc executable stored in the package state.
80 -- Exceptions:
81 -- If the proc state isn't initialized, a NO_DATA_FOUND exception is thrown.
82 FUNCTION GET_CURRENT_EXECUTABLE
83 RETURN VARCHAR2;
84
85 -- This procedure obtains the next proc id for a given stage by iterating across the DS_PROCS table using
86 -- a package state cursor. It obeys START_DATE/END_DATE restriction and orders the results based on
87 -- the priority. If the provided stage doesn't match the last provided stage, the cursor is re-executed.
88 -- Invariants:
89 -- None
90 -- Parameters:
91 -- x_proc_id proc_id of the next proc.
92 -- x_proc_type proc_type of the next proc.
93 -- x_location Location of the next proc.
94 -- x_executable Executable of the next proc.
95 -- Return Statuses:
96 -- Throws NO_DATA_FOUND when there are no more procs to fetch.
97 PROCEDURE GET_NEXT_PROC(p_stage IN VARCHAR2,
98 x_proc_id OUT NOCOPY NUMBER,
99 x_proc_type OUT NOCOPY VARCHAR2,
100 x_error_is_fatal OUT NOCOPY VARCHAR2,
101 x_location OUT NOCOPY VARCHAR2,
102 x_executable OUT NOCOPY VARCHAR2);
103
104 -- Procedure allowing the user to set the current proc by its id. Initializes state so that calls
105 -- to ADD_DIRECTIVE/ADD_MAPPED_KEY will include proc state. Unnecessary if proc_id was the last one
106 -- obtained from a call to GET_NEXT_PROC.
107 -- Invariants:
108 -- None
109 -- Parameters:
110 -- p_proc_id proc_id you want to set as the currently executing proc
111 -- Return Statuses:
112 -- Throws NO_DATA_FOUND if the proc_id is invalid.
113 PROCEDURE SET_CURRENT_PROC(p_proc_id IN NUMBER);
114
115
116
117 --procedures required by FNDLOADER
118
119 procedure LOAD_ROW (
120 X_PROC_ID in NUMBER,
121 X_PROC_TYPE IN VARCHAR2,
122 X_STAGE IN VARCHAR2,
123 X_START_DATE IN DATE,
124 X_END_DATE IN DATE,
125 X_PRIORITY IN NUMBER,
126 X_ERROR_IS_FATAL_FLAG IN VARCHAR2,
127 X_LOCATION IN VARCHAR2,
128 X_EXECUTABLE IN VARCHAR2,
129 X_OWNER in VARCHAR2,
130 x_custom_mode in varchar2,
131 x_last_update_date in varchar2);
132
133 procedure INSERT_ROW (
134 X_ROWID in out nocopy VARCHAR2,
135 X_PROC_ID in NUMBER,
136 X_PROC_TYPE IN VARCHAR2,
137 X_STAGE IN VARCHAR2,
138 X_START_DATE IN DATE,
139 X_END_DATE IN DATE,
140 X_PRIORITY IN NUMBER,
141 X_ERROR_IS_FATAL_FLAG IN VARCHAR2,
142 X_LOCATION IN VARCHAR2,
143 X_EXECUTABLE IN VARCHAR2,
144 X_CREATED_BY in NUMBER,
145 X_CREATION_DATE in DATE,
146 X_LAST_UPDATED_BY in NUMBER,
147 X_LAST_UPDATE_DATE in DATE,
148 X_LAST_UPDATE_LOGIN in NUMBER);
149
150 procedure LOCK_ROW (
151 X_ROWID in out nocopy VARCHAR2,
152 X_PROC_ID in NUMBER,
153 X_PROC_TYPE IN VARCHAR2,
154 X_STAGE IN VARCHAR2,
155 X_START_DATE IN DATE,
156 X_END_DATE IN DATE,
157 X_PRIORITY IN NUMBER,
158 X_ERROR_IS_FATAL_FLAG IN VARCHAR2,
159 X_LOCATION IN VARCHAR2,
160 X_EXECUTABLE IN VARCHAR2,
161 X_CREATED_BY in NUMBER,
162 X_CREATION_DATE in DATE,
163 X_LAST_UPDATED_BY in NUMBER,
164 X_LAST_UPDATE_DATE in DATE,
165 X_LAST_UPDATE_LOGIN in NUMBER);
166
167
168 procedure UPDATE_ROW (
169 X_PROC_ID in NUMBER,
170 X_PROC_TYPE IN VARCHAR2,
171 X_STAGE IN VARCHAR2,
172 X_START_DATE IN DATE,
173 X_END_DATE IN DATE,
174 X_PRIORITY IN NUMBER,
175 X_ERROR_IS_FATAL_FLAG IN VARCHAR2,
176 X_LOCATION IN VARCHAR2,
177 X_EXECUTABLE IN VARCHAR2,
178 X_LAST_UPDATED_BY in NUMBER,
179 X_LAST_UPDATE_DATE in DATE,
180 X_LAST_UPDATE_LOGIN in NUMBER);
181
182 procedure DELETE_ROW (
183 X_PROC_ID in NUMBER);
184
185
186 END FND_OAM_DSCFG_PROCS_PKG;
[Home] [Help]