1 PACKAGE wf_item_definition AUTHID CURRENT_USER AS
2 /* $Header: wfdefs.pls 115.18 2002/12/03 01:12:21 dlam ship $ */
3
4 /*===========================================================================
5 PACKAGE NAME: wf_item_definition
6
7 DESCRIPTION:
8
9 OWNER: GKELLNER
10
11 ============================================================================*/
12
13 /*===========================================================================
14 PROCEDURE NAME: find_item_type
15
16 DESCRIPTION:
17 Main Find View drawing routine. This is the
18 main entry point into the Item Type
19 Definition View. This view has two attributes: The
20 Item Type List shows all the Items Types that
21 are currently stored in the Workflow database
22 repository. The effective date allows you to
23 chose which date you would like the view to be
24 effective for. Since activities can
25 have multiple versions and have effective date ranges
26 for each of those version we need a specific value
27 to determine which of those versions is requested.
28 Once the user clicks on the Find buttton from
29 this view, the draw_item_type function takes over to
30 create the Item Type Definition.
31
32 PARAMETERS:
33
34 ============================================================================*/
35 PROCEDURE find_item_type;
36
37 /*===========================================================================
38 PROCEDURE NAME: draw_item_type
39
40 DESCRIPTION: Main routine that will create a three framed
41 view that shows the complete definition of an
42 item type. The top frame is the view header.
43 It show the title of the view along with
44 controls to return to the find window, return
45 to the main menu or exit the system. It then
46 displays the Item Type Summary and Item Type
47 Details in two separate frame below the header frame.
48 The left frame consists of the hierarchical summary
49 of the Item Type Definition showing all display
50 names for attributes, processes, notifications,
51 functions, etc. The right frame consists of
52 a complete listing of all the objects and their
53 associated properties for the given item type.
54
55
56 The frames are constructed in the following manner:
57 ______________________
58 | |
59 | HEADER |
60 |---------------------|
61 | | |
62 | | |
63 | SUMMARY | DETAILS |
64 | | |
65 | | |
66 |---------------------|
67
68
69 PARAMETERS:
70
71 p_item_type IN Internal name of the item type that was selected
72 in the find window.
73
74 p_effective_date IN
75 The requested effective date. Since activities can
76 have multiple versions and have effective date ranges
77 for each of those version we need a specific value
78 to determine which of those versions is requested.
79
80 ============================================================================*/
81 PROCEDURE draw_item_type(
82 p_item_type VARCHAR2 DEFAULT NULL,
83 p_effective_date VARCHAR2 DEFAULT NULL);
84
85
86
87 /*===========================================================================
88 PROCEDURE NAME: draw_item_summary
89
90 DESCRIPTION: Draws a hierarchical summary of the Item
91 Type Definition showing all display names for
92 attributes, processes, notifications, functions,
93 etc. The following is an example of the output:
94
95 Workflow Requisition Approval Demonstration
96 Attributes
97 Forward From Display Name
98 Forward From Username
99 Forward To Display Name
100 Forward To Username
101 Processes
102 Notify Approver
103 Requisition Approval
104 Notifications
105 Notifify Requestor of Approval
106 Notify Requestor No Approver Available
107 Reminder-Approval Needed
108 Functions
109 Approve Requisition
110 Verify Authority
111 Messages
112 Requisition Approval Required
113 Message Attributes
114 Requisition Amount
115 Action
116 etc...
117
118 PARAMETERS:
119
120 p_item_type IN Internal name of the item type that was selected
121 in the find window.
122
123 p_effective_date IN
124 The requested effective date. Since activities can
125 have multiple versions and have effective date ranges
126 for each of those version we need a specific value
127 to determine which of those versions is requested.
128
129 ============================================================================*/
130 PROCEDURE draw_item_summary(
131 p_item_type VARCHAR2 DEFAULT NULL,
132 p_effective_date VARCHAR2 DEFAULT NULL);
133
134
135 /*===========================================================================
136 PROCEDURE NAME: draw_item_details
137
138 DESCRIPTION: Draws a complete listing of all the objects and their
139 associated properties for the given item type.
140 The following is an example of the output:
141
142
143 Item Type Details
144 ----------------------------------------------------------------------------
145 Item Type Name Workflow Requisition Approval Demonstration
146 Internal Name WFREQAPP
147 Description
148 Selector WF_REQDEMO.SELECTOR
149 Read Role
150 Write Role
151 Execute Role
152 Customization Level 0
153 Protection Level 100
154
155 Attribute Details
156 ----------------------------------------------------------------------------
157 Attribute Name Forward From Display Name
158 Internal Name FORWARD_FROM_DISPLAY_NAME
159 Description Name of the person that the requisition is forwarded
160 from
161 Attribute Type VARCHAR2
162 Format
163 Default
164 Customization Level 0
165 Protection Level 100
166 etc...
167
168 PARAMETERS:
169
170 p_item_type IN Internal name of the item type that was selected
171 in the find window.
172
173 p_effective_date IN
174 The requested effective date. Since activities can
175 have multiple versions and have effective date ranges
176 for each of those version we need a specific value
177 to determine which of those versions is requested.
178
179 ============================================================================*/
180 PROCEDURE draw_item_details(
181 p_item_type VARCHAR2 DEFAULT NULL,
182 p_effective_date VARCHAR2 DEFAULT NULL);
183
184 /*===========================================================================
185 PROCEDURE NAME: draw_header
186
187 DESCRIPTION:
188 Draws the top frame of the Item Definition View.
189 It show the title of the view along with
190 controls to return to the find window, return
191 to the main menu or exit the system.
192
193 PARAMETERS:
194
195 p_item_type IN Internal name of the item type that was selected
196 in the find window.
197
198 p_effective_date IN
199 The requested effective date. Since activities can
200 have multiple versions and have effective date ranges
201 for each of those version we need a specific value
202 to determine which of those versions is requested.
203
204 p_caller IN Tells the procedure which title to display (FIND, DISPLAY)
205
206
207 ============================================================================*/
208 PROCEDURE draw_header (
209 p_item_type VARCHAR2 DEFAULT NULL,
210 p_effective_date VARCHAR2 DEFAULT NULL,
211 p_caller VARCHAR2 DEFAULT NULL);
212
213
214 /*===========================================================================
215 PROCEDURE NAME: error
216
217 DESCRIPTION:
218 Print a page with an error message.
219 Errors are retrieved from these sources in order:
220 1. wf_core errors
221 2. Oracle errors
222 3. Unspecified INTERNAL error
223
224 PARAMETERS:
225
226
227 ============================================================================*/
228 PROCEDURE error;
229
230 /*===========================================================================
231 PROCEDURE NAME: draw_error
232
233 DESCRIPTION: Draws the bottom frame for the error message if an
234 invalid date has been entered
235
236 PARAMETERS:
237 p_effective_date IN
238 Invalid date user entered
239
240 pexpected_format IN
241 Format that the window expects
242 ============================================================================*/
243 PROCEDURE draw_error (p_effective_date IN VARCHAR2 DEFAULT NULL,
244 p_expected_format IN VARCHAR2 DEFAULT NULL);
245
246
247 /*===========================================================================
248 PROCEDURE NAME: fetch_item_definition_url
249
250 DESCRIPTION: Fetches the url address to initiate the
251 Item Definition View
252
253 PARAMETERS:
254 p_item_definition_url OUT
255 Returns the name of the url to initiate the
256 Item Definition View
257
258 ============================================================================*/
259 PROCEDURE fetch_item_definition_url (p_item_definition_url OUT NOCOPY VARCHAR2);
260
261
262
263 END wf_item_definition;
[Home] [Help]