1 PACKAGE ENG_DOCUMENT_UTIL AS
2 /* $Header: ENGUDOCS.pls 120.5 2006/11/14 08:43:09 asjohal noship $ */
3
4
5 -- Global constants --
6 -- DOM Document Objects
7 G_DOM_DOCUMENT_CATEGORY CONSTANT VARCHAR2(30) := 'DOM_DOCUMENT_CATEGORY';
8 G_DOM_DOCUMENT_REVISION CONSTANT VARCHAR2(30) := 'DOM_DOCUMENT_REVISION';
9 G_DOM_DOCUMENT CONSTANT VARCHAR2(30) := 'DOM_DOCUMENT';
10 G_OCS_FILE CONSTANT VARCHAR2(30) := 'OCS_FILE';
11
12 -- DOM Document Seeded Roles
13 G_DOM_DOCUMENT_VIEWER CONSTANT VARCHAR2(30) := 'DOM_DOCUMENT_VIEWER';
14 G_DOM_DOCUMENT_AUTHOR CONSTANT VARCHAR2(30) := 'DOM_DOCUMENT_AUTHOR';
15 G_DOM_DOCUMENT_ADMIN CONSTANT VARCHAR2(30) := 'DOM_DOCUMENT_ADMIN';
16
17
18 -- CM Change Mgmt Type Code for Document Lifeycle Change Object
19 G_DOM_DOCUMENT_LIFECYCLE CONSTANT VARCHAR2(30) := 'DOM_DOCUMENT_LIFECYCLE';
20
21
22
23 /********************************************************************
24 * API Type : Private APIs
25 * Purpose : Those APIs are private
26 *********************************************************************/
27 FUNCTION Is_Dom_Document_Lifecycle( p_change_id IN NUMBER
28 , p_base_change_mgmt_type_code IN VARCHAR2 := NULL
29 )
30 RETURN BOOLEAN ;
31
32
33 PROCEDURE Get_Document_Revision_Id( p_change_id IN NUMBER
34 , x_document_id OUT NOCOPY NUMBER
35 , x_document_revision_id OUT NOCOPY NUMBER
36 ) ;
37
38
39 -- Get Document Revision Info
40 PROCEDURE Get_Document_Rev_Info
41 ( p_document_revision_id IN NUMBER
42 , x_document_id OUT NOCOPY NUMBER
43 , x_document_number OUT NOCOPY VARCHAR2
44 , x_document_revision OUT NOCOPY VARCHAR2
45 , x_documnet_name OUT NOCOPY VARCHAR2
46 , x_document_detail_page_url OUT NOCOPY VARCHAR2
47 ) ;
48
49
50 --
51 -- Wrapper API to integrate DOM Document API when Updating Approval Status
52 -- of Document LC Phase Change Object
53 --
54 PROCEDURE Update_Approval_Status
55 (
56 p_api_version IN NUMBER --
57 ,p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE --
58 ,p_commit IN VARCHAR2 := FND_API.G_FALSE --
59 ,p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
60 ,p_debug IN VARCHAR2 := FND_API.G_FALSE --
61 ,p_output_dir IN VARCHAR2 := NULL
62 ,p_debug_filename IN VARCHAR2 := NULL
63 ,x_return_status OUT NOCOPY VARCHAR2 --
64 ,x_msg_count OUT NOCOPY NUMBER --
65 ,x_msg_data OUT NOCOPY VARCHAR2 --
66 ,p_change_id IN NUMBER -- header's change_id
67 ,p_approval_status IN NUMBER -- header approval status
68 ,p_wf_route_status IN VARCHAR2 -- workflow routing status (for document types)
69 ,p_api_caller IN VARCHAR2 := NULL -- Optionnal for future use
70 );
71
72
73 --
74 -- Wrapper API to integrate DOM Document API when Promoting/Demoting
75 -- Document LC Phase
76 --
77 PROCEDURE Change_Doc_LC_Phase
78 (
79 p_api_version IN NUMBER --
80 ,p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE --
81 ,p_commit IN VARCHAR2 := FND_API.G_FALSE --
82 ,p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
83 ,p_debug IN VARCHAR2 := FND_API.G_FALSE --
84 ,p_output_dir IN VARCHAR2 := NULL
85 ,p_debug_filename IN VARCHAR2 := NULL
86 ,x_return_status OUT NOCOPY VARCHAR2 --
87 ,x_msg_count OUT NOCOPY NUMBER --
88 ,x_msg_data OUT NOCOPY VARCHAR2 --
89 ,p_change_id IN NUMBER -- header's change_id
90 ,p_lc_phase_code IN NUMBER -- new phase
91 ,p_action_type IN VARCHAR2 := NULL -- promote/demote action type 'PROMOTE' or 'DEMOTE'
92 ,p_api_caller IN VARCHAR2 := NULL -- Optionnal for future use
93 ) ;
94
95
96 --
97 -- Wrapper API to integrate DOM Document API when starting
98 -- Document LC Phase Workflow
99 --
100 PROCEDURE Start_Doc_LC_Phase_WF
101 (
102 p_api_version IN NUMBER --
103 ,p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE --
104 ,p_commit IN VARCHAR2 := FND_API.G_FALSE --
105 ,p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
106 ,p_debug IN VARCHAR2 := FND_API.G_FALSE --
107 ,p_output_dir IN VARCHAR2 := NULL
108 ,p_debug_filename IN VARCHAR2 := NULL
109 ,x_return_status OUT NOCOPY VARCHAR2 --
110 ,x_msg_count OUT NOCOPY NUMBER --
111 ,x_msg_data OUT NOCOPY VARCHAR2 --
112 ,p_change_id IN NUMBER -- DOC LC Object Change Id
113 ,p_route_id IN NUMBER -- DOC LC Phase WF Route ID
114 ,p_lc_phase_code IN NUMBER := NULL -- Doc LC Phase
115 ,p_api_caller IN VARCHAR2 := NULL -- Optionnal for future use
116 ) ;
117
118 --
119 -- Wrapper API to integrate DOM Document API when aborting
120 -- Document LC Phase Workflow
121 --
122 PROCEDURE Abort_Doc_LC_Phase_WF
123 (
124 p_api_version IN NUMBER --
125 ,p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE --
126 ,p_commit IN VARCHAR2 := FND_API.G_FALSE --
127 ,p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
128 ,p_debug IN VARCHAR2 := FND_API.G_FALSE --
129 ,p_output_dir IN VARCHAR2 := NULL
130 ,p_debug_filename IN VARCHAR2 := NULL
131 ,x_return_status OUT NOCOPY VARCHAR2 --
132 ,x_msg_count OUT NOCOPY NUMBER --
133 ,x_msg_data OUT NOCOPY VARCHAR2 --
134 ,p_change_id IN NUMBER -- DOC LC Object Change Id
135 ,p_route_id IN NUMBER -- DOC LC Phase WF Route ID
136 ,p_lc_phase_code IN NUMBER := NULL -- Doc LC Phase
137 ,p_api_caller IN VARCHAR2 := NULL -- Optionnal for future use
138 ) ;
139
140
141 --
142 -- Wrapper API to grant Document Role to Document Revision
143 --
144 PROCEDURE Grant_Document_Role
145 (
146 p_api_version IN NUMBER --
147 ,p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE --
148 ,p_commit IN VARCHAR2 := FND_API.G_FALSE --
149 ,p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
150 ,p_debug IN VARCHAR2 := FND_API.G_FALSE --
151 ,p_output_dir IN VARCHAR2 := NULL
152 ,p_debug_filename IN VARCHAR2 := NULL
153 ,x_return_status OUT NOCOPY VARCHAR2 --
154 ,x_msg_count OUT NOCOPY NUMBER --
155 ,x_msg_data OUT NOCOPY VARCHAR2 --
156 ,p_document_id IN NUMBER -- Dom Document Id
157 ,p_document_revision_id IN NUMBER -- Dom Document Revision Id
158 ,p_change_id IN NUMBER -- Change Id
159 ,p_change_line_id IN NUMBER -- Change Line Id
160 ,p_party_ids IN FND_TABLE_OF_NUMBER -- Person's HZ_PARTIES.PARTY_ID Array
161 ,p_role_id IN NUMBER -- Role Id to be granted
162 ,p_api_caller IN VARCHAR2 := NULL -- Optionnal for future use
163 ) ;
164
165 --
166 -- Wrapper API to revoke Document Role to Document Revision
167 --
168 PROCEDURE Revoke_Document_Role
169 (
170 p_api_version IN NUMBER --
171 ,p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE --
172 ,p_commit IN VARCHAR2 := FND_API.G_FALSE --
173 ,p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
174 ,p_debug IN VARCHAR2 := FND_API.G_FALSE --
175 ,p_output_dir IN VARCHAR2 := NULL
176 ,p_debug_filename IN VARCHAR2 := NULL
177 ,x_return_status OUT NOCOPY VARCHAR2 --
178 ,x_msg_count OUT NOCOPY NUMBER --
179 ,x_msg_data OUT NOCOPY VARCHAR2 --
180 ,p_document_id IN NUMBER -- Dom Document Id
181 ,p_document_revision_id IN NUMBER -- Dom Document Revision Id
182 ,p_change_id IN NUMBER -- Change Id
183 ,p_change_line_id IN NUMBER -- Change Line Id
184 ,p_party_ids IN FND_TABLE_OF_NUMBER -- Person's HZ_PARTIES.PARTY_ID Array
185 ,p_role_id IN NUMBER -- Role Id to be revoked. If NULL, Revoke all grants per given object info
186 ,p_api_caller IN VARCHAR2 := NULL -- Optionnal for future use
187 ) ;
188
189
190 PROCEDURE Grant_Attachments_OCSRole
191 (
192 p_api_version IN NUMBER --
193 ,p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE --
194 ,p_commit IN VARCHAR2 := FND_API.G_FALSE --
195 ,p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
196 ,p_debug IN VARCHAR2 := FND_API.G_FALSE --
197 ,p_output_dir IN VARCHAR2 := NULL
198 ,p_debug_filename IN VARCHAR2 := NULL
199 ,x_return_status OUT NOCOPY VARCHAR2 --
200 ,x_msg_count OUT NOCOPY NUMBER --
201 ,x_msg_data OUT NOCOPY VARCHAR2 --
202 ,p_entity_name IN VARCHAR2
203 ,p_pk1value IN VARCHAR2
204 ,p_pk2value IN VARCHAR2
205 ,p_pk3value IN VARCHAR2
206 ,p_pk4value IN VARCHAR2
207 ,p_pk5value IN VARCHAR2
208 ,p_party_ids IN FND_TABLE_OF_NUMBER -- Person's HZ_PARTIES.PARTY_ID Array
209 ,p_ocs_role IN VARCHAR2 -- OCS File Role to be granted
210 ,p_source_media_id_tbl IN FND_TABLE_OF_NUMBER := null
211 ,p_attachment_id_tbl IN FND_TABLE_OF_NUMBER := null
212 ,p_repository_id_tbl IN FND_TABLE_OF_NUMBER := null
213 ,p_submitted_by IN NUMBER := null
214 ,p_api_caller IN VARCHAR2 := NULL -- Optionnal for future use
215 ) ;
216
217
218 PROCEDURE Revoke_Attachments_OCSRole
219 (
220 p_api_version IN NUMBER --
221 ,p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE --
222 ,p_commit IN VARCHAR2 := FND_API.G_FALSE --
223 ,p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL
224 ,p_debug IN VARCHAR2 := FND_API.G_FALSE --
225 ,p_output_dir IN VARCHAR2 := NULL
226 ,p_debug_filename IN VARCHAR2 := NULL
227 ,x_return_status OUT NOCOPY VARCHAR2 --
228 ,x_msg_count OUT NOCOPY NUMBER --
229 ,x_msg_data OUT NOCOPY VARCHAR2 --
230 ,p_entity_name IN VARCHAR2
231 ,p_pk1value IN VARCHAR2
232 ,p_pk2value IN VARCHAR2
233 ,p_pk3value IN VARCHAR2
234 ,p_pk4value IN VARCHAR2
235 ,p_pk5value IN VARCHAR2
236 ,p_party_ids IN FND_TABLE_OF_NUMBER -- Person's HZ_PARTIES.PARTY_ID Array
237 ,p_ocs_role IN VARCHAR2 -- OCS File Role to be revoked. If NULL, Revoke all grants per given entity info
238 ,p_api_caller IN VARCHAR2 := NULL -- Optionnal for future use
239 ) ;
240
241
242 END ENG_DOCUMENT_UTIL;
[Home] [Help]