1 PACKAGE AHL_PRD_WO_LOGIN_PUB AS
2 /* $Header: AHLPLGNS.pls 120.1 2006/09/21 11:34:04 sracha noship $ */
3 /*#
4 * Package containing APIs to allow a user to login or logout out of a
5 * work order, operation or a operation-resource.
6 * @rep:scope public
7 * @rep:product AHL
8 * @rep:displayname Work Order Login and Logout
9 * @rep:lifecycle active
10 * @rep:category BUSINESS_ENTITY AHL_MAINT_WORKORDER
11 */
12
13 ---------------------------------------------------------------------------------------------
14
15 -- Start of Comments --
16 --
17 -- Procedure name : Workorder_Login
18 -- Type : Public
19 -- Description : This API logs a technician into a workorder or operation or operation-resource. If the
20 -- operation sequence number passed to the API is null, then the login
21 -- is done at the workorder level; if the resource sequence or resource ID is not
22 -- passed but the workorder and operation is passed, then the login is at operation level.
23 -- If resource details are passed, then login is at the operation and resource level.
24 -- Parameters :
25 --
26 -- Standard IN Parameters :
27 -- p_api_version IN NUMBER Required
28 -- p_init_msg_list IN VARCHAR2 Required, default FND_API.G_FALSE
29 -- p_commit IN VARCHAR2 Required, default FND_API.G_FALSE
30 -- p_validation_level IN NUMBER Required, default FND_API.G_VALID_LEVEL_FULL
31 -- p_default IN VARCHAR2 Required, default FND_API.G_FALSE
32 -- p_module_type IN VARCHAR2 Required, default NULL
33
34 -- Standard OUT Parameters :
35 -- x_return_status OUT VARCHAR2 Required
36 -- x_msg_count OUT NUMBER Required
37 -- x_msg_data OUT VARCHAR2 Required
38 --
39 -- Procedure Parameters :
40 -- p_employee_num -- Employee Number (Optional)
41 -- p_employee_id -- Employee ID (Optional. If both Employee Num and Employee ID are
42 -- not passed, then employee is derived based on the
43 -- logged in user.)
44 -- p_workorder_name -- Workorder Name (Optional)
45 -- p_org_code -- Organization Code (Mandatory only if workorder_name is input. Used to derive
46 -- workorder_id if workorder_name is input.)
47 -- p_workorder_id -- Workorder ID (mandatory of workorder name/Org not provided).
48 -- p_operation_seq_num -- WO Operation seq (optional)
49 -- p_resource_seq_num -- WO Operation resource seq (optional)
50 -- p_resource_id -- WO Operation resource ID (optional)
51 --
52 -- Version :
53 -- Initial Version 1.0
54 --
55 --
56 --
57 --
58 -- End of Comments --
59 --
60 /*#
61 * Use this procedure to Login an employee/user into a work order or work order-operation-resource.
62 * @param p_api_version API Version Number.
63 * @param p_init_msg_list Initialize the message stack, Standard API parameter, default value FND_API.G_FALSE
64 * @param p_commit Parameter to decide whether to commit the transaction or not, Standard API parameter, default value FND_API.G_FALSE
65 * @param p_validation_level Validation level, Standard API parameter, default value FND_API.G_VALID_LEVEL_FULL
66 * @param p_module_type For Internal use only, should always be NULL, default value NULL
67 * @param x_return_status API Return status. Standard API parameter
68 * @param x_msg_count API Return message count, if any. Standard API parameter
69 * @param x_msg_data API Return message data, if any. Standard API parameter
70 * @param p_employee_num Employee Number
71 * @param p_employee_id Employee ID
72 * @param p_workorder_name Work Order name the employee wants to login into.
73 * @param p_workorder_id Work Order ID the employee wants to login into.
74 * @param p_org_code Work Order Organization Code
75 * @param p_operation_seq_num Work Order Operation Sequence-required if employee needs to login at the operation-resource level.
76 * @param p_resource_seq_num Work Order Resource Sequence-required if employee needs to login at the operation-resource level.
77 * @param p_resource_id Work Order Resource ID-optionally required if employee needs to login at the operation-resource level and p_resource_seq_num is not available.
78 * @rep:scope public
79 * @rep:lifecycle active
80 * @rep:displayname Work Order Login
81 */
82
83 PROCEDURE Workorder_Login(p_api_version IN NUMBER,
84 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
85 p_commit IN VARCHAR2 := FND_API.G_FALSE,
86 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
87 p_module_type IN VARCHAR2 := NULL,
88 x_return_status OUT NOCOPY VARCHAR2,
89 x_msg_count OUT NOCOPY NUMBER,
90 x_msg_data OUT NOCOPY VARCHAR2,
91 p_employee_num IN NUMBER := NULL,
92 p_employee_id IN NUMBER := NULL,
93 p_workorder_name IN VARCHAR2 := NULL,
94 p_workorder_id IN NUMBER := NULL,
95 p_org_code IN VARCHAR2 := NULL,
96 p_operation_seq_num IN NUMBER := NULL,
97 p_resource_seq_num IN NUMBER := NULL,
98 p_resource_id IN NUMBER := NULL);
99
100 ---------------------------------------------------------------------------------------------
101
102 -- Start of Comments --
103 -- Procedure name : Workorder_Logout
104 -- Type : Public
105 -- Description : This API logs a technician out of a workorder or operation.
106 -- If the operation related parameters passed to the API are null,
107 -- then the logout is done at the workorder level. If the operation
108 -- related parameters are not null, then the login is done at the
109 -- operation and resource level.At least one of employee number
110 -- or employee id should be passed to the API. If the employee id is not null
111 -- then the employee number is ignored. Also, at least one of workorder id or
112 -- workorder name should be passed. If the workorder id is passed, the workorder
113 -- name is ignored. Similarly, at least one of resource sequence number or
114 -- resource id should be passed to the API. If the resource id is passed, then
115 -- the resource sequence number is ignored.
116 -- Parameters :
117 --
118 -- Standard IN Parameters :
119 -- p_api_version IN NUMBER Required
120 -- p_init_msg_list IN VARCHAR2 Required, default FND_API.G_FALSE
121 -- p_commit IN VARCHAR2 Required, default FND_API.G_FALSE
122 -- p_validation_level IN NUMBER Required, default FND_API.G_VALID_LEVEL_FULL
123 -- p_default IN VARCHAR2 Required, default FND_API.G_FALSE
124 -- p_module_type IN VARCHAR2 Required, default NULL
125
126 -- Standard OUT Parameters :
127 -- x_return_status OUT VARCHAR2 Required
128 -- x_msg_count OUT NUMBER Required
129 -- x_msg_data OUT VARCHAR2 Required
130 --
131 -- Procedure Parameters :
132 -- p_employee_num -- Employee Number (Optional)
133 -- p_employee_id -- Employee ID (Optional. If both Employee Num and Employee ID are
134 -- not passed, then employee is derived based on the
135 -- logged in user.)
136 -- p_workorder_name -- Workorder Name (Optional)
137 -- p_org_code -- Organization Code (Mandatory only if workorder_name is input. Used to derive
138 -- workorder_id if workorder_name is input.)
139 -- p_workorder_id -- Workorder ID (mandatory of workorder name/Org not provided).
140 -- p_operation_seq_num -- WO Operation seq (optional)
141 -- p_resource_seq_num -- WO Operation resource seq (optional)
142 -- p_resource_id -- WO Operation resource ID (optional)
143 --
144 -- Version :
145 -- Initial Version 1.0
146 --
147 --
148 --
149 --
150 -- End of Comments --
151 --
152
153 /*#
154 * Use this procedure to Logout an employee/user out of a work order or work order-operation-resource.
155 * @param p_api_version API Version Number.
156 * @param p_init_msg_list Initialize the message stack, Standard API parameter, default value FND_API.G_FALSE
157 * @param p_commit Parameter to decide whether to commit the transaction or not, Standard API parameter, default value FND_API.G_FALSE
158 * @param p_validation_level Validation level, Standard API parameter, default value FND_API.G_VALID_LEVEL_FULL
159 * @param p_module_type For Internal use only, should always be NULL, default value NULL
160 * @param x_return_status API Return status. Standard API parameter
161 * @param x_msg_count API Return message count, if any. Standard API parameter
162 * @param x_msg_data API Return message data, if any. Standard API parameter
163 * @param p_employee_num Employee Number
164 * @param p_employee_id Employee ID
165 * @param p_workorder_name Work Order name the employee wants to login into.
166 * @param p_workorder_id Work Order ID the employee wants to login into.
167 * @param p_org_code Work Order Organization Code
168 * @param p_operation_seq_num Work Order Operation Sequence-required if employee needs to login at the operation-resource level.
169 * @param p_resource_seq_num Work Order Resource Sequence-required if employee needs to login at the operation-resource level.
170 * @param p_resource_id Work Order Resource ID-optionally required if employee needs to login at the operation-resource level and p_resource_seq_num is not available.
171 * @rep:scope public
172 * @rep:lifecycle active
173 * @rep:displayname Work Order Logout
174 */
175 PROCEDURE Workorder_Logout( p_api_version IN NUMBER,
176 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
177 p_commit IN VARCHAR2 := FND_API.G_FALSE,
178 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
179 p_module_type IN VARCHAR2 := NULL,
180 x_return_status OUT NOCOPY VARCHAR2,
181 x_msg_count OUT NOCOPY NUMBER,
182 x_msg_data OUT NOCOPY VARCHAR2,
183 p_employee_num IN NUMBER := NULL,
184 p_employee_id IN NUMBER := NULL,
185 p_workorder_name IN VARCHAR2 := NULL,
186 p_workorder_id IN NUMBER := NULL,
187 p_org_code IN VARCHAR2 := NULL,
188 p_operation_seq_num IN NUMBER := NULL,
189 p_resource_seq_num IN NUMBER := NULL,
190 p_resource_id IN NUMBER := NULL);
191
192 ---------------------------------------------------------------------------------------------
193
194 END AHL_PRD_WO_LOGIN_PUB;
[Home] [Help]