1 package ame_api6 as
2 /* $Header: ameeapi6.pkh 120.6 2006/07/27 10:55:38 pvelugul noship $ */
3 /*#
4 * This API package contains ancillary routines.
5 * @rep:scope public
6 * @rep:product AME
7 * @rep:displayname Ancillary Parallel Approvers Process
8 */
9 --
10 -- ----------------------------------------------------------------------------
11 -- |---------------------------< getApprovers >-----------------------|
12 -- ----------------------------------------------------------------------------
13 --
14 -- {Start Of Comments}
15 /*#
16 * This API returns the list of approvers who have acted upon a particular
17 * transaction.
18 *
19 * <p><b>Licensing</b><br>
20 * This API is available for use with any licensed component of the e-business
21 * suite.
22 *
23 * <p><b>Prerequisites</b><br>
24 * None
25 *
26 * <p><b>Post Success</b><br>
27 * The approver list with all the information is returned.
28 *
29 * <p><b>Post Failure</b><br>
30 * The API will raise an error.
31 *
32 * @param applicationidin The fnd_application.application_id value of the
33 * originating application calling the AME API routine.
34 * @param transactiontypein This is a string parameter up to 50 bytes long. It
35 * distinguishes one transaction type from another, within a given originating
36 * application.
37 * @param transactionidin This is a string up to 50 bytes long. It identifies a
38 * transaction within a transaction type. Its value must not contain
39 * white-space characters, and must not be the character representation of a
40 * negative integer.
41 * @param approversOut This is the approversTable defined by ame_util.approversTable2
42 * which gives information regarding all the Approvers who have acted upon a
43 * particular transaction.
44 * @rep:displayname Get Approvers
45 * @rep:category BUSINESS_ENTITY AME_APPROVAL
46 * @rep:lifecycle active
47 * @rep:scope public
48 */
49 --
50 -- {End Of Comments}
51 --
52 procedure getApprovers(applicationIdIn in number,
53 transactionTypeIn in varchar2,
54 transactionIdIn in varchar2,
55 approversOut out nocopy ame_util.approversTable2);
56 --
57 -- ----------------------------------------------------------------------------
58 -- |---------------------------< updateapprovalstatus >-----------------------|
59 -- ----------------------------------------------------------------------------
60 --
61 -- {Start Of Comments}
62 /*#
63 * Updates an approver's status (to the approval_status value in
64 * approverIn); and, if the approval_status value indicates that a
65 * forwarding has occurred, identifies the forwardee. However, if
66 * the approval_status value is ame_util.clearExceptionsStatus, the
67 * procedure clears the transaction's exception log in AME, without
68 * changing any approver's status, regardless of the approver
69 * identified by approverIn.
70 * When a chain-of-authority approver forwards, AME makes the
71 * forwardee also a chain-of-authority approver. Otherwise, the
72 * forwardee has the api_insertion value ame_util.apiInsertion, and
73 * the same authority value as the forwarder.
74 * This api is typically used to update the AME Approvals History region,
75 * with the notification id and user comments through notification record.
76 * AME Approvals History region can be used to override default workflow
77 * action history region to display details of parallel approval process.
78 *
79 * <p><b>Licensing</b><br>
80 * This API is available for use with any licensed component of the e-business
81 * suite.
82 *
83 * <p><b>Prerequisites</b><br>
84 * None
85 *
86 * <p><b>Post Success</b><br>
87 * The status of the given approver will be updated with the specified status.
88 *
89 * <p><b>Post Failure</b><br>
90 * The API will raise an error.
91 *
92 * @param applicationidin The fnd_application.application_id value of the
93 * originating application calling the AME API routine.
94 * @param transactiontypein This is a string parameter up to 50 bytes long. It
95 * distinguishes one transaction type from another, within a given originating
96 * application. It can be null, but you must always pass its value explicitly.
97 * @param transactionidin This is a string up to 50 bytes long. It identifies a
98 * transaction within a transaction type. Its value must not contain
99 * white-space characters, and must not be the character representation of a
100 * negative integer.
101 * @param approverIn This is the approverRecord defined by ame_util.approverRecord2
102 * which gives information regarding the Approver.
103 * @param notificationIn This is the notificationRecord defined by
104 * ame_util2.notificationRecord which is used to pass the notification id and user comments.
105 * @param forwardeeIn Approver record of the forwardee if forwarding has been done.
106 * @param updateItemIn This flag determines whether the status of the repeated
107 * occurrences of the approvers in the same item have to be updated or not.
108 * @rep:displayname Update Approval Status
109 * @rep:category BUSINESS_ENTITY AME_APPROVAL
110 * @rep:lifecycle active
111 * @rep:scope public
112 */
113 --
114 -- {End Of Comments}
115 --
116 procedure updateApprovalStatus(applicationIdIn in number,
117 transactionTypeIn in varchar2,
118 transactionIdIn in varchar2,
119 approverIn in ame_util.approverRecord2,
120 notificationIn in ame_util2.notificationRecord
121 default ame_util2.emptyNotificationRecord,
122 forwardeeIn in ame_util.approverRecord2 default
123 ame_util.emptyApproverRecord2,
124 updateItemIn in boolean default false) ;
125
126 --
127 -- ----------------------------------------------------------------------------
128 -- |--------------------------< updateapprovalstatus2 >-----------------------|
129 -- ----------------------------------------------------------------------------
130 --
131 -- {Start Of Comments}
132 /*#
133 * This is a wrapper for updateApprovalStatus that lets you
134 * identify an approver by role name, rather than passing
135 * an entire ame_util.approverRecord to the API.
136 * This api is typically used to update the AME Approvals History region, with
137 * the notification id and user comments through notification record.AME
138 * Approvals History region can be used to override default workflow action
139 * history region to display details of parallel approval process.
140 *
141 * <p><b>Licensing</b><br>
142 * This API is available for use with any licensed component of the e-business
143 * suite.
144 *
145 * <p><b>Prerequisites</b><br>
146 * None
147 *
148 * <p><b>Post Success</b><br>
149 * The status of the given approver will be updated with the specified status.
150 *
151 * <p><b>Post Failure</b><br>
152 * The API will raise an error.
153 *
154 * @param applicationidin The fnd_application.application_id value of the
155 * originating application calling the AME API routine.
156 * @param transactiontypein This is a string parameter up to 50 bytes long. It
157 * distinguishes one transaction type from another, within a given originating
158 * application. It can be null, but you must always pass its value explicitly.
159 * @param transactionidin This is a string up to 50 bytes long. It identifies a
160 * transaction within a transaction type. Its value must not contain
161 * white-space characters, and must not be the character representation of a
162 * negative integer.
163 * @param approvalStatusIn This specifies the status to be updated.
164 * @param approverNameIn This is the workflow role name of the approver.
165 * @param itemClassIn This specifies the Item Class for which the approver status
166 * has to be updated.
167 * @param itemIdIn This specifies the Item id of the item class for which the
168 * approver status has to be updated.
169 * @param actionTypeIdIn This specifies the type of the approver.
170 * @param groupOrChainIdIn This specifies the id of the Group or the chain
171 * to which the approver belongs to.
172 * @param occurrenceIn Approver's Occurrence in the group or chain.
173 * @param notificationIn This is the notificationRecord defined by
174 * ame_util2.notificationRecord which is used to pass the notification id and user comments.
175 * @param forwardeeIn Approver record of the forwardee if forwarding has been done.
176 * @param updateItemIn This flag determines whether the status of the repeated
177 * occurrences of the approvers in the same item have to be updated or not.
178 * @rep:displayname Update Approval Status 2
179 * @rep:category BUSINESS_ENTITY AME_APPROVAL
180 * @rep:lifecycle active
181 * @rep:scope public
182 */
183 --
184 -- {End Of Comments}
185 --
186 procedure updateApprovalStatus2(applicationIdIn in number,
187 transactionTypeIn in varchar2,
188 transactionIdIn in varchar2,
189 approvalStatusIn in varchar2,
190 approverNameIn in varchar2,
191 itemClassIn in varchar2 default null,
192 itemIdIn in varchar2 default null,
193 actionTypeIdIn in number default null,
194 groupOrChainIdIn in number default null,
195 occurrenceIn in number default null,
196 notificationIn in ame_util2.notificationRecord
197 default ame_util2.emptyNotificationRecord,
198 forwardeeIn in ame_util.approverRecord2
199 default ame_util.emptyApproverRecord2,
200 updateItemIn in boolean default false);
201 end ame_api6;
[Home] [Help]