1 Package PQH_ROUTING_LISTS_api as
2 /* $Header: pqrltapi.pkh 120.1 2005/10/02 02:27:40 aroussel $ */
3 /*#
4 * This package contains routing list APIs.
5 * @rep:scope public
6 * @rep:product per
7 * @rep:displayname Routing List
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< create_routing_list >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API creates a routing list which is a sequence of destinations for
17 * routing a transaction.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with Human Resources.
22 *
23 * <p><b>Prerequisites</b><br>
24 * A routing list with duplicate name should not exist.
25 *
26 * <p><b>Post Success</b><br>
27 * The routing list is successfully created in the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * The routing list is not created and an error is raised.
31 * @param p_validate If true, then validation alone will be performed and the
32 * database will remain unchanged. If false and all validation checks pass,
33 * then the database will be modified.
34 * @param p_routing_list_id If p_validate is false, then this uniquely
35 * identifies the routing list created. If p_validate is true, then set to
36 * null.
37 * @param p_routing_list_name Unique routing list name.
38 * @param p_enable_flag Indicates if the routing list is enabled/disabled.
39 * Valid values are defined by 'PQH_YES_NO' lookup_type.
40 * @param p_object_version_number If p_validate is false, then set to the
41 * version number of the created routing list. If p_validate is true, then the
42 * value will be null.
43 * @rep:displayname Create Routing List
44 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
45 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
46 * @rep:scope public
47 * @rep:lifecycle active
48 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
49 */
50 --
51 -- {End Of Comments}
52 --
53 procedure create_routing_list
54 (
55 p_validate in boolean default false
56 ,p_routing_list_id out nocopy number
57 ,p_routing_list_name in varchar2
58 ,p_enable_flag in varchar2 default 'Y'
59 ,p_object_version_number out nocopy number
60 );
61 --
62 -- ----------------------------------------------------------------------------
63 -- |---------------------------< update_routing_list >------------------------|
64 -- ----------------------------------------------------------------------------
65 --
66 -- {Start Of Comments}
67 /*#
68 * This API updates routing list details.
69 *
70 * A routing list that is enabled, cannot be disabled if transactions have been
71 * routed to it and these transactions have approval pending.
72 *
73 * <p><b>Licensing</b><br>
74 * This API is licensed for use with Human Resources.
75 *
76 * <p><b>Prerequisites</b><br>
77 * The routing list that is updated must already exist.
78 *
79 * <p><b>Post Success</b><br>
80 * The routing list is updated successfully in the database.
81 *
82 * <p><b>Post Failure</b><br>
83 * The routing list is not updated and an error is raised.
84 * @param p_validate If true, then validation alone will be performed and the
85 * database will remain unchanged. If false and all validation checks pass,
86 * then the database will be modified.
87 * @param p_routing_list_id Identifies the routing list record to be modified.
88 * @param p_routing_list_name Unique routing list name.
89 * @param p_enable_flag Indicates if the routing list is enabled/disabled.
90 * Valid values are defined by 'PQH_YES_NO' lookup_type.
91 * @param p_object_version_number Pass in the current version number of the
92 * routing list to be updated. When the API completes if p_validate is false,
93 * will be set to the new version number of the updated routing list. If
94 * p_validate is true will be set to the same value which was passed in.
95 * @rep:displayname Update Routing List
96 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
97 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
98 * @rep:scope public
99 * @rep:lifecycle active
100 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
101 */
102 --
103 -- {End Of Comments}
104 --
105 procedure update_routing_list
106 (
107 p_validate in boolean default false
108 ,p_routing_list_id in number
109 ,p_routing_list_name in varchar2 default hr_api.g_varchar2
110 ,p_enable_flag in varchar2 default hr_api.g_varchar2
111 ,p_object_version_number in out nocopy number
112 );
113 --
114 -- ----------------------------------------------------------------------------
115 -- |---------------------------< delete_routing_list >------------------------|
116 -- ----------------------------------------------------------------------------
117 --
118 -- {Start Of Comments}
119 /*#
120 * This API deletes a routing list.
121 *
122 * Alternatively, the routing list can be disabled if it is no longer in use.
123 *
124 * <p><b>Licensing</b><br>
125 * This API is licensed for use with Human Resources.
126 *
127 * <p><b>Prerequisites</b><br>
128 * The routing list that is to be deleted must already exist. It must not have
129 * any routing list members attached. The routing list cannot be deleted if it
130 * is used for routing transactions in a transaction type and the transactions
131 * are pending approval.
132 *
133 * <p><b>Post Success</b><br>
134 * The routing list is successfully deleted from the database.
135 *
136 * <p><b>Post Failure</b><br>
137 * The routing list is not deleted and an error is raised.
138 * @param p_validate If true, then validation alone will be performed and the
139 * database will remain unchanged. If false and all validation checks pass,
140 * then the database will be modified.
141 * @param p_routing_list_id Identifies the routing list to be deleted.
142 * @param p_object_version_number Current version number of the routing list to
143 * be deleted.
144 * @rep:displayname Delete Routing List
145 * @rep:category BUSINESS_ENTITY PQH_POS_CTRL_ROUTING
146 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
147 * @rep:scope public
148 * @rep:lifecycle active
149 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
150 */
151 --
152 -- {End Of Comments}
153 --
154 procedure delete_routing_list
155 (
156 p_validate in boolean default false
157 ,p_routing_list_id in number
158 ,p_object_version_number in out nocopy number
159 );
160 --
161 --
162 end PQH_ROUTING_LISTS_api;
[Home] [Help]