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