DBA Data[Home] [Help]

PACKAGE: SYS.DBMS_HM

Source


1 PACKAGE dbms_hm AS
2 
3 -- DE-HEAD  <- tell SED where to cut when generating fixed package
4 
5 --*****************************************************************************
6 -- Package Public Exceptions
7 --*****************************************************************************
8 
9 -- bkuchibh TODO: change number, add more, where are these defined?
10 internal_error    EXCEPTION;
11 PRAGMA exception_init(internal_error, -111);
12 internal_error_num NUMBER := -111;
13 
14 --*****************************************************************************
15 -- Package Public Types
16 --*****************************************************************************
17 
18 --*****************************************************************************
19 -- HM RUN CHECK Implementation
20 --*****************************************************************************
21 
22 -------------------------------------------------------------------------------
23 --
24 -- PROCEDURE     run_check
25 --
26 -- Description:  Runs a given check
27 --
28 -- Parameters:   check_name - check name
29 --               run_name   - run name to uniquely identify this run
30 --               timeout    - timeout for the given run (in seconds)
31 --               input_params   - text format of input parameters
32 --
33 -------------------------------------------------------------------------------
34 PROCEDURE run_check( check_name    IN varchar2,
35                      run_name      IN varchar2 := null,
36                      timeout       IN number := null,
37                      input_params  IN varchar2 := null);
38 
39 ------------------------------------------------------------------------------
40 --
41 -- FUNCTION      get_run_report
42 --
43 -- Description:  Gets the report for a given run name
44 --
45 -- Parameters:   run_name  -  run name
46 --               report_type      -  type of report (TEXT, HTML, XML)
47 --               report_level     -  Level of report (BASIC, DETAILED)
48 --
49 -------------------------------------------------------------------------------
50 
51 FUNCTION get_run_report(run_name IN varchar2,
52                         report_type IN varchar2 := 'TEXT',
53                         report_level IN varchar2 := 'BASIC' ) return clob;
54 
55 -------------------------------------------------------------------------------
56 --
57 -- PROCEDURE     create_schema
58 --
59 -- Description:  creates HM schema in ADR
60 --
61 -- Parameters:
62 --
63 -------------------------------------------------------------------------------
64 PROCEDURE create_schema;
65 
66 -------------------------------------------------------------------------------
67 --
68 -- PROCEDURE     drop_schema
69 --
70 -- Description:  drops HM schema
71 --
72 -- Parameters:  force   -
73 --
74 -------------------------------------------------------------------------------
75 PROCEDURE drop_schema(force IN boolean := FALSE);
76 -------------------------------------------------------------------------------
77 
78 --*****************************************************************************
79 -- HM - DDE User Action  Implementation
80 --*****************************************************************************
81 
82 -------------------------------------------------------------------------------
83 --
84 -- FUNCTION      run_dde_action
85 --
86 -- Description:  Runs a DDE (user) action for HM checks.
87 --
88 -- Parameters:   incident_id    -   Incident ID
89 --               directory_name -   directory info(should be NULL for HM)
90 --               check_name     -   check to be executed
91 --               run_name       -   run name given for the run/action(NULL??)
92 --               timeout        -   timeout for the given run (in seconds)
93 --               params         -   text format of input parameters
94 --
95 -------------------------------------------------------------------------------
96 FUNCTION run_dde_action( incident_id         IN number,
97                          directory_name      IN varchar2,
98                          check_name          IN varchar2,
99                          run_name            IN varchar2,
100                          timeout             IN number,
101                          params              IN varchar2) return boolean;
102 
103 pragma TIMESTAMP('2006-04-13:12:00:00');
104 
105 -------------------------------------------------------------------------------
106 --
107 -- PROCEDURE     create_offline_dictionary
108 --
109 -- Description:  creates LogMiner offline dictionary in ADR
110 --
111 -- Parameters:
112 --
113 -------------------------------------------------------------------------------
114 PROCEDURE create_offline_dictionary;
115 
116 END;
117 
118 -- CUT_HERE    <- tell sed where to chop off the rest