1 PACKAGE jtf_rs_groups_pub AS
2 /* $Header: jtfrspgs.pls 120.0 2005/05/11 08:21:10 appldev ship $ */
3 /*#
4 * Group create and update API
5 * This API contains the procedures to insert and update Group record.
6 * @rep:scope public
7 * @rep:product JTF
8 * @rep:displayname Groups API
9 * @rep:category BUSINESS_ENTITY JTF_RS_GROUP
10 */
11 /*****************************************************************************************
12 This is a public API that caller will invoke.
13 It provides procedures for managing resource groups.
14 Its main procedures are as following:
15 Create Resource Group
16 Update Resource Group
17 Calls to these procedures will invoke procedures from jtf_rs_groups_pvt
18 to do business validations and to do actual inserts and updates into tables.
19 This package uses variables of type record and pl/sql table .
20 ******************************************************************************************/
21
22
23 /* Procedure to create the resource group and the members
24 based on input values passed by calling routines. */
25 /*#
26 * Create Group API
27 * This procedure allows the user to create a group record.
28 * @param p_api_version API version
29 * @param p_init_msg_list Initialization of the message list
30 * @param p_commit Commit
31 * @param p_group_name The name of the resource group
32 * @param p_group_desc A description of the resource group
33 * @param p_exclusive_flag Exclusive Flag
34 * @param p_email_address The email address of the group owner
35 * @param p_start_date_active Date on which the resource group becomes active. This value can not be NULL, and the start date must be less than the end date.
36 * @param p_end_date_active Date on which the resource group is no longer active. If no end date is provided, the group is active indefinitely.
37 * @param p_accounting_code Account code
38 * @param x_return_status Output parameter for return status
39 * @param x_msg_count Output parameter for number of user messages from this procedure
40 * @param x_msg_data Output parameter containing last user message from this procedure
41 * @param x_group_id Out parameter for Group Identifier
42 * @param x_group_number Out parameter for Group Number
43 * @rep:scope public
44 * @rep:lifecycle active
45 * @rep:displayname Create Group API
46 */
47 PROCEDURE create_resource_group
48 (P_API_VERSION IN NUMBER,
49 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
50 P_COMMIT IN VARCHAR2 DEFAULT FND_API.G_FALSE,
51 P_GROUP_NAME IN JTF_RS_GROUPS_VL.GROUP_NAME%TYPE,
52 P_GROUP_DESC IN JTF_RS_GROUPS_VL.GROUP_DESC%TYPE DEFAULT NULL,
53 P_EXCLUSIVE_FLAG IN JTF_RS_GROUPS_VL.EXCLUSIVE_FLAG%TYPE DEFAULT 'N',
54 P_EMAIL_ADDRESS IN JTF_RS_GROUPS_VL.EMAIL_ADDRESS%TYPE DEFAULT NULL,
55 P_START_DATE_ACTIVE IN JTF_RS_GROUPS_VL.START_DATE_ACTIVE%TYPE,
56 P_END_DATE_ACTIVE IN JTF_RS_GROUPS_VL.END_DATE_ACTIVE%TYPE DEFAULT NULL,
57 P_ACCOUNTING_CODE IN JTF_RS_GROUPS_VL.ACCOUNTING_CODE%TYPE DEFAULT NULL,
58 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
59 X_MSG_COUNT OUT NOCOPY NUMBER,
60 X_MSG_DATA OUT NOCOPY VARCHAR2,
61 X_GROUP_ID OUT NOCOPY JTF_RS_GROUPS_VL.GROUP_ID%TYPE,
62 X_GROUP_NUMBER OUT NOCOPY JTF_RS_GROUPS_VL.GROUP_NUMBER%TYPE
63 );
64
65
66 --Create Resource Group Migration API, used for one-time migration of resource group data
67 --The API includes GROUP_ID as one of its Input Parameters
68 /*#
69 * Create Group Migration API
70 * This procedure is used for one-time migration of resource group data
71 * The API includes group_id as one of its Input Parameters
72 * @param p_api_version API version
73 * @param p_init_msg_list Initialization of the message list
74 * @param p_commit Commit
75 * @param p_group_id Group Identifier
76 * @param p_group_name The name of the resource group
77 * @param p_group_desc A description of the resource group
78 * @param p_exclusive_flag Exclusive Flag
79 * @param p_email_address The email address of the group owner
80 * @param p_start_date_active Date on which the resource group becomes active. This value can not be NULL, and the start date must be less than the end date.
81 * @param p_end_date_active Date on which the resource group is no longer active. If no end date is provided, the group is active indefinitely.
82 * @param p_accounting_code Account code
83 * @param p_attribute1 Descriptive flexfield Segment 1
84 * @param p_attribute2 Descriptive flexfield Segment 2
85 * @param p_attribute3 Descriptive flexfield Segment 3
86 * @param p_attribute4 Descriptive flexfield Segment 4
87 * @param p_attribute5 Descriptive flexfield Segment 5
88 * @param p_attribute6 Descriptive flexfield Segment 6
89 * @param p_attribute7 Descriptive flexfield Segment 7
90 * @param p_attribute8 Descriptive flexfield Segment 8
91 * @param p_attribute9 Descriptive flexfield Segment 9
92 * @param p_attribute10 Descriptive flexfield Segment 10
93 * @param p_attribute11 Descriptive flexfield Segment 11
94 * @param p_attribute12 Descriptive flexfield Segment 12
95 * @param p_attribute13 Descriptive flexfield Segment 13
96 * @param p_attribute14 Descriptive flexfield Segment 14
97 * @param p_attribute15 Descriptive flexfield Segment 15
98 * @param p_attribute_category Descriptive flexfield structure definition column
99 * @param x_return_status Output parameter for return status
100 * @param x_msg_count Output parameter for number of user messages from this procedure
101 * @param x_msg_data Output parameter containing last user message from this procedure
102 * @param x_group_id Out parameter for Group Identifier
103 * @param x_group_number Out parameter for Group Number
104 * @rep:scope internal
105 * @rep:lifecycle obsolete
106 * @rep:displayname Create Group Migration API
107 */
108 PROCEDURE create_resource_group_migrate
109 (P_API_VERSION IN NUMBER,
110 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
111 P_COMMIT IN VARCHAR2 DEFAULT FND_API.G_FALSE,
112 P_GROUP_NAME IN JTF_RS_GROUPS_VL.GROUP_NAME%TYPE,
113 P_GROUP_DESC IN JTF_RS_GROUPS_VL.GROUP_DESC%TYPE DEFAULT NULL,
114 P_EXCLUSIVE_FLAG IN JTF_RS_GROUPS_VL.EXCLUSIVE_FLAG%TYPE DEFAULT 'N',
115 P_EMAIL_ADDRESS IN JTF_RS_GROUPS_VL.EMAIL_ADDRESS%TYPE DEFAULT NULL,
116 P_START_DATE_ACTIVE IN JTF_RS_GROUPS_VL.START_DATE_ACTIVE%TYPE,
117 P_END_DATE_ACTIVE IN JTF_RS_GROUPS_VL.END_DATE_ACTIVE%TYPE DEFAULT NULL,
118 P_ACCOUNTING_CODE IN JTF_RS_GROUPS_VL.ACCOUNTING_CODE%TYPE DEFAULT NULL,
119 P_GROUP_ID IN JTF_RS_GROUPS_VL.GROUP_ID%TYPE,
120 P_ATTRIBUTE1 IN JTF_RS_GROUPS_VL.ATTRIBUTE1%TYPE DEFAULT NULL,
121 P_ATTRIBUTE2 IN JTF_RS_GROUPS_VL.ATTRIBUTE2%TYPE DEFAULT NULL,
122 P_ATTRIBUTE3 IN JTF_RS_GROUPS_VL.ATTRIBUTE3%TYPE DEFAULT NULL,
123 P_ATTRIBUTE4 IN JTF_RS_GROUPS_VL.ATTRIBUTE4%TYPE DEFAULT NULL,
124 P_ATTRIBUTE5 IN JTF_RS_GROUPS_VL.ATTRIBUTE5%TYPE DEFAULT NULL,
125 P_ATTRIBUTE6 IN JTF_RS_GROUPS_VL.ATTRIBUTE6%TYPE DEFAULT NULL,
126 P_ATTRIBUTE7 IN JTF_RS_GROUPS_VL.ATTRIBUTE7%TYPE DEFAULT NULL,
127 P_ATTRIBUTE8 IN JTF_RS_GROUPS_VL.ATTRIBUTE8%TYPE DEFAULT NULL,
128 P_ATTRIBUTE9 IN JTF_RS_GROUPS_VL.ATTRIBUTE9%TYPE DEFAULT NULL,
129 P_ATTRIBUTE10 IN JTF_RS_GROUPS_VL.ATTRIBUTE10%TYPE DEFAULT NULL,
130 P_ATTRIBUTE11 IN JTF_RS_GROUPS_VL.ATTRIBUTE11%TYPE DEFAULT NULL,
131 P_ATTRIBUTE12 IN JTF_RS_GROUPS_VL.ATTRIBUTE12%TYPE DEFAULT NULL,
132 P_ATTRIBUTE13 IN JTF_RS_GROUPS_VL.ATTRIBUTE13%TYPE DEFAULT NULL,
133 P_ATTRIBUTE14 IN JTF_RS_GROUPS_VL.ATTRIBUTE14%TYPE DEFAULT NULL,
134 P_ATTRIBUTE15 IN JTF_RS_GROUPS_VL.ATTRIBUTE15%TYPE DEFAULT NULL,
135 P_ATTRIBUTE_CATEGORY IN JTF_RS_GROUPS_VL.ATTRIBUTE_CATEGORY%TYPE DEFAULT NULL,
136 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
137 X_MSG_COUNT OUT NOCOPY NUMBER,
138 X_MSG_DATA OUT NOCOPY VARCHAR2,
139 X_GROUP_ID OUT NOCOPY JTF_RS_GROUPS_VL.GROUP_ID%TYPE,
140 X_GROUP_NUMBER OUT NOCOPY JTF_RS_GROUPS_VL.GROUP_NUMBER%TYPE
141 );
142
143 --Creating a Global Variable to be used for setting the flag,
144 --when the create_resource_group_migrate gets called
145
146 G_RS_GRP_ID_PUB_FLAG VARCHAR2(1) := 'Y';
147 G_GROUP_ID JTF_RS_GROUPS_VL.GROUP_ID%TYPE := NULL;
148 G_ATTRIBUTE1 JTF_RS_GROUPS_VL.ATTRIBUTE1%TYPE := NULL;
149 G_ATTRIBUTE2 JTF_RS_GROUPS_VL.ATTRIBUTE2%TYPE := NULL;
150 G_ATTRIBUTE3 JTF_RS_GROUPS_VL.ATTRIBUTE3%TYPE := NULL;
151 G_ATTRIBUTE4 JTF_RS_GROUPS_VL.ATTRIBUTE4%TYPE := NULL;
152 G_ATTRIBUTE5 JTF_RS_GROUPS_VL.ATTRIBUTE5%TYPE := NULL;
153 G_ATTRIBUTE6 JTF_RS_GROUPS_VL.ATTRIBUTE6%TYPE := NULL;
154 G_ATTRIBUTE7 JTF_RS_GROUPS_VL.ATTRIBUTE7%TYPE := NULL;
155 G_ATTRIBUTE8 JTF_RS_GROUPS_VL.ATTRIBUTE8%TYPE := NULL;
156 G_ATTRIBUTE9 JTF_RS_GROUPS_VL.ATTRIBUTE9%TYPE := NULL;
157 G_ATTRIBUTE10 JTF_RS_GROUPS_VL.ATTRIBUTE10%TYPE := NULL;
158 G_ATTRIBUTE11 JTF_RS_GROUPS_VL.ATTRIBUTE11%TYPE := NULL;
159 G_ATTRIBUTE12 JTF_RS_GROUPS_VL.ATTRIBUTE12%TYPE := NULL;
160 G_ATTRIBUTE13 JTF_RS_GROUPS_VL.ATTRIBUTE13%TYPE := NULL;
161 G_ATTRIBUTE14 JTF_RS_GROUPS_VL.ATTRIBUTE14%TYPE := NULL;
162 G_ATTRIBUTE15 JTF_RS_GROUPS_VL.ATTRIBUTE15%TYPE := NULL;
163 G_ATTRIBUTE_CATEGORY JTF_RS_GROUPS_VL.ATTRIBUTE_CATEGORY%TYPE := NULL;
164
165 /* Procedure to update the resource group based on input values
166 passed by calling routines. */
167 /*#
168 * Update Group API
169 * This procedure allows the user to update a group record.
170 * @param p_api_version API version
171 * @param p_init_msg_list Initialization of the message list
172 * @param p_commit Commit
173 * @param p_group_id Group Identifier
174 * @param p_group_number Group Number
175 * @param p_group_name The name of the resource group
176 * @param p_group_desc A description of the resource group
177 * @param p_exclusive_flag Exclusive Flag
178 * @param p_email_address The email address of the group owner
179 * @param p_start_date_active Date on which the resource group becomes active. This value can not be NULL, and the start date must be less than the end date.
180 * @param p_end_date_active Date on which the resource group is no longer active. If no end date is provided, the group is active indefinitely.
181 * @param p_accounting_code Account code
182 * @param p_object_version_num The object version number of the group derives from the jtf_rs_groups table.
183 * @param x_return_status Output parameter for return status
184 * @param x_msg_count Output parameter for number of user messages from this procedure
185 * @param x_msg_data Output parameter containing last user message from this procedure
186 * @rep:scope public
187 * @rep:lifecycle active
188 * @rep:displayname Update Group API
189 */
190 PROCEDURE update_resource_group
191 (P_API_VERSION IN NUMBER,
192 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
193 P_COMMIT IN VARCHAR2 DEFAULT FND_API.G_FALSE,
194 P_GROUP_ID IN JTF_RS_GROUPS_VL.GROUP_ID%TYPE,
195 P_GROUP_NUMBER IN JTF_RS_GROUPS_VL.GROUP_NUMBER%TYPE,
196 P_GROUP_NAME IN JTF_RS_GROUPS_VL.GROUP_NAME%TYPE DEFAULT FND_API.G_MISS_CHAR,
197 P_GROUP_DESC IN JTF_RS_GROUPS_VL.GROUP_DESC%TYPE DEFAULT FND_API.G_MISS_CHAR,
198 P_EXCLUSIVE_FLAG IN JTF_RS_GROUPS_VL.EXCLUSIVE_FLAG%TYPE DEFAULT FND_API.G_MISS_CHAR,
199 P_EMAIL_ADDRESS IN JTF_RS_GROUPS_VL.EMAIL_ADDRESS%TYPE DEFAULT FND_API.G_MISS_CHAR,
200 P_START_DATE_ACTIVE IN JTF_RS_GROUPS_VL.START_DATE_ACTIVE%TYPE DEFAULT FND_API.G_MISS_DATE,
201 P_END_DATE_ACTIVE IN JTF_RS_GROUPS_VL.END_DATE_ACTIVE%TYPE DEFAULT FND_API.G_MISS_DATE,
202 P_ACCOUNTING_CODE IN JTF_RS_GROUPS_VL.ACCOUNTING_CODE%TYPE DEFAULT FND_API.G_MISS_CHAR,
203 P_OBJECT_VERSION_NUM IN OUT NOCOPY JTF_RS_GROUPS_VL.OBJECT_VERSION_NUMBER%TYPE,
204 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
205 X_MSG_COUNT OUT NOCOPY NUMBER,
206 X_MSG_DATA OUT NOCOPY VARCHAR2
207 );
208
209
210 END jtf_rs_groups_pub;
[Home] [Help]