1 PACKAGE jtf_rs_resource_utl_pub AUTHID CURRENT_USER AS
2 /* $Header: jtfrspns.pls 120.0 2005/05/11 08:21:18 appldev ship $ */
3 /*#
4 * Resource Utility API
5 * This API contains the some common procedures and functions
6 * that is called from other Resource Manager APIs.
7 * @rep:scope private
8 * @rep:product JTF
9 * @rep:displayname Resource Utility API
10 * @rep:category BUSINESS_ENTITY JTF_RS_RESOURCE
11 */
12
13 /*****************************************************************************************
14 ******************************************************************************************/
15 /*#
16 * End date Resource API
17 * This procedure allows the user to end date a resource.
18 * This will also end date the corresponding records from Salesreps and role relations tables, if any.
19 * Even if the API name says end_date_employee, it is for end dating all type of resources.
20 * @param P_API_VERSION API version
21 * @param P_INIT_MSG_LIST Initialization of the message list
22 * @param P_COMMIT Commit
23 * @param P_RESOURCE_ID resource identifier
24 * @param P_END_DATE_ACTIVE Date on which the resource is no longer active.
25 * @param X_OBJECT_VER_NUMBER The object version number of the resource derives from the jtf_rs_resource_extns table.
26 * @param X_RETURN_STATUS Output parameter for return status
27 * @param X_MSG_COUNT Output parameter for number of user messages from this procedure
28 * @param X_MSG_DATA Output parameter containing last user message from this procedure
29 * @rep:scope private
30 * @rep:lifecycle active
31 * @rep:displayname End date Resource API
32 */
33 PROCEDURE end_date_employee
34 (P_API_VERSION IN NUMBER,
35 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
36 P_COMMIT IN VARCHAR2 DEFAULT FND_API.G_FALSE,
37 P_RESOURCE_ID IN NUMBER,
38 P_END_DATE_ACTIVE IN DATE,
39 X_OBJECT_VER_NUMBER IN OUT NOCOPY NUMBER,
40 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
41 X_MSG_COUNT OUT NOCOPY NUMBER,
42 X_MSG_DATA OUT NOCOPY VARCHAR2 ) ;
43
44 /*#
45 * Add Message API
46 * This procedure allows the user to add a message to the message stack.
47 * This also accepts upto 2 tokens and corresponding values.
48 * @param P_API_VERSION API version
49 * @param P_MESSAGE_CODE Message Code
50 * @param P_TOKEN1_NAME First Token Name
51 * @param P_TOKEN1_VALUE First Token Value
52 * @param P_TOKEN2_NAME Second Token Name
53 * @param P_TOKEN2_VALUE Second Token Value
54 * @param X_RETURN_STATUS Output parameter for return status
55 * @param X_MSG_COUNT Output parameter for number of user messages from this procedure
56 * @param X_MSG_DATA Output parameter containing last user message from this procedure
57 * @rep:scope private
58 * @rep:lifecycle active
59 * @rep:displayname Add Message API
60 */
61 PROCEDURE add_message
62 (P_API_VERSION IN NUMBER,
63 P_MESSAGE_CODE IN VARCHAR2,
64 P_TOKEN1_NAME IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
65 P_TOKEN1_VALUE IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
66 P_TOKEN2_NAME IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
67 P_TOKEN2_VALUE IN VARCHAR2 DEFAULT FND_API.G_MISS_CHAR,
68 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
69 X_MSG_COUNT OUT NOCOPY NUMBER,
70 X_MSG_DATA OUT NOCOPY VARCHAR2
71 ) ;
72
73 /* Function to check if user has update access */
74
75 /*#
76 * Validate Resource Update Access
77 * Function to check if user has resource update access
78 * @param p_resource_id Resource Id
79 * @param p_resource_user_id User Id for the Resource
80 * @return Update Access
81 * @rep:scope private
82 * @rep:displayname Validate Resource Update Access
83 */
84 Function Validate_Update_Access( p_resource_id number,
85 p_resource_user_id number default null
86 ) Return varchar2 ;
87
88 /*#
89 * Validate Group Update Access
90 * Function to check if logged in user has access to Update Group Membership/Hierarchy
91 * @param p_group_id Group Id
92 * @return Update Access
93 * @rep:scope private
94 * @rep:displayname Validate Group Update Access
95 */
96 Function Group_Update_Access( p_group_id IN number default null) Return varchar2 ;
97
98 /*#
99 * Validate Role Update Access
100 * Function to check if logged in user has access to Update the roles
101 * @return Update Access
102 * @rep:scope private
103 * @rep:displayname Validate Role Update Access
104 */
105 FUNCTION Role_Update_Access RETURN VARCHAR2;
106
107 /*#
108 * Validate if the user is HR manager
109 * Function to check if user is HR manager for the resource.
110 * @param p_resource_id Resource Id
111 * @return Is HR Manager
112 * @rep:scope private
113 * @rep:displayname Validate if the user is HR manager
114 */
115 Function Is_HR_Manager( p_resource_id number)
116 Return varchar2;
117
118 /*#
119 * End date Group API
120 * This procedure allows the user to end date group, all the group member roles and group relations for a group.
121 * @param P_API_VERSION API version
122 * @param P_INIT_MSG_LIST Initialization of the message list
123 * @param P_COMMIT Commit
124 * @param P_GROUP_ID Group identifier
125 * @param P_END_DATE_ACTIVE Date on which the group is no longer active.
126 * @param X_OBJECT_VER_NUMBER The object version number of the group derives from the jtf_rs_groups_b table.
127 * @param X_RETURN_STATUS Output parameter for return status
128 * @param X_MSG_COUNT Output parameter for number of user messages from this procedure
129 * @param X_MSG_DATA Output parameter containing last user message from this procedure
130 * @rep:scope private
131 * @rep:lifecycle active
132 * @rep:displayname End date Group API
133 */
134 PROCEDURE end_date_group
135 (P_API_VERSION IN NUMBER,
136 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
137 P_COMMIT IN VARCHAR2 DEFAULT FND_API.G_FALSE,
138 P_GROUP_ID IN NUMBER,
139 P_END_DATE_ACTIVE IN DATE,
140 X_OBJECT_VER_NUMBER IN OUT NOCOPY NUMBER,
141 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
142 X_MSG_COUNT OUT NOCOPY NUMBER,
143 X_MSG_DATA OUT NOCOPY VARCHAR2 ) ;
144
145 /* returns 'Y' for Yes and 'N' for No */
146 FUNCTION TAX_VENDOR_EXTENSION return VARCHAR2;
147 /* returns 'Y' for Yes and 'N' for No */
148 FUNCTION IS_GEOCODE_VALID(p_geocode IN VARCHAR2) return VARCHAR2;
149 /* returns 'Y' for Yes and 'N' for No */
150 FUNCTION IS_CITY_LIMIT_VALID(p_city_limit IN VARCHAR2) return VARCHAR2;
151
152 end jtf_rs_resource_utl_pub;
[Home] [Help]