1 PACKAGE jtf_rs_resource_values_pub AS
2 /* $Header: jtfrspcs.pls 120.0 2005/05/11 08:21:05 appldev ship $ */
3 /*#
4 * This package contains procedures to maintain resource parameter
5 * values
6 * @rep:scope internal
7 * @rep:product JTF
8 * @rep:displayname Resource Values Package
9 * @rep:category BUSINESS_ENTITY JTF_RS_RESOURCE
10 */
11
12
13 TYPE jtf_rs_values_user_hook is RECORD (
14 resource_id NUMBER,
15 resource_param_id NUMBER,
16 resource_param_value_id NUMBER,
17 value VARCHAR2(255),
18 value_type VARCHAR2(30)
19 );
20
21 p_rs_value_user_hook jtf_rs_values_user_hook;
22
23 TYPE RS_PARAM_LIST_REC_TYPE IS RECORD
24 (
25 RESOURCE_PARAM_ID NUMBER := FND_API.G_MISS_NUM,
26 MEANING VARCHAR2(80) := FND_API.G_MISS_CHAR,
27 TYPE VARCHAR2(30) := FND_API.G_MISS_CHAR,
28 DOMAIN_LOOKUP_TYPE VARCHAR2(30) := FND_API.G_MISS_CHAR
29 );
30
31 TYPE RS_PARAM_LIST_TBL_TYPE IS
32 TABLE OF RS_PARAM_LIST_REC_TYPE
33 INDEX BY BINARY_INTEGER;
34
35 G_MISS_RS_PARAM_LIST_REC RS_PARAM_LIST_REC_TYPE;
36 G_MISS_RS_PARAM_LIST_TBL RS_PARAM_LIST_TBL_TYPE;
37
38 /*#
39 * Procedure to Create a resource parameter value
40 * @param P_Api_Version API version number
41 * @param P_Init_Msg_List Flag to start with clearing messages from database
42 * @param P_Commit Flag to commit at the end of the procedure
43 * @param P_resource_id Resource's internal unique ID
44 * @param p_resource_param_id Internal unique ID for the resource parameter
45 * @param p_value Value for the resource parameter
46 * @param P_value_type Type for the value of the resource parameter
47 * @param X_Return_Status Output parameter for return status
48 * @param X_Msg_Count Output parameter for number of user messages from this procedure
49 * @param X_Msg_Data Output parameter containing last user message from this procedure
50 * @param X_resource_param_value_id Output parameter containing internal unique ID for the newly created resource parameter value
51 * @rep:scope internal
52 * @rep:displayname Create Resource Parameter Value
53 */
54 PROCEDURE CREATE_RS_RESOURCE_VALUES(
55 P_Api_Version IN NUMBER,
56 P_Init_Msg_List IN VARCHAR2 := FND_API.G_FALSE,
57 P_Commit IN VARCHAR2 := FND_API.G_FALSE,
58 P_resource_id IN NUMBER,
59 p_resource_param_id IN NUMBER,
60 p_value IN VARCHAR2,
61 P_value_type IN VARCHAR2 DEFAULT NULL,
62 X_Return_Status OUT NOCOPY VARCHAR2,
63 X_Msg_Count OUT NOCOPY NUMBER,
64 X_Msg_Data OUT NOCOPY VARCHAR2,
65 X_resource_param_value_id OUT NOCOPY NUMBER
66 );
67
68
69 /*#
70 * Update a resource parameter value
71 * @param P_Api_Version API version number
72 * @param P_Init_Msg_List Flag to start with clearing messages from database
73 * @param P_Commit Flag to commit at the end of the procedure
74 * @param p_resource_param_value_id internal unique ID for a resource parameter value
75 * @param P_resource_id Resource's internal unique ID
76 * @param p_resource_param_id unique internal ID for the resource parameter
77 * @param p_value Value for the resource parameter
78 * @param P_value_type Type for the value of the resource parameter
79 * @param p_object_version_number Input/Output parameter for the object version number
80 * @param X_Return_Status Output parameter for return status
81 * @param X_Msg_Count Output parameter for number of user messages from this procedure
82 * @param X_Msg_Data Output parameter containing last user message from this procedure
83 * @rep:scope internal
84 * @rep:displayname Update Resource Parameter Value
85 */
86 PROCEDURE UPDATE_RS_RESOURCE_VALUES(
87 P_Api_Version IN NUMBER,
88 P_Init_Msg_List IN VARCHAR2 := FND_API.G_FALSE,
89 P_Commit IN VARCHAR2 := FND_API.G_FALSE,
90 p_resource_param_value_id IN NUMBER,
91 p_resource_id IN NUMBER,
92 p_resource_param_id IN NUMBER,
93 p_value IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
94 p_value_type IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
95 p_object_version_number IN OUT NOCOPY JTF_RS_RESOURCE_VALUES.OBJECT_VERSION_NUMBER%TYPE,
96 X_Return_Status OUT NOCOPY VARCHAR2,
97 X_Msg_Count OUT NOCOPY NUMBER,
98 X_Msg_Data OUT NOCOPY VARCHAR2
99 );
100
101 /*#
102 * Delete a resource parameter value
103 * @param P_Api_Version API version number
104 * @param P_Init_Msg_List Flag to start with clearing messages from database
105 * @param P_Commit Flag to commit at the end of the procedure
106 * @param p_resource_param_value_id internal unique ID a resource parameter value
107 * @param p_object_version_number object version number of the resource parameter value record
108 * @param X_Return_Status Output parameter for return status
109 * @param X_Msg_Count Output parameter for number of user messages from this procedure
110 * @param X_Msg_Data Output parameter containing last user message from this procedure
111 * @rep:scope internal
112 * @rep:displayname Delete Resource Parameter Value
113 */
114 PROCEDURE DELETE_RS_RESOURCE_VALUES(
115 P_Api_Version IN NUMBER,
116 P_Init_Msg_List IN VARCHAR2 := FND_API.G_FALSE,
117 P_Commit IN VARCHAR2 := FND_API.G_FALSE,
118 p_resource_param_value_id IN NUMBER,
119 p_object_version_number IN JTF_RS_RESOURCE_VALUES.OBJECT_VERSION_NUMBER%TYPE,
120 X_Return_Status OUT NOCOPY VARCHAR2,
121 X_Msg_Count OUT NOCOPY NUMBER,
122 X_Msg_Data OUT NOCOPY VARCHAR2
123 );
124
125 /*#
126 * Delete all records of resource parameter values for a resource
127 * @param P_Api_Version API version number
128 * @param P_Init_Msg_List Flag to start with clearing messages from database
129 * @param P_Commit Flag to commit at the end of the procedure
130 * @param P_resource_id Resource's internal unique ID
131 * @param X_Return_Status Output parameter for return status
132 * @param X_Msg_Count Output parameter for number of user messages from this procedure
133 * @param X_Msg_Data Output parameter containing last user message from this procedure
134 * @rep:scope internal
135 * @rep:displayname Delete Resource Parameter Values Of A Resource
136 */
137 PROCEDURE DELETE_ALL_RS_RESOURCE_VALUES(
138 P_Api_Version IN NUMBER,
139 P_Init_Msg_List IN VARCHAR2 := FND_API.G_FALSE,
140 P_Commit IN VARCHAR2 := FND_API.G_FALSE,
141 p_resource_id IN NUMBER,
142 X_Return_Status OUT NOCOPY VARCHAR2,
143 X_Msg_Count OUT NOCOPY NUMBER,
144 X_Msg_Data OUT NOCOPY VARCHAR2
145 );
146
147 /*#
148 * Get a value of a resource parameter for a resource.
149 * @param P_Api_Version API version number
150 * @param P_Init_Msg_List Flag to start with clearing messages from database
151 * @param P_Commit Flag to commit at the end of the procedure
152 * @param P_resource_id Resource's internal unique ID
153 * @param P_value_type Type for the value of the resource parameter
154 * @param p_resource_param_id unique internal ID for the resource parameter
155 * @param x_resource_param_value_id Output parameter, to get the unique internal id for resource parameter value
156 * @param x_value Output parameter, to get value for a resource parameter
157 * @param X_Return_Status Output parameter for return status
158 * @param X_Msg_Count Output parameter for number of user messages from this procedure
159 * @param X_Msg_Data Output parameter containing last user message from this procedure
160 * @rep:scope internal
161 * @rep:displayname Get Resource Parameter Value
162 */
163 PROCEDURE GET_RS_RESOURCE_VALUES(
164 P_Api_Version IN NUMBER,
165 P_Init_Msg_List IN VARCHAR2 := FND_API.G_FALSE,
166 P_Commit IN VARCHAR2 := FND_API.G_FALSE,
167 P_resource_id IN NUMBER,
168 P_value_type IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
169 p_resource_param_id IN NUMBER,
170 x_resource_param_value_id OUT NOCOPY NUMBER,
171 x_value OUT NOCOPY VARCHAR2,
172 X_Return_Status OUT NOCOPY VARCHAR2,
173 X_Msg_Count OUT NOCOPY NUMBER,
174 X_Msg_Data OUT NOCOPY VARCHAR2
175 );
176
177 /*#
178 * Get a list of all resource parameters
179 * @param P_Api_Version API version number
180 * @param P_Init_Msg_List Flag to start with clearing messages from database
181 * @param P_Commit Flag to commit at the end of the procedure
182 * @param P_APPLICATION_ID Application ID
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 * @param X_RS_PARAM_Table Output parameter containing list of all parameters in a pl/sql table
187 * @param X_No_Record Output parameter containing count of records in x_rs_param_table
188 * @rep:scope internal
189 * @rep:displayname Get Resource Parameter List
190 */
191 PROCEDURE GET_RS_RESOURCE_PARAM_LIST(
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_APPLICATION_ID IN NUMBER,
196 X_Return_Status OUT NOCOPY VARCHAR2,
197 X_Msg_Count OUT NOCOPY NUMBER,
198 X_Msg_Data OUT NOCOPY VARCHAR2,
199 X_RS_PARAM_Table OUT NOCOPY RS_PARAM_LIST_TBL_TYPE,
200 X_No_Record OUT NOCOPY Number
201 );
202
203 End JTF_RS_RESOURCE_VALUES_PUB;
204
[Home] [Help]