1 PACKAGE Ad_Event_Registry_Pkg AS
2 -- $Header: adevntrgs.pls 120.0 2005/05/25 11:50:30 appldev noship $
3
4 -- Event Types can be the following
5 BOOLEAN_TYPE CONSTANT VARCHAR2(7) := 'BOOLEAN';
6 MULTI_TYPE CONSTANT VARCHAR2(10) := 'MULTISTATE';
7
8 -- Default Event Context
9 DEFAULT_CONTEXT CONSTANT VARCHAR2(4) := 'NONE';
10
11 -- Event Status can be the following values
12 INITIALIZED_STATUS CONSTANT VARCHAR2(11) := 'INITIALIZED';
13 COMPLETED_STATUS CONSTANT VARCHAR2(9) := 'COMPLETED';
14 NOTAPPLICABLE_STATUS CONSTANT VARCHAR2(2) := 'NA';
15
16 -- Maximum workers
17 MAX_ALLOWED_WORKERS CONSTANT NUMBER := 999;
18
19 -- If the event is not define return the following status
20 EVENT_NOT_DEFINED CONSTANT VARCHAR2(17) := 'EVENT_NOT_DEFINED';
21
22 -- Exceptions are declared below
23
24 --
25 -- The following excption is raised by the assert event procedure
26 -- in cases when the event is not complete.
27 --
28 assert_event_EXP EXCEPTION;
29
30 --
31 -- This is a general exception which will be raised for various conditions.
32 --
33 event_error_EXP EXCEPTION;
34
35 PRAGMA EXCEPTION_INIT(assert_event_EXP, -20007);
36 PRAGMA EXCEPTION_INIT(event_error_EXP, -20010);
37
38
39 -- Procedure declarations follows
40 PROCEDURE Initialize_Event(
41 p_Owner IN VARCHAR2,
42 p_Event_Name IN VARCHAR2,
43 p_Module_Name IN VARCHAR2,
44 p_Event_Type IN VARCHAR2 := NULL ,
45 p_Context IN VARCHAR2 := NULL ,
46 p_Version IN NUMBER := NULL ,
47 p_Worker_Id IN NUMBER := NULL ,
48 p_Num_Workers IN NUMBER := NULL ) ;
49
50 PROCEDURE Start_Event(
51 p_Owner IN VARCHAR2,
52 p_Event_Name IN VARCHAR2,
53 p_Context IN VARCHAR2 := NULL );
54
55 PROCEDURE End_Event(
56 p_Owner IN VARCHAR2,
57 p_Event_Name IN VARCHAR2,
58 p_Context IN VARCHAR2 := NULL );
59
60 FUNCTION Is_Event_Done(
61 p_Owner IN VARCHAR2 ,
62 p_Event_Name IN VARCHAR2 ,
63 p_Context IN VARCHAR2 := NULL ,
64 p_Min_Version IN NUMBER := NULL ,
65 p_Specific_Version IN NUMBER := NULL ,
66 p_Worker_Id IN NUMBER := NULL ,
67 p_Num_Workers IN NUMBER := NULL )
68 RETURN BOOLEAN;
69
70 PROCEDURE Assert_Event(
71 p_Owner IN VARCHAR2 ,
72 p_Event_Name IN VARCHAR2 ,
73 p_Context IN VARCHAR2 := NULL ,
74 p_Min_Version IN VARCHAR2 := NULL ,
75 p_Specific_Version IN VARCHAR2 := NULL );
76
77 FUNCTION Check_Min_Completed_Version(
78 p_Owner IN VARCHAR2 ,
79 p_Event_Name IN VARCHAR2 ,
80 p_Min_Completed_Version IN NUMBER ,
81 p_Context IN VARCHAR2 := NULL )
82 RETURN BOOLEAN ;
83
84 FUNCTION Get_Event_Status(
85 p_Owner IN VARCHAR2 ,
86 p_Event_Name IN VARCHAR2 ,
87 p_Context IN VARCHAR2 := NULL ,
88 p_Min_Version IN NUMBER := NULL ,
89 p_Specific_Version IN NUMBER := NULL )
90 RETURN VARCHAR2;
91
92 PROCEDURE Set_Event_Status(
93 p_Owner IN VARCHAR2,
94 p_Event_Name IN VARCHAR2,
95 p_Status IN VARCHAR2,
96 p_Context IN VARCHAR2 := NULL );
97
98 PROCEDURE Reset_Event(
99 p_Owner IN VARCHAR2 ,
100 p_Event_Name IN VARCHAR2 ,
101 p_Module_Name IN VARCHAR2 ,
102 p_Context IN VARCHAR2 := NULL );
103
104 PROCEDURE Set_Event_As_Done(
105 p_Owner IN VARCHAR2 ,
106 p_Event_Name IN VARCHAR2 ,
107 p_Module_Name IN VARCHAR2 ,
108 p_Context IN VARCHAR2 := NULL ,
109 p_Event_Type IN VARCHAR2 := NULL ,
110 p_Version IN NUMBER := NULL ,
111 p_Worker_Id IN NUMBER := NULL ,
112 p_Num_Workers IN NUMBER := NULL );
113 -----------
114
115 END Ad_Event_Registry_Pkg;
[Home] [Help]