1 Package hxc_time_source_api AUTHID CURRENT_USER as
2 /* $Header: hxchtsapi.pkh 120.1 2005/10/02 02:06:59 aroussel $ */
3 /*#
4 * This package contains Time Source APIs.
5 * @rep:scope public
6 * @rep:product hxt
7 * @rep:displayname Time Source
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |----------------------------< create_time_source >------------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This package creates Time Source.
17 *
18 * This API creates details of applications or devices that are registered to
19 * deposit data into the Time Store.
20 *
21 * <p><b>Licensing</b><br>
22 * This API is licensed for use with Time and Labor.
23 *
24 * <p><b>Prerequisites</b><br>
25 * No known prerequisites.
26 *
27 * <p><b>Post Success</b><br>
28 * The Time Source will be successfully inserted into the database.
29 *
30 * <p><b>Post Failure</b><br>
31 * The Time Source will not be inserted and an application error will be
32 * raised.
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_time_source_id Primary Key from sequence.
37 * @param p_object_version_number If P_VALIDATE is false, then the value is set
38 * to the version number of the created Time Source. If P_VALIDATE is true,
39 * then the value will be null.
40 * @param p_name Name of Time Source.
41 * @rep:displayname Create Time Source
42 * @rep:category BUSINESS_ENTITY HXC_TIME_INPUT_SOURCE
43 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
44 * @rep:scope public
45 * @rep:lifecycle active
46 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
47 */
48 --
49 -- {End Of Comments}
50 --
51 procedure create_time_source
52 (p_validate in boolean default false
53 ,p_time_source_id in out nocopy hxc_time_sources.time_source_id%TYPE
54 ,p_object_version_number in out nocopy hxc_time_sources.object_version_number%TYPE
55 ,p_name in varchar2
56 );
57 --
58 -- ----------------------------------------------------------------------------
59 -- |----------------------------< update_time_source >------------------------|
60 -- ----------------------------------------------------------------------------
61 --
62 -- {Start Of Comments}
63 /*#
64 * This API updates an existing Time Source with a given name and application.
65 *
66 * This API updates DATA_APPROVAL_RULE.
67 *
68 * <p><b>Licensing</b><br>
69 * This API is licensed for use with Time and Labor.
70 *
71 * <p><b>Prerequisites</b><br>
72 * The Time Source must exist.
73 *
74 * <p><b>Post Success</b><br>
75 * The Time Source will be updated successfully in the database.
76 *
77 * <p><b>Post Failure</b><br>
78 * The Time Source will not be updated and an application error will be raised.
79 * @param p_validate If true, then validation alone will be performed and the
80 * database will remain unchanged. If false and all validation checks pass,
81 * then the database will be modified.
82 * @param p_time_source_id Primary Key from sequence.
83 * @param p_object_version_number Pass in the current version number of the
84 * Time Source to be updated. When the API completes, if P_VALIDATE is false,
85 * then the value will be set to the new version number of the updated Time
86 * Source. If P_VALIDATE is true, then the value will be set to the same value.
87 * @param p_name Name of Time Source.
88 * @rep:displayname Update Time Source
89 * @rep:category BUSINESS_ENTITY HXC_TIME_INPUT_SOURCE
90 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
91 * @rep:scope public
92 * @rep:lifecycle active
93 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
94 */
95 --
96 -- {End Of Comments}
97 --
98 procedure update_time_source
99 (p_validate in boolean default false
100 ,p_time_source_id in hxc_time_sources.time_source_id%TYPE
101 ,p_object_version_number in out nocopy hxc_time_sources.object_version_number%TYPE
102 ,p_name in hxc_time_sources.name%TYPE
103 );
104 --
105 -- ----------------------------------------------------------------------------
106 -- |----------------------------< delete_time_source >------------------------|
107 -- ----------------------------------------------------------------------------
108 --
109 -- {Start Of Comments}
110 /*#
111 * This API deletes an existing Time Source.
112 *
113 *
114 * <p><b>Licensing</b><br>
115 * This API is licensed for use with Time and Labor.
116 *
117 * <p><b>Prerequisites</b><br>
118 * The Time Source must exist.
119 *
120 * <p><b>Post Success</b><br>
121 * The Time Source will be successfully deleted from the database.
122 *
123 * <p><b>Post Failure</b><br>
124 * The Time Source will not be deleted and an application error will be raised.
125 * @param p_validate If true, then validation alone will be performed and the
126 * database will remain unchanged. If false and all validation checks pass,
127 * then the database will be modified.
128 * @param p_time_source_id Primary Key from sequence.
129 * @param p_object_version_number Current version number of the Time Source to
130 * be deleted.
131 * @rep:displayname Delete Time Source
132 * @rep:category BUSINESS_ENTITY HXC_TIME_INPUT_SOURCE
133 * @rep:category MISC_EXTENSIONS HR_USER_HOOKS
134 * @rep:scope public
135 * @rep:lifecycle active
136 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
137 */
138 --
139 -- {End Of Comments}
140 --
141 procedure delete_time_source
142 (p_validate in boolean default false
143 ,p_time_source_id in hxc_time_sources.time_source_id%TYPE
144 ,p_object_version_number in hxc_time_sources.object_version_number%TYPE
145 );
146 --
147 --
148 END hxc_time_source_api;
[Home] [Help]