1 Package hr_batch_message_line_api as
2 /* $Header: hrabmapi.pkh 120.1 2005/10/02 01:58:41 aroussel $ */
3 /*#
4 * This package contains APIs that will maintain line messages information for
5 * a batch.
6 * @rep:scope public
7 * @rep:product per
8 * @rep:displayname Batch Message Line
9 */
10 --
11 -- ----------------------------------------------------------------------------
12 -- |---------------------------< create_message_line >------------------------|
13 -- ----------------------------------------------------------------------------
14 --
15 -- {Start Of Comments}
16 /*#
17 * This API creates a message line for a particular batch run.
18 *
19 *
20 * <p><b>Licensing</b><br>
21 * This API is licensed for use with all products in the HRMS Product Family.
22 *
23 * <p><b>Prerequisites</b><br>
24 * None.
25 *
26 * <p><b>Post Success</b><br>
27 * The message line will be successfully inserted into the database.
28 *
29 * <p><b>Post Failure</b><br>
30 * The message line will not be created and an error will be 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_batch_run_number Identifies the batch run number for the message
35 * line(s) to be created.
36 * @param p_api_name Identifies the API for which the message is being created.
37 * @param p_status Determines if the message is being created for a sucessful
38 * or failure API. Value must be 'F' or 'S'.
39 * @param p_error_number Identifies the Oracle error number (SQLCODE).
40 * @param p_error_message Identifes the Oracle error message text (SQLERRM).
41 * @param p_extended_error_message Identifes any further error text.
42 * @param p_source_row_information Identifes the source row for which the
43 * message was generated.
44 * @param p_line_id If p_validate is false, this uniquely identifies the
45 * message line created.
46 * @rep:displayname Create Message Line
47 * @rep:category BUSINESS_ENTITY HR_MESSAGE_LINE
48 * @rep:scope public
49 * @rep:lifecycle active
50 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
51 */
52 --
53 -- {End Of Comments}
54 --
55 procedure create_message_line
56 (p_validate in boolean default false
57 ,p_batch_run_number in number
58 ,p_api_name in varchar2
59 ,p_status in varchar2
60 ,p_error_number in number default null
61 ,p_error_message in varchar2 default null
62 ,p_extended_error_message in varchar2 default null
63 ,p_source_row_information in varchar2 default null
64 ,p_line_id out nocopy number);
65 --
66 -- ----------------------------------------------------------------------------
67 -- |---------------------------< delete_message_line >------------------------|
68 -- ----------------------------------------------------------------------------
69 --
70 -- {Start Of Comments}
71 /*#
72 * This API deletes a message line for a particular batch run.
73 *
74 *
75 * <p><b>Licensing</b><br>
76 * This API is licensed for use with all products in the HRMS Product Family.
77 *
78 * <p><b>Prerequisites</b><br>
79 * None.
80 *
81 * <p><b>Post Success</b><br>
82 * The message line will be successfully deleted from the database.
83 *
84 * <p><b>Post Failure</b><br>
85 * The API does not delete any message line and raises an error.
86 * @param p_validate If true, then validation alone will be performed and the
87 * database will remain unchanged. If false and all validation checks pass,
88 * then the database will be modified.
89 * @param p_line_id Identifies the batch line to delete.
90 * @rep:displayname Delete Message Line
91 * @rep:category BUSINESS_ENTITY HR_MESSAGE_LINE
92 * @rep:scope public
93 * @rep:lifecycle active
94 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
95 */
96 --
97 -- {End Of Comments}
98 --
99 procedure delete_message_line
100 (p_validate in boolean default false
101 ,p_line_id in number);
102 --
103 -- ----------------------------------------------------------------------------
104 -- |----------------------------< delete_batch_lines >------------------------|
105 -- ----------------------------------------------------------------------------
106 --
107 -- {Start Of Comments}
108 /*#
109 * This API deletes batch message line(s) for a particular batch run number.
110 *
111 *
112 * <p><b>Licensing</b><br>
113 * This API is licensed for use with all products in the HRMS Product Family.
114 *
115 * <p><b>Prerequisites</b><br>
116 * None.
117 *
118 * <p><b>Post Success</b><br>
119 * The API batch message line(s) will be deleted for the specified batch run
120 * number.
121 *
122 * <p><b>Post Failure</b><br>
123 * The API does not delete any message line and raises an error.
124 * @param p_validate If true, then validation alone will be performed and the
125 * database will remain unchanged. If false and all validation checks pass,
126 * then the database will be modified.
127 * @param p_batch_run_number Identifies the batch run number for the message
128 * line(s) to be deleted.
129 * @rep:displayname Delete Batch Lines
130 * @rep:category BUSINESS_ENTITY HR_MESSAGE_LINE
131 * @rep:scope public
132 * @rep:lifecycle active
133 * @rep:ihelp PER/@scalapi APIs in Oracle HRMS
134 */
135 --
136 -- {End Of Comments}
137 --
138 procedure delete_batch_lines
139 (p_validate in boolean default false
140 ,p_batch_run_number in number);
141 end hr_batch_message_line_api;
[Home] [Help]