DBA Data[Home] [Help]

PACKAGE: APPS.JTF_HA_STATE_PKG

Source


1 package JTF_HA_STATE_PKG AUTHID CURRENT_USER as
2 /* $Header: JTFHASS.pls 120.2 2005/11/15 00:49:01 psanyal ship $ */
3 
4 -- *****************************************************************************
5 
6 
7 -- Start of Comments
8 --
9 --      API name        : GET_CURRENT_STATE
10 --      Type            : Public
11 --      Function        : Get the current HA system state
12 --
13 --      Parameters      :
14 --      OUT     :
15 --              X_CURRENT_STATE         OUT NUMBER
16 --              X_RETURN_STATUS         OUT VARCHAR2
17 --
18 --      Version :Current version        1.0
19 --               Initial version        1.0
20 --
21 --	NOTES:
22 --	X_RETURN_STATUS holds the status of the procedure call, its value is
23 --        FND_API.G_RET_STS_SUCCESS when the API completes successfully,
24 --		in this case, X_CURRENT_STATE holds the current HA state
25 --        FND_API.G_RET_STS_UNEXP_ERROR when the API reaches an unexpected
26 --		state, in which case X_CURRENT_STATE is undefined.
27 --        FND_API.G_RET_STS_ERROR when the API hits an error, in which case
28 --		X_CURRENT_STATE is undefined.
29 --	X_CURRENT_STATE	holds the state index value:
30 --		0	FULL OPERATION
31 --		1	WARNING
32 --		2	TRANSITION TO MAINTENANCE
33 --		3	MAINTENANCE
34 --		4	TRANSITION TO FULL OPERATION
35 --		5	FUZZY LIVE
36 --
37 -- *****************************************************************************
38 
39 procedure GET_CURRENT_STATE (
40   X_CURRENT_STATE out NOCOPY NUMBER,
41   X_RETURN_STATUS out NOCOPY VARCHAR2
42 );
43 
44 -- Start of Comments
45 --
46 --      API name        : SET_CURRENT_STATE
47 --      Type            : Public
48 --      Function        : Set the current HA system state
49 --
50 --      Parameters      :
51 --      IN        P_CURRENT_STATE         IN NUMBER
52 --      OUT       X_RETURN_STATUS         OUT VARCHAR2
53 --
54 --      Version :Current version        1.0
55 --               Initial version        1.0
56 --
57 --	NOTES:
58 --	X_RETURN_STATUS holds the status of the procedure call, its value is
59 --        FND_API.G_RET_STS_SUCCESS when the API completes successfully
60 --        FND_API.G_RET_STS_UNEXP_ERROR when the API reaches an unexpected
61 --		state
62 --        FND_API.G_RET_STS_ERROR when the API hits an error
63 --	P_CURRENT_STATE	the state to be set:
64 --		0	FULL OPERATION
65 --		1	WARNING
66 --		2	TRANSITION TO MAINTENANCE
67 --		3	MAINTENANCE
68 --		4	TRANSITION TO FULL OPERATION
69 --		5	FUZZY LIVE
70 --
71 -- *****************************************************************************
72 
73 procedure SET_CURRENT_STATE (
74   P_CURRENT_STATE in NUMBER,
75   X_RETURN_STATUS out NOCOPY VARCHAR2
76 );
77 
78 end JTF_HA_STATE_PKG;