1 Package ame_approver_type_api as
2 /* $Header: amaptapi.pkh 120.3 2006/09/28 14:03:55 avarri noship $ */
3 /*#
4 * This package contains AME approver type APIs.
5 * @rep:scope public
6 * @rep:product AME
7 * @rep:displayname Approver Type
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |-------------------------< create_ame_approver_type >---------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API adds a new approver type.
17 *
18 * <p><b>Licensing</b><br>
19 * This API is available for use with any licensed component of the e-business
20 * suite.
21 *
22 * <p><b>Prerequisites</b><br>
23 * The Approver Type should have an entry in wf_roles.
24 *
25 * <p><b>Post Success</b><br>
26 * Approver type is added successfully. approver_type_id,
27 * object_version_number, start_date and end_date are set for the
28 * added approver type.
29 *
30 * <p><b>Post Failure</b><br>
31 * The approver type is not added and an error is raised.
32 *
33 * @param p_validate If true, then validation alone will be performed and the
34 * database will remain unchanged. If false and all validation checks pass,
35 * then the database will be modified.
36 * @param p_orig_system This is the unique approver type name.
37 * @param p_approver_type_id If p_validate is false, then this uniquely
38 * identifies the added approver type. If p_validate is true, then it is set
39 * to null.
40 * @param p_object_version_number If p_validate is false, then it is set to
41 * version number of the added approver type. If p_validate is true, then it
42 * is set to null.
43 * @param p_start_date It is the date from which the added approver type is
44 * effective.If p_validate is false, then set to the start date
45 * of the added approver type. If p_validate is true, then set to null.
46 * @param p_end_date It is the date up to, which the added approver type
47 * is effective. If p_validate is false, then it is set to 31-Dec-4712.
48 * If p_validate is true, then it is set to null.
49 * @rep:displayname Create Ame Approver Type
50 * @rep:category BUSINESS_ENTITY AME_APPROVER_TYPE
51 * @rep:lifecycle active
52 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
53 * @rep:scope public
54 */
55 --
56 -- {End Of Comments}
57 --
58 procedure create_ame_approver_type
59 (p_validate in boolean default false
60 ,p_orig_system in varchar2
61 ,p_approver_type_id out nocopy number
62 ,p_object_version_number out nocopy number
63 ,p_start_date out nocopy date
64 ,p_end_date out nocopy date
65 );
66 --
67 -- ----------------------------------------------------------------------------
68 -- |-------------------------< delete_ame_approver_type >---------------------|
69 -- ----------------------------------------------------------------------------
70 --
71 -- {Start Of Comments}
72 /*#
73 * This API deletes the approver type.
74 *
75 * <p><b>Licensing</b><br>
76 * This API is available for use with any licensed component of the e-business
77 * suite.
78 *
79 * <p><b>Prerequisites</b><br>
80 * Approver Type Id should be valid.
81 *
82 * <p><b>Post Success</b><br>
83 * Deletes the approver type successfully.
84 *
85 * <p><b>Post Failure</b><br>
86 * The approver type is not deleted and an error is raised.
87 *
88 * @param p_validate If true, then validation alone will be performed and the
89 * database will remain unchanged. If false and all validation checks pass,
90 * then the database will be modified.
91 * @param p_approver_type_id This uniquely identifies the approver type
92 * to be deleted.
93 * @param p_object_version_number Pass in the current version number of
94 * the approver type to be deleted. When the API completes if p_validate is
95 * false, it will be set to the new version number of the deleted
96 * approver type. If p_validate is true, will be set to the same value which
97 * was passed in.
98 * @param p_start_date If p_validate is false, it is set to the date from
99 * which the deleted approver type was effective. If p_validate is true,
100 * it is set to the same date which was passed in.
101 * @param p_end_date If p_validate is false, it is set to present date.
102 * If p_validate is true, it is set to the same date which was passed in.
103 * @rep:displayname Delete Ame Approver Type
104 * @rep:category BUSINESS_ENTITY AME_APPROVER_TYPE
105 * @rep:lifecycle active
106 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
107 * @rep:scope public
108 */
109 --
110 -- {End Of Comments}
111 --
112 procedure delete_ame_approver_type
113 (p_validate in boolean default false
114 ,p_approver_type_id in number
115 ,p_object_version_number in out nocopy number
116 ,p_start_date out nocopy date
117 ,p_end_date out nocopy date
118 );
119 --
120 end ame_approver_type_api;
[Home] [Help]