1 Package AME_CONFIG_VAR_API as
2 /* $Header: amcfvapi.pkh 120.3 2006/12/23 09:58:54 avarri noship $ */
3 /*#
4 * This package contains AME configuration variable APIs.
5 * @rep:scope public
6 * @rep:product AME
7 * @rep:displayname Configuration Variable
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |--------------------< update_ame_config_variable >------------------------|
12 -- ----------------------------------------------------------------------------
13 -- {Start Of Comments}
14 /*#
15 * This API updates the configuration variable for the specified
16 * transaction 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 transaction type should be valid.
24 *
25 * <p><b>Post Success</b><br>
26 * Configuration variable is updated successfully.
27 *
28 * <p><b>Post Failure</b><br>
29 * The configuration variable is not updated and error is raised.
30 *
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_APPLICATION_ID This uniquely identifies the transaction type for
35 * which configuration variable is to be updated.
36 * @param P_VARIABLE_NAME Name of the configuration variable.
37 * @param P_VARIABLE_VALUE The value for the configuration variable.
38 * @param P_OBJECT_VERSION_NUMBER Pass in the current version number of the
39 * configuration variable to be updated. When the API completes, if p_validate
40 * is false, it will be set to the new version number of the updated
41 * configuration variable. If p_validate is true, will be set to the same value
42 * which was passed in.
43 * @param P_START_DATE Date from which the updated configuration variable is
44 * effective, set to p_effective_date.
45 * @param P_END_DATE It is the date up to, which the configuration variable
46 * is effective. If p_validate is false, then it is set to 31-Dec-4712.
47 * If p_validate is true, then it is set to null.
48 * @rep:displayname Update Ame configuration Variable
49 * @rep:category BUSINESS_ENTITY AME_CONFIG_VAR
50 * @rep:lifecycle active
51 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
52 * @rep:scope public
53 */
54 --
55 -- {End Of Comments}
56 --
57 procedure update_ame_config_variable
58 (p_validate in boolean default false
59 ,p_application_id in number
60 ,p_variable_name in varchar2
61 ,p_variable_value in varchar2 default hr_api.g_varchar2
62 ,p_object_version_number in out nocopy number
63 ,p_start_date out nocopy date
64 ,p_end_date out nocopy date
65 );
66 --
67 -- ----------------------------------------------------------------------------
68 -- |-----------------< delete_ame_config_variable >---------------------------|
69 -- ----------------------------------------------------------------------------
70 -- {Start Of Comments}
71 /*#
72 * This API deletes the configuration variable for the specified
73 * transaction 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 * The transaction type should be valid.
81 *
82 * <p><b>Post Success</b><br>
83 * The configuration variable is deleted from the given transaction type.
84 *
85 * <p><b>Post Failure</b><br>
86 * The configuration variable is not deleted and 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_APPLICATION_ID This uniquely identifies the transaction type for
92 * which configuration variable is to be deleted.
93 * @param P_VARIABLE_NAME Name of the configuration variable.
94 * @param P_OBJECT_VERSION_NUMBER Pass in the current version number of the
95 * configuration variable to be deleted. When the API completes, if p_validate
96 * is false, it will be set to the new version number of the deleted
97 * configuration variable. If p_validate is true, will be set to the same value
98 * which was passed in.
99 * @param P_START_DATE If p_validate is false, it is set to the date from
100 * which the deleted configuration variable was effective. If p_validate
101 * is true, it is set to the same date which was passed in.
102 * @param P_END_DATE If p_validate is false, it is set to present date.
103 * If p_validate is true, it is set to the same date which was passed in.
104 * @rep:displayname Deletes Ame configuration variable
105 * @rep:category BUSINESS_ENTITY AME_CONFIG_VAR
106 * @rep:lifecycle active
107 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
108 * @rep:scope public
109 */
110 --
111 -- {End Of Comments}
112 --
113 procedure delete_ame_config_variable
114 (p_validate in boolean default false
115 ,p_application_id in number
116 ,p_variable_name in varchar2
117 ,p_object_version_number in out nocopy number
118 ,p_start_date out nocopy date
119 ,p_end_date out nocopy date
120 );
121 --
122 end AME_CONFIG_VAR_API;
[Home] [Help]