1 PACKAGE FND_OAM_DSCRAM_RUNS_PKG AUTHID CURRENT_USER as
2 /* $Header: AFOAMDSRUNS.pls 120.2 2005/11/07 19:43 ilawler noship $ */
3
4 ------------
5 -- Constants
6 ------------
7
8 ---------------------------------
9 -- Public Procedures/Functions --
10 ---------------------------------
11
12 -- Accessor function to obtain parts of the run state
13 -- Invariants:
14 -- State must have been initialized by a prior call to ASSIGN
15 -- Parameters:
16 -- None
17 -- Returns:
18 -- The numerical ID of the run to which this session is assigned.
19 -- Exceptions:
20 -- If the run state isn't initialized yet,
21 -- a NO_DATA_FOUND exception is thrown.
22 FUNCTION GET_RUN_ID
23 RETURN NUMBER;
24
25 -- Accessor function to obtain parts of the run state
26 -- Invariants:
27 -- State must have been initialized by a prior call to ASSIGN
28 -- Parameters:
29 -- None
30 -- Returns:
31 -- The numerical stat ID of the stats row for this run's last execution.
32 -- Exceptions:
33 -- If the run state isn't initialized yet,
34 -- a NO_DATA_FOUND exception is thrown.
35 FUNCTION GET_RUN_STAT_ID
36 RETURN NUMBER;
37
38 -- Accessor function to obtain parts of the run state
39 -- Invariants:
40 -- State must have been initialized by a prior call to ASSIGN
41 -- Parameters:
42 -- None
43 -- Returns:
44 -- The number of seconds before an entity should be revalidated
45 -- from source.
46 -- Exceptions:
47 -- If the run state isn't initialized yet,
48 -- a NO_DATA_FOUND exception is thrown.
49 FUNCTION GET_VALID_CHECK_INTERVAL
50 RETURN NUMBER;
51
52 -- Accessor function to obtain parts of the run state
53 -- Invariants:
54 -- State must have been initialized by a prior call to ASSIGN
55 -- Parameters:
56 -- None
57 -- Returns:
58 -- A string representing our mode, controls whether the physical work
59 -- is committed or rolled back.
60 -- Exceptions:
61 -- If the run state isn't initialized yet,
62 -- a NO_DATA_FOUND exception is thrown.
63 FUNCTION GET_RUN_MODE
64 RETURN VARCHAR2;
65
66 -- Accessor function to obtain parts of the run state
67 -- Invariants:
68 -- State must have been initialized by a prior call to ASSIGN
69 -- Parameters:
70 -- px_arg_context: the variable receiving the run arg_context
71 -- Exceptions:
72 -- If the run state isn't initialized yet,
73 -- a NO_DATA_FOUND exception is thrown.
74 PROCEDURE GET_RUN_ARG_CONTEXT(px_arg_context IN OUT NOCOPY FND_OAM_DSCRAM_ARGS_PKG.arg_context);
75
76 -- Accessor function to obtain parts of the run state
77 -- Invariants:
78 -- State must have been initialized by a prior call to ASSIGN
79 -- Parameters:
80 -- p_arg_context: the new run arg_context
81 -- Exceptions:
82 -- If the run state isn't initialized yet,
83 -- a NO_DATA_FOUND exception is thrown.
84 PROCEDURE SET_RUN_ARG_CONTEXT(p_arg_context IN FND_OAM_DSCRAM_ARGS_PKG.arg_context);
85
86 -- After a worker has been assigned to a worker and a bundle, this is called by the
87 -- bundle's assign to create the arg context for the run. This is placed here instead
88 -- of in the ASSIGN_WORKER_TO_RUN because we need run and bundle state to be initialized
89 -- for certain kinds of args prior to calling ASSIGN_WORKER_TO_RUN. This is somewhat
90 -- of an artifact of the print_arg_context invoked in diagnostic modes.
91 -- Invariants:
92 -- Called after ASSIGN_WORKER_TO_RUN and BUNDLES_PKG.ASSIGN_WORKER_TO_BUNDLE.
93 -- Parameters:
94 -- x_return_status: FND_API-compliant return status
95 -- x_return_msg: Message explaining non-success return statuses
96 PROCEDURE INITIALIZE_RUN_ARG_CONTEXT(x_return_status OUT NOCOPY VARCHAR2,
97 x_return_msg OUT NOCOPY VARCHAR2);
98
99 -- Static API used by _BUNDLES_PKG to validate a run before beginning execution.
100 -- Invariants:
101 -- None
102 -- Parameters:
103 -- p_run_id: DSCRAM_RUNS.RUN_ID
104 -- x_return_status: FND_API-compliant return status
105 -- x_return_msg: Message explaining non-success return statuses
106 FUNCTION VALIDATE_START_EXECUTION(p_run_id IN NUMBER,
107 x_return_status OUT NOCOPY VARCHAR2,
108 x_return_msg OUT NOCOPY VARCHAR2)
109 RETURN BOOLEAN;
110
111 -- Static API used by _BUNDLES_PKG to validate a run periocially
112 -- has started.
113 -- Invariants:
114 -- Assign should have already occured to set up the run state.
115 -- Parameters:
116 -- p_force_query Force a query of the entities, typically done after we've seen an error.
117 -- p_recurse Whether to check parent entities (task, bundle, run)
118 -- x_return_status: FND_API-compliant return status
119 -- x_return_msg: Message explaining non-success return statuses
120 FUNCTION VALIDATE_CONTINUED_EXECUTION(p_force_query IN BOOLEAN DEFAULT FALSE,
121 p_recurse IN BOOLEAN DEFAULT FALSE,
122 x_return_status OUT NOCOPY VARCHAR2,
123 x_return_msg OUT NOCOPY VARCHAR2)
124 RETURN BOOLEAN;
125
126 -- Before a worker is assigned to a bundle by execute_bundle, it is first assigned
127 -- to the run to take care of initializing any run state. This assign is different
128 -- from others because it is not autonomous. This comes from
129 -- the fact that the master controller updates all state prior to pl/sql execution and
130 -- there is no impact on a run to add a worker(e.g. no counts).
131 -- Invariants:
132 -- None
133 -- Parameters:
134 -- p_run_id: DSCRAM_RUNS.RUN_ID
135 -- x_return_status: FND_API-compliant return status
136 -- x_return_msg: Message explaining non-success return statuses
137 PROCEDURE ASSIGN_WORKER_TO_RUN(p_run_id IN NUMBER,
138 x_return_status OUT NOCOPY VARCHAR2,
139 x_return_msg OUT NOCOPY VARCHAR2);
140
141 /*
142
143 -- API used to modify a run and its child entities to make 'stopped' entities have status 'restarting'
144 -- Invariants:
145 -- None
146 -- Parameters:
147 -- p_run_id: DSCRAM_RUNS.RUN_ID
148 -- x_return_status: FND_API-compliant return status
149 -- x_return_msg: Message explaining non-success return statuses
150 PROCEDURE PREPARE_RUN_FOR_RESUME(p_run_id IN NUMBER,
151 x_return_status OUT NOCOPY VARCHAR2,
152 x_return_msg OUT NOCOPY VARCHAR2);
153
154 -- API used to modify a run and its child entities to reset 'finished' entities to status
155 -- 'unprocessed' depending on certain criteria.
156 -- Invariants:
157 -- None
158 -- Parameters:
159 -- p_run_id: DSCRAM_RUNS.RUN_ID
160 -- p_errored_only: If TRUE, reset finished entities that encountered errors, otherwise
161 -- reset all to retry from start.
162 -- x_return_status: FND_API-compliant return status
163 -- x_return_msg: Message explaining non-success return statuses
164 PROCEDURE PREPARE_RUN_FOR_RETRY(p_run_id IN NUMBER,
165 p_errored_only IN BOOLEAN DEFAULT TRUE,
166 x_return_status OUT NOCOPY VARCHAR2,
167 x_return_msg OUT NOCOPY VARCHAR2);
168 */
169
170
171 -- Bug #47007636 - ilawler - Fri Nov 4 12:25:23 2005
172 -- Table handler required for translated entities to populate the _TL table when
173 -- a new language is added to an environment.
174 -- Invariants:
175 -- None
176 -- Parameters:
177 -- None
178 PROCEDURE ADD_LANGUAGE;
179
180 END FND_OAM_DSCRAM_RUNS_PKG;
[Home] [Help]