1 PACKAGE AHL_DI_DOC_INDEX_PUB AS
2 /* $Header: AHLPDIXS.pls 120.0 2005/05/26 10:59:21 appldev noship $ */
3 /*#
4 * This is the public interface to create and modify documents and its associated suppliers and recipients.
5 * @rep:scope public
6 * @rep:product AHL
7 * @rep:displayname Document
8 * @rep:lifecycle active
9 * @rep:category BUSINESS_ENTITY AHL_DOCUMENT
10 */
11
12 --Define the Record Type for Document Index
13 TYPE doc_rec IS RECORD
14 (
15 DOCUMENT_ID NUMBER ,
16 SOURCE_PARTY_ID NUMBER ,
17 SOURCE_PARTY_NUMBER VARCHAR2(80) ,
18 DOC_TYPE_CODE VARCHAR2(30) ,
19 DOC_TYPE_DESC VARCHAR2(80) ,
20 DOC_SUB_TYPE_CODE VARCHAR2(30) ,
21 DOC_SUB_TYPE_DESC VARCHAR2(80) ,
22 DOCUMENT_NO VARCHAR2(30) ,
23 OPERATOR_CODE VARCHAR2(30) ,
24 OPERATOR_NAME VARCHAR2(80) ,
25 PRODUCT_TYPE_CODE VARCHAR2(30) ,
26 PRODUCT_TYPE_DESC VARCHAR2(80) ,
27 SUBSCRIBE_AVAIL_FLAG VARCHAR2(1) ,
28 SUBSCRIBE_TO_FLAG VARCHAR2(1) ,
29 DOCUMENT_TITLE VARCHAR2(80) ,
30 LANGUAGE VARCHAR2(4) ,
31 SOURCE_LANG VARCHAR2(4) ,
32 OBJECT_VERSION_NUMBER NUMBER ,
33 ATTRIBUTE_CATEGORY VARCHAR2(30) ,
34 ATTRIBUTE1 VARCHAR2(150) ,
35 ATTRIBUTE2 VARCHAR2(150) ,
36 ATTRIBUTE3 VARCHAR2(150) ,
37 ATTRIBUTE4 VARCHAR2(150) ,
38 ATTRIBUTE5 VARCHAR2(150) ,
39 ATTRIBUTE6 VARCHAR2(150) ,
40 ATTRIBUTE7 VARCHAR2(150) ,
41 ATTRIBUTE8 VARCHAR2(150) ,
42 ATTRIBUTE9 VARCHAR2(150) ,
43 ATTRIBUTE10 VARCHAR2(150) ,
44 ATTRIBUTE11 VARCHAR2(150) ,
45 ATTRIBUTE12 VARCHAR2(150) ,
46 ATTRIBUTE13 VARCHAR2(150) ,
47 ATTRIBUTE14 VARCHAR2(150) ,
48 ATTRIBUTE15 VARCHAR2(150) ,
49 DELETE_FLAG VARCHAR2(1) := 'N',
50 PROCESS_FLAG VARCHAR2(1) := 'Y'
51 );
52 -- Define the Record Type for Supplier Documents
53 TYPE supplier_rec IS RECORD
54 (
55 SUPPLIER_DOCUMENT_ID NUMBER ,
56 SUPPLIER_ID NUMBER ,
57 SUPPLIER_NUMBER VARCHAR2(80) ,
58 DOCUMENT_ID NUMBER ,
59 PREFERENCE_CODE VARCHAR2(30) ,
60 PREFERENCE_DESC VARCHAR2(80) ,
61 OBJECT_VERSION_NUMBER NUMBER ,
62 ATTRIBUTE_CATEGORY VARCHAR2(30) ,
63 ATTRIBUTE1 VARCHAR2(150) ,
64 ATTRIBUTE2 VARCHAR2(150) ,
65 ATTRIBUTE3 VARCHAR2(150) ,
66 ATTRIBUTE4 VARCHAR2(150) ,
67 ATTRIBUTE5 VARCHAR2(150) ,
68 ATTRIBUTE6 VARCHAR2(150) ,
69 ATTRIBUTE7 VARCHAR2(150) ,
70 ATTRIBUTE8 VARCHAR2(150) ,
71 ATTRIBUTE9 VARCHAR2(150) ,
72 ATTRIBUTE10 VARCHAR2(150) ,
73 ATTRIBUTE11 VARCHAR2(150) ,
74 ATTRIBUTE12 VARCHAR2(150) ,
75 ATTRIBUTE13 VARCHAR2(150) ,
76 ATTRIBUTE14 VARCHAR2(150) ,
77 ATTRIBUTE15 VARCHAR2(150) ,
78 DELETE_FLAG VARCHAR2(1) := 'N' );
79
80 --Define the Record Type for Recipient Documents
81 TYPE recipient_rec IS RECORD
82 (
83 RECIPIENT_DOCUMENT_ID NUMBER ,
84 RECIPIENT_PARTY_ID NUMBER ,
85 RECIPIENT_PARTY_NUMBER VARCHAR2(80) ,
86 DOCUMENT_ID NUMBER ,
87 OBJECT_VERSION_NUMBER NUMBER ,
88 ATTRIBUTE_CATEGORY VARCHAR2(30) ,
89 ATTRIBUTE1 VARCHAR2(150) ,
90 ATTRIBUTE2 VARCHAR2(150) ,
91 ATTRIBUTE3 VARCHAR2(150) ,
92 ATTRIBUTE4 VARCHAR2(150) ,
93 ATTRIBUTE5 VARCHAR2(150) ,
94 ATTRIBUTE6 VARCHAR2(150) ,
95 ATTRIBUTE7 VARCHAR2(150) ,
96 ATTRIBUTE8 VARCHAR2(150) ,
97 ATTRIBUTE9 VARCHAR2(150) ,
98 ATTRIBUTE10 VARCHAR2(150) ,
99 ATTRIBUTE11 VARCHAR2(150) ,
100 ATTRIBUTE12 VARCHAR2(150) ,
101 ATTRIBUTE13 VARCHAR2(150) ,
102 ATTRIBUTE14 VARCHAR2(150) ,
103 ATTRIBUTE15 VARCHAR2(150) ,
104 DELETE_FLAG VARCHAR2(1) := 'N' );
105
106 -- Defiene the Table Type for Document Indexes and its associated
107 -- Suppliers and Recipients
108 TYPE document_tbl IS TABLE OF doc_rec INDEX BY BINARY_INTEGER;
109 TYPE supplier_tbl IS TABLE OF supplier_rec INDEX BY BINARY_INTEGER;
110 TYPE recipient_tbl IS TABLE OF recipient_rec INDEX BY BINARY_INTEGER;
111 --This API is used to create new document index record and its associated
112 -- suppliers, recipients
113
114 /*#
115 * It allows creation of documents. It also allows association of suppliers and recepients.
116 * @param p_api_version Api Version Number
117 * @param p_init_msg_list Initialize the message stack, default value FND_API.G_TRUE
118 * @param p_commit To decide whether to commit the transaction, default value FND_API.G_FALSE
119 * @param p_validation_level Validation level, default value FND_API.G_VALID_LEVEL_FULL
120 * @param p_validate_only To decide whether to validate, default value FND_API.G_TRUE
121 * @param p_module_type To indicate whether called 'API' or 'JSP', default value NULL
122 * @param x_return_status Return status
123 * @param x_msg_count Return message count
124 * @param x_msg_data Return message data
125 * @param p_x_document_tbl Documents table of type Document_Tbl
126 * @param p_x_supplier_tbl Suppliers table of type Supplier_Tbl
127 * @param p_x_recipient_tbl Recipients table of type Recipient_Tbl
128 * @rep:scope public
129 * @rep:lifecycle active
130 * @rep:displayname Create Document
131 */
132 PROCEDURE CREATE_DOCUMENT
133 (
134 p_api_version IN NUMBER := '1.0' ,
135 p_init_msg_list IN VARCHAR2 := FND_API.G_TRUE ,
136 p_commit IN VARCHAR2 := FND_API.G_FALSE ,
137 p_validate_only IN VARCHAR2 := FND_API.G_TRUE ,
138 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
139 p_x_document_tbl IN OUT NOCOPY Document_Tbl ,
140 -- p_x_doc_rev_tbl IN OUT NOCOPY AHL_DI_DOC_REVISION_PUB.Revision_Tbl ,
141 -- p_x_doc_rev_copy_tbl IN OUT NOCOPY AHL_DI_DOC_REVISION_PUB.Revision_Copy_Tbl,
142 -- p_x_subscription_tbl IN OUT NOCOPY AHL_DI_SUBSCRIPTION_PUB.Subscription_Tbl,
143 p_x_supplier_tbl IN OUT NOCOPY Supplier_Tbl ,
144 p_x_recipient_tbl IN OUT NOCOPY Recipient_Tbl ,
145 p_module_type IN VARCHAR2 ,
146 x_return_status OUT NOCOPY VARCHAR2 ,
147 x_msg_count OUT NOCOPY NUMBER ,
148 x_msg_data OUT NOCOPY VARCHAR2
149 );
150 -- This is used to Update any document index record as well suppliers, recipients
151 -- subscriptions and revisions. In this phase we are supporting remove any supplier
152 -- or recipient record relates to document index
153
154 /*#
155 * It allows modifications of document details. It also allows modification and deletion of associated suppliers and recepients.
156 * @param p_api_version Api Version Number
157 * @param p_init_msg_list Initialize the message stack, default value FND_API.G_TRUE
158 * @param p_commit To decide whether to commit the transaction, default value FND_API.G_FALSE
159 * @param p_validation_level Validation level, default value FND_API.G_VALID_LEVEL_FULL
160 * @param p_validate_only To decide whether to validate, default value FND_API.G_TRUE
161 * @param p_module_type To indicate whether called 'API' or 'JSP', default value NULL
162 * @param x_return_status Return status
163 * @param x_msg_count Return message count
164 * @param x_msg_data Return message data
165 * @param p_x_document_tbl Documents table of type Document_Tbl
166 * @param p_x_supplier_tbl Suppliers table of type Supplier_Tbl
167 * @param p_x_recipient_tbl Recipients table of type Recipient_Tbl
168 * @rep:scope public
169 * @rep:lifecycle active
170 * @rep:displayname Modify Document
171 */
172 PROCEDURE MODIFY_DOCUMENT
173 (
174 p_api_version IN NUMBER := '1.0' ,
175 p_init_msg_list IN VARCHAR2 := FND_API.G_TRUE ,
176 p_commit IN VARCHAR2 := FND_API.G_FALSE ,
177 p_validate_only IN VARCHAR2 := FND_API.G_TRUE ,
178 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
179 p_x_document_tbl IN OUT NOCOPY document_tbl ,
180 -- p_x_doc_rev_tbl IN OUT NOCOPY AHL_DI_DOC_REVISION_PUB.Revision_Tbl ,
181 -- p_x_doc_rev_copy_tbl IN OUT NOCOPY AHL_DI_DOC_REVISION_PUB.Revision_Copy_Tbl,
182 -- p_x_subscription_tbl IN OUT NOCOPY AHL_DI_SUBSCRIPTION_PUB.Subscription_Tbl,
183 p_x_supplier_tbl IN OUT NOCOPY Supplier_Tbl ,
184 p_x_recipient_tbl IN OUT NOCOPY Recipient_Tbl ,
185 p_module_type IN VARCHAR2 ,
186 x_return_status OUT NOCOPY VARCHAR2 ,
187 x_msg_count OUT NOCOPY NUMBER ,
188 x_msg_data OUT NOCOPY VARCHAR2 );
189
190 END AHL_DI_DOC_INDEX_PUB;
[Home] [Help]