DBA Data[Home] [Help]

PACKAGE: APPS.AHL_DI_SUBSCRIPTION_PUB

Source


1 PACKAGE AHL_DI_SUBSCRIPTION_PUB AUTHID CURRENT_USER AS
2 /* $Header: AHLPSUBS.pls 120.0 2005/05/26 01:24:38 appldev noship $ */
3 /*#
4  * This is the public interface to create, modify and delete document subscriptions.
5  * @rep:scope public
6  * @rep:product AHL
7  * @rep:displayname Document Subscription
8  * @rep:lifecycle active
9  * @rep:category BUSINESS_ENTITY AHL_DOCUMENT
10  */
11 
12 -- Name        : subscription_rec
13 -- Type        : type definition, group
14 -- Description : Record to hold the attributes of the subscriptions
15 
16 TYPE subscription_rec IS RECORD
17  (
18   SUBSCRIPTION_ID        NUMBER        ,
19   DOCUMENT_ID            NUMBER        ,
20   STATUS_CODE            VARCHAR2(30)  ,
21   STATUS_DESC            VARCHAR2(80)  ,
22   REQUESTED_BY_PARTY_ID  NUMBER        ,
23   REQUESTED_BY_PTY_NUMBER  VARCHAR2(80)  ,
24   REQUESTED_BY_PTY_NAME  VARCHAR2(301) ,
25   QUANTITY               NUMBER        ,
26   FREQUENCY_CODE         VARCHAR2(30)  ,
27   FREQUENCY_DESC         VARCHAR2(80)  ,
28   SUBSCRIBED_FRM_PARTY_ID NUMBER       ,
29   SUBSCRIBED_FRM_PTY_NUMBER VARCHAR2(240) ,
30   SUBSCRIBED_FRM_PTY_NAME VARCHAR2(360),
31   START_DATE             DATE          ,
32   END_DATE               DATE          ,
33   PURCHASE_ORDER_NO      VARCHAR2(20)  ,
34   SUBSCRIPTION_TYPE_CODE VARCHAR2(30)  ,
35   SUBSCRIPTION_TYPE_DESC VARCHAR2(80)  ,
36   MEDIA_TYPE_CODE        VARCHAR2(30)  ,
37   MEDIA_TYPE_DESC        VARCHAR2(80)  ,
38   ATTRIBUTE_CATEGORY     VARCHAR2(30)  ,
39   ATTRIBUTE1             VARCHAR2(150) ,
40   ATTRIBUTE2             VARCHAR2(150) ,
41   ATTRIBUTE3             VARCHAR2(150) ,
42   ATTRIBUTE4             VARCHAR2(150) ,
43   ATTRIBUTE5             VARCHAR2(150) ,
44   ATTRIBUTE6             VARCHAR2(150) ,
45   ATTRIBUTE7             VARCHAR2(150) ,
46   ATTRIBUTE8             VARCHAR2(150) ,
47   ATTRIBUTE9             VARCHAR2(150) ,
48   ATTRIBUTE10            VARCHAR2(150) ,
49   ATTRIBUTE11            VARCHAR2(150) ,
50   ATTRIBUTE12            VARCHAR2(150) ,
51   ATTRIBUTE13            VARCHAR2(150) ,
52   ATTRIBUTE14            VARCHAR2(150) ,
53   ATTRIBUTE15            VARCHAR2(150) ,
54   LANGUAGE               VARCHAR2(4)   ,
55   SOURCE_LANG            VARCHAR2(4)   ,
56   COMMENTS               VARCHAR2(2000),
57   OBJECT_VERSION_NUMBER  NUMBER        ,
58   DELETE_FLAG            VARCHAR2(1)   := 'N'
59   );
60 
61  TYPE subscription_tbl IS TABLE OF subscription_rec
62  INDEX BY BINARY_INTEGER;
63 
64 /*#
65  * It allows creation of document subscriptions.
66  * @param p_api_version Api Version Number
67  * @param p_init_msg_list Initialize the message stack, default value FND_API.G_TRUE
68  * @param p_commit To decide whether to commit the transaction, default value FND_API.G_FALSE
69  * @param p_validation_level Validation level, default value FND_API.G_VALID_LEVEL_FULL
70  * @param p_validate_only To decide whether to validate, default value FND_API.G_TRUE
71  * @param p_module_type To indicate whether called 'API' or 'JSP', default value NULL
72  * @param x_return_status Return status
73  * @param x_msg_count Return message count
74  * @param x_msg_data Return message data
75  * @param p_x_subscription_tbl Document subscriptions table of type subscription_tbl
76  * @rep:scope public
77  * @rep:lifecycle active
78  * @rep:displayname Create Document Subscription
79  */
80  PROCEDURE CREATE_SUBSCRIPTION
81  (
82  p_api_version                  IN  NUMBER    := 1.0               ,
83  p_init_msg_list                IN  VARCHAR2  := FND_API.G_TRUE      ,
84  p_commit                       IN  VARCHAR2  := FND_API.G_FALSE     ,
85  p_validate_only                IN  VARCHAR2  := FND_API.G_TRUE      ,
86  p_validation_level             IN  NUMBER    := FND_API.G_VALID_LEVEL_FULL,
87  p_x_subscription_tbl           IN  OUT NOCOPY subscription_tbl      ,
88  p_module_type                  IN  VARCHAR2                         ,
89  x_return_status                OUT NOCOPY VARCHAR2                         ,
90  x_msg_count                    OUT NOCOPY NUMBER                           ,
91  x_msg_data                     OUT NOCOPY VARCHAR2);
92 
93 /*#
94  * It allows modification and deletion of document subscriptions.
95  * @param p_api_version Api Version Number
96  * @param p_init_msg_list Initialize the message stack, default value FND_API.G_TRUE
97  * @param p_commit To decide whether to commit the transaction, default value FND_API.G_FALSE
98  * @param p_validation_level Validation level, default value FND_API.G_VALID_LEVEL_FULL
99  * @param p_validate_only To decide whether to validate, default value FND_API.G_TRUE
100  * @param p_module_type To indicate whether called 'API' or 'JSP', default value NULL
101  * @param x_return_status Return status
102  * @param x_msg_count Return message count
103  * @param x_msg_data Return message data
104  * @param p_x_subscription_tbl Document subscriptions table of type subscription_tbl
105  * @rep:scope public
106  * @rep:lifecycle active
107  * @rep:displayname Modify Document Subscription
108  */
109 PROCEDURE MODIFY_SUBSCRIPTION
110 (
111  p_api_version                  IN  NUMBER    := 1.0               ,
112  p_init_msg_list                IN  VARCHAR2  := FND_API.G_TRUE      ,
113  p_commit                       IN  VARCHAR2  := FND_API.G_FALSE     ,
114  p_validate_only                IN  VARCHAR2  := FND_API.G_TRUE      ,
115  p_validation_level             IN  NUMBER    := FND_API.G_VALID_LEVEL_FULL,
116  p_x_subscription_tbl           IN  OUT NOCOPY subscription_tbl      ,
117  p_module_type                  IN  VARCHAR2                         ,
118  x_return_status                OUT NOCOPY VARCHAR2                         ,
119  x_msg_count                    OUT NOCOPY NUMBER                           ,
120  x_msg_data                     OUT NOCOPY VARCHAR2);
121 
122 END AHL_DI_SUBSCRIPTION_PUB;