1 PACKAGE CSI_SYSTEMS_PUB AS
2 /* $Header: csipsyss.pls 120.0 2005/05/25 02:30:57 appldev noship $ */
3 /*#
4 * This is a public API for managing Systems.
5 * It contains routines to Create, Update and Get Systems.
6 * @rep:scope public
7 * @rep:product CSI
8 * @rep:displayname Manage Systems
9 * @rep:lifecycle active
10 * @rep:compatibility S
11 * @rep:category BUSINESS_ENTITY CSI_ITEM_INSTANCE
12 */
13 -- Start of Comments
14 -- Package name : CSI_SYSTEMS_PUB
15 -- Purpose :
16 -- History :
17 -- NOTE :
18 -- End of Comments
19
20 -- Default number of records fetch per call
21 G_DEFAULT_NUM_REC_FETCH NUMBER := 30;
22
23 /*#
24 * This procedure gets the System information satisfying the query criteria provided by the
25 * calling application. If the p_time_stamp is passed then the information would be constructed
26 * from history. Otherwise the current system information would be retreived.
27 * @param p_api_version API version
28 * @param p_commit API commits if set to fnd_api.g_true
29 * @param p_init_msg_list Initializes the message stack if set to fnd_api.g_true
30 * @param p_validation_level API validation level
31 * @param p_system_query_rec System Query Record structure containing the query criteria
32 * @param p_time_stamp System information as of given time
33 * @param p_active_systems_only Determines whether to get active systems or all systems based on the query
34 * @param x_systems_tbl Output Table structure containing the systems
35 * @param x_return_status API Return Status
36 * @param x_msg_count Message count
37 * @param x_msg_data Message Data
38 * @rep:scope public
39 * @rep:lifecycle active
40 * @rep:displayname Get Systems
41 */
42 PROCEDURE get_systems
43 (
44 p_api_version IN NUMBER,
45 p_commit IN VARCHAR2 := fnd_api.g_false,
46 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
47 p_validation_level IN NUMBER := fnd_api.g_valid_level_full,
48 p_system_query_rec IN csi_datastructures_pub.system_query_rec,
49 p_time_stamp IN DATE,
50 p_active_systems_only IN VARCHAR2 := fnd_api.g_false,
51 x_systems_tbl OUT NOCOPY csi_datastructures_pub.systems_tbl,
52 x_return_status OUT NOCOPY VARCHAR2,
53 x_msg_count OUT NOCOPY NUMBER,
54 x_msg_data OUT NOCOPY VARCHAR2
55 );
56
57
58 /*#
59 * This procedure creates a new System in Install Base.
60 * @param p_api_version API version
61 * @param p_commit API commits if set to fnd_api.g_true
62 * @param p_init_msg_list Initializes the message stack if set to fnd_api.g_true
63 * @param p_validation_level API validation level
64 * @param p_system_rec System Record containing information about the system to be created
65 * @param p_txn_rec Transaction Record structure
66 * @param x_system_id Contains the created system ID
67 * @param x_return_status API Return Status
68 * @param x_msg_count Message count
69 * @param x_msg_data Message Data
70 * @rep:scope public
71 * @rep:lifecycle active
72 * @rep:displayname Create System
73 */
74 PROCEDURE create_system(
75 p_api_version IN NUMBER,
76 p_commit IN VARCHAR2 := fnd_api.g_false,
77 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
78 p_validation_level IN NUMBER := fnd_api.g_valid_level_full,
79 p_system_rec IN csi_datastructures_pub.system_rec,
80 p_txn_rec IN OUT NOCOPY csi_datastructures_pub.transaction_rec,
81 x_system_id OUT NOCOPY NUMBER,
82 x_return_status OUT NOCOPY VARCHAR2,
83 x_msg_count OUT NOCOPY NUMBER,
84 x_msg_data OUT NOCOPY VARCHAR2
85 );
86
87 /*#
88 * This procedure updates an existing system record in Install Base.
89 * @param p_api_version API version
90 * @param p_commit API commits if set to fnd_api.g_true
91 * @param p_init_msg_list Initializes the message stack if set to fnd_api.g_true
92 * @param p_validation_level API validation level
93 * @param p_system_rec System Record containing information about the system to be updated
94 * @param p_txn_rec Transaction Record structure
95 * @param x_return_status API Return Status
96 * @param x_msg_count Message count
97 * @param x_msg_data Message Data
98 * @rep:scope public
99 * @rep:lifecycle active
100 * @rep:displayname Update System
101 */
102 PROCEDURE update_system(
103 p_api_version IN NUMBER,
104 p_commit IN VARCHAR2 := fnd_api.g_false,
105 p_init_msg_list IN VARCHAR2 := fnd_api.g_false,
106 p_validation_level IN NUMBER := fnd_api.g_valid_level_full,
107 p_system_rec IN csi_datastructures_pub.system_rec,
108 p_txn_rec IN OUT NOCOPY csi_datastructures_pub.transaction_rec,
109 x_return_status OUT NOCOPY VARCHAR2,
110 x_msg_count OUT NOCOPY NUMBER,
111 x_msg_data OUT NOCOPY VARCHAR2
112 );
113
114 PROCEDURE expire_system
115 (
116 p_api_version IN NUMBER,
117 p_commit IN VARCHAR2 := FND_API.G_FALSE,
118 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
119 p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,
120 p_system_rec IN csi_datastructures_pub.system_rec,
121 p_txn_rec IN OUT NOCOPY csi_datastructures_pub.transaction_rec,
122 x_instance_id_lst OUT NOCOPY csi_datastructures_pub.id_tbl,
123 x_return_status OUT NOCOPY VARCHAR2,
124 x_msg_count OUT NOCOPY NUMBER,
125 x_msg_data OUT NOCOPY VARCHAR2
126 );
127
128
129 end csi_systems_pub;
[Home] [Help]