1 PACKAGE FND_OAM_DSCRAM_TASKS_PKG as
2 /* $Header: AFOAMDSTASKS.pls 120.1 2005/09/27 09:46 ilawler noship $ */
3
4 ------------
5 -- Constants
6 ------------
7
8 ---------------------------------
9 -- Public Procedures/Functions --
10 ---------------------------------
11
12 -- Accessor function to obtain parts of the task state
13 -- Invariants:
14 -- State must have been initialized by a prior call to execute_task in the session.
15 -- Parameters:
16 -- None
17 -- Returns:
18 -- The numerical ID of the task to which this session is assigned.
19 -- Exceptions:
20 -- If a prior call to execute_task wasn't executed, a NO_DATA_FOUND exception is thrown.
21 FUNCTION GET_TASK_ID
22 RETURN NUMBER;
23
24 -- This API is used to get the next available task for the bundle_id stored in the
25 -- bundle state. When no tasks found in queue, returns G_RET_STS_EMPTY - used to detect when
26 -- the bundle is fully processed.
27 -- Invariants:
28 -- Bundle must be initialized otherwise an error is returned.
29 -- Parameters:
30 -- p_requery: Boolean indicating whether the task SELECT statement should be re-executed
31 -- or the API should fetch the next row from the last query.
32 -- x_task_id: DSCRAM_TASKS.TASK_ID of task found
33 -- x_return_status: FND_API-compliant return status
34 -- x_return_msg: Message explaining non-success return statuses
35 PROCEDURE FETCH_NEXT_TASK(p_requery IN BOOLEAN,
36 x_task_id OUT NOCOPY NUMBER,
37 x_return_status OUT NOCOPY VARCHAR2,
38 x_return_msg OUT NOCOPY VARCHAR2);
39
40 -- Static API used to validate a task, consumed by _UNITS_PKG.
41 -- Invariants:
42 -- Internal Assign should have already occured to set up the state.
43 -- Parameters:
44 -- p_force_query Force a query of the entities, typically done after we've seen an error.
45 -- p_recurse Whether to check parent entities (task, bundle, run)
46 -- x_return_status: FND_API-compliant return status
47 -- x_return_msg: Message explaining non-success return statuses
48 FUNCTION VALIDATE_CONTINUED_EXECUTION(p_force_query IN BOOLEAN,
49 p_recurse IN BOOLEAN,
50 x_return_status OUT NOCOPY VARCHAR2,
51 x_return_msg OUT NOCOPY VARCHAR2)
52 RETURN BOOLEAN;
53
54 -- This API is used after a call to fetch_next_task to execute a task_id.
55 -- Invariants:
56 -- None
57 -- Parameters:
58 -- p_task_id: DSCRAM_TASKS.TASK_ID of task found
59 -- x_return_status: FND_API-compliant return status
60 -- x_return_msg: Message explaining non-success return statuses
61 PROCEDURE EXECUTE_TASK(p_task_id IN NUMBER,
62 x_return_status OUT NOCOPY VARCHAR2,
63 x_return_msg OUT NOCOPY VARCHAR2);
64
65 END FND_OAM_DSCRAM_TASKS_PKG;
[Home] [Help]