1 package AK_FLOW3_PVT as
2 /* $Header: akdvfl3s.pls 120.2 2005/09/15 22:26:52 tshort ship $ */
3
4 -- Global constants holding the package and file names to be used by
5 -- messaging routines in the case of an unexpected error.
6
7 G_PKG_NAME CONSTANT VARCHAR2(30) := 'AK_FLOW3_PVT';
8
9 -- Procedure specs
10
11 --=======================================================
12 -- Function VALIDATE_FLOW
13 --
14 -- Usage Private API for validating a flow. This
15 -- API should only be called by other APIs that are
16 -- owned by the Core Modules Team (AK).
17 --
18 -- Desc Perform validation on a flow record.
19 --
20 -- Results The API returns the standard p_return_status parameter
21 -- indicating one of the standard return statuses :
22 -- * Unexpected error
23 -- * Error
24 -- * Success
25 -- In addition, this function returns TRUE if all
26 -- validation tests are passed, or FALSE otherwise.
27 -- Parameters Flow columns
28 -- p_caller : IN required
29 -- Must be one of the following values defined
30 -- in package AK_ON_OBJECTS_PVT:
31 -- - G_CREATE (if calling from the Create API)
32 -- - G_DOWNLOAD (if calling from the Download API)
33 -- - G_UPDATE (if calling from the Update API)
34 --
35 -- Note This API is intended for performing record-level
36 -- validation. It is not designed for item-level
37 -- validation.
38 --
39 -- Version Initial version number = 1.0
40 -- History Current version number = 1.0
41 --=======================================================
42 function VALIDATE_FLOW (
43 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
44 p_api_version_number IN NUMBER,
45 p_return_status OUT NOCOPY VARCHAR2,
46 p_flow_application_id IN NUMBER := FND_API.G_MISS_NUM,
47 p_flow_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
48 p_primary_page_appl_id IN NUMBER := FND_API.G_MISS_NUM,
49 p_primary_page_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
50 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
51 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
52 p_caller IN VARCHAR2,
53 p_pass IN NUMBER := 2
54 ) return BOOLEAN;
55
56 --=======================================================
57 -- Function VALIDATE_PAGE
58 --
59 -- Usage Private API for validating a flow page. This
60 -- API should only be called by other APIs that are
61 -- owned by the Core Modules Team (AK).
62 --
63 -- Desc Perform validation on a flow page record.
64 --
65 -- Results The API returns the standard p_return_status parameter
66 -- indicating one of the standard return statuses :
67 -- * Unexpected error
68 -- * Error
69 -- * Success
70 -- In addition, this function returns TRUE if all
71 -- validation tests are passed, or FALSE otherwise.
72 -- Parameters Flow Page columns
73 -- p_caller : IN required
74 -- Must be one of the following values defined
75 -- in package AK_ON_OBJECTS_PVT:
76 -- - G_CREATE (if calling from the Create API)
77 -- - G_DOWNLOAD (if calling from the Download API)
78 -- - G_UPDATE (if calling from the Update API)
79 --
80 -- Note This API is intended for performing record-level
81 -- validation. It is not designed for item-level
82 -- validation.
83 --
84 -- Version Initial version number = 1.0
85 -- History Current version number = 1.0
86 --=======================================================
87 function VALIDATE_PAGE (
88 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
89 p_api_version_number IN NUMBER,
90 p_return_status OUT NOCOPY VARCHAR2,
91 p_flow_application_id IN NUMBER := FND_API.G_MISS_NUM,
92 p_flow_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
93 p_page_application_id IN NUMBER := FND_API.G_MISS_NUM,
94 p_page_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
95 p_primary_region_appl_id IN NUMBER := FND_API.G_MISS_NUM,
96 p_primary_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
97 p_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
98 p_description IN VARCHAR2 := FND_API.G_MISS_CHAR,
99 p_caller IN VARCHAR2,
100 p_pass IN NUMBER := 2
101 ) return BOOLEAN;
102
103 --=======================================================
104 -- Function VALIDATE_PAGE_REGION
105 --
106 -- Usage Private API for validating a flow page region. This
107 -- API should only be called by other APIs that are
108 -- owned by the Core Modules Team (AK).
109 --
110 -- Desc Perform validation on a flow page region record.
111 --
112 -- Results The API returns the standard p_return_status parameter
113 -- indicating one of the standard return statuses :
114 -- * Unexpected error
115 -- * Error
116 -- * Success
117 -- In addition, this function returns TRUE if all
118 -- validation tests are passed, or FALSE otherwise.
119 -- Parameters Flow Page Region columns
120 -- p_foreign_key_name : IN optional
121 -- The foreign key name used in the flow region
122 -- relation record connecting this flow page region
123 -- and its parent region, if there is one.
124 -- p_caller : IN required
125 -- Must be one of the following values defined
126 -- in package AK_ON_OBJECTS_PVT:
127 -- - G_CREATE (if calling from the Create API)
128 -- - G_DOWNLOAD (if calling from the Download API)
129 -- - G_UPDATE (if calling from the Update API)
130 --
131 -- Note This API is intended for performing record-level
132 -- validation. It is not designed for item-level
133 -- validation.
134 --
135 -- Version Initial version number = 1.0
136 -- History Current version number = 1.0
137 --=======================================================
138 function VALIDATE_PAGE_REGION (
139 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
140 p_api_version_number IN NUMBER,
141 p_return_status OUT NOCOPY VARCHAR2,
142 p_flow_application_id IN NUMBER := FND_API.G_MISS_NUM,
143 p_flow_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
144 p_page_application_id IN NUMBER := FND_API.G_MISS_NUM,
145 p_page_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
146 p_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
147 p_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
148 p_display_sequence IN NUMBER := FND_API.G_MISS_NUM,
149 p_region_style IN VARCHAR2 := FND_API.G_MISS_CHAR,
150 p_num_columns IN NUMBER := FND_API.G_MISS_NUM,
151 p_icx_custom_call IN VARCHAR2 := FND_API.G_MISS_CHAR,
152 p_parent_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
153 p_parent_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
154 p_foreign_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
155 p_set_primary_region IN VARCHAR2 := FND_API.G_MISS_CHAR,
156 p_caller IN VARCHAR2,
157 p_pass IN NUMBER := 2
158 ) return BOOLEAN;
159
160 --=======================================================
161 -- Function VALIDATE_PAGE_REGION_ITEM
162 --
163 -- Usage Private API for validating a flow page region item.
164 -- This API should only be called by other APIs that are
165 -- owned by the Core Modules Team (AK).
166 --
167 -- Desc Perform validation on a flow page region item record.
168 --
169 -- Results The API returns the standard p_return_status parameter
170 -- indicating one of the standard return statuses :
171 -- * Unexpected error
172 -- * Error
173 -- * Success
174 -- In addition, this function returns TRUE if all
175 -- validation tests are passed, or FALSE otherwise.
176 -- Parameters Flow Page Region Item columns
177 -- p_caller : IN required
178 -- Must be one of the following values defined
179 -- in package AK_ON_OBJECTS_PVT:
180 -- - G_CREATE (if calling from the Create API)
181 -- - G_DOWNLOAD (if calling from the Download API)
182 -- - G_UPDATE (if calling from the Update API)
183 --
184 -- Note This API is intended for performing record-level
185 -- validation. It is not designed for item-level
186 -- validation.
187 --
188 -- Version Initial version number = 1.0
189 -- History Current version number = 1.0
190 --=======================================================
191 function VALIDATE_PAGE_REGION_ITEM (
192 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
193 p_api_version_number IN NUMBER,
194 p_return_status OUT NOCOPY VARCHAR2,
195 p_flow_application_id IN NUMBER := FND_API.G_MISS_NUM,
196 p_flow_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
197 p_page_application_id IN NUMBER := FND_API.G_MISS_NUM,
198 p_page_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
199 p_region_application_id IN NUMBER := FND_API.G_MISS_NUM,
200 p_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
201 p_attribute_application_id IN NUMBER := FND_API.G_MISS_NUM,
202 p_attribute_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
203 p_to_page_appl_id IN NUMBER := FND_API.G_MISS_NUM,
204 p_to_page_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
205 p_to_url_attribute_appl_id IN NUMBER := FND_API.G_MISS_NUM,
206 p_to_url_attribute_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
207 p_caller IN VARCHAR2,
208 p_pass IN NUMBER := 2
209 ) return BOOLEAN;
210
211 --=======================================================
212 -- Function VALIDATE_REGION_RELATION
213 --
214 -- Usage Private API for validating a flow region relation.
215 -- This API should only be called by other APIs that are
216 -- owned by the Core Modules Team (AK).
217 --
218 -- Desc Perform validation on a flow region relation record.
219 --
220 -- Results The API returns the standard p_return_status parameter
221 -- indicating one of the standard return statuses :
222 -- * Unexpected error
223 -- * Error
224 -- * Success
225 -- In addition, this function returns TRUE if all
226 -- validation tests are passed, or FALSE otherwise.
227 -- Parameters Flow Region Relation columns
228 -- p_caller : IN required
229 -- Must be one of the following values defined
230 -- in package AK_ON_OBJECTS_PVT:
231 -- - G_CREATE (if calling from the Create API)
232 -- - G_DOWNLOAD (if calling from the Download API)
233 -- - G_UPDATE (if calling from the Update API)
234 --
235 -- Note This API is intended for performing record-level
236 -- validation. It is not designed for item-level
237 -- validation.
238 --
239 -- Version Initial version number = 1.0
240 -- History Current version number = 1.0
241 --=======================================================
242 function VALIDATE_REGION_RELATION (
243 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
244 p_api_version_number IN NUMBER,
245 p_return_status OUT NOCOPY VARCHAR2,
246 p_flow_application_id IN NUMBER := FND_API.G_MISS_NUM,
247 p_flow_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
248 p_foreign_key_name IN VARCHAR2 := FND_API.G_MISS_CHAR,
249 p_from_page_appl_id IN NUMBER := FND_API.G_MISS_NUM,
250 p_from_page_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
251 p_from_region_appl_id IN NUMBER := FND_API.G_MISS_NUM,
252 p_from_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
253 p_to_page_appl_id IN NUMBER := FND_API.G_MISS_NUM,
254 p_to_page_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
255 p_to_region_appl_id IN NUMBER := FND_API.G_MISS_NUM,
256 p_to_region_code IN VARCHAR2 := FND_API.G_MISS_CHAR,
257 p_application_id IN NUMBER := FND_API.G_MISS_NUM,
258 p_caller IN VARCHAR2,
259 p_pass IN NUMBER := 2
260 ) return BOOLEAN;
261
262 end AK_FLOW3_PVT;
[Home] [Help]