DBA Data[Home] [Help]

PACKAGE: APPS.GMD_ROUTINGS_PUB

Source


1 PACKAGE GMD_ROUTINGS_PUB AUTHID CURRENT_USER AS
2 /* $Header: GMDPROUS.pls 120.1.12010000.1 2008/07/24 09:57:14 appldev ship $ */
3 /*#
4  * This interface is used to insert, update, delete and undelete routings
5  * This package defines and implements the procedures and datatypes
6  * required to insert/update/delete/undelete routings .
7  * @rep:scope public
8  * @rep:product GMD
9  * @rep:lifecycle active
10  * @rep:displayname Routings Public package
11  * @rep:compatibility S
12  * @rep:category BUSINESS_ENTITY GMD_ROUTING
13  */
14 
15   m_api_version   CONSTANT NUMBER         := 1;
16   m_pkg_name      CONSTANT VARCHAR2 (30)  := 'GMD_ROUTINGS_PUB';
17 
18   TYPE gmd_routings_step_tab IS TABLE OF fm_rout_dtl%ROWTYPE
19        INDEX BY BINARY_INTEGER;
20 
21   TYPE gmd_routings_step_dep_tab IS TABLE OF fm_rout_dep%ROWTYPE
22        INDEX BY BINARY_INTEGER;
23 
24   /* define record and table type to specify the column that needs to
25      updated */
26   TYPE update_table_rec_type IS RECORD
27   (
28    p_col_to_update	VARCHAR2(240)
29   ,p_value		VARCHAR2(240)
30   );
31 
32   TYPE update_tbl_type IS TABLE OF update_table_rec_type INDEX BY BINARY_INTEGER;
33 
34 /*#
35  * Insert routings
36  * This is a PL/SQL procedure is responsible for inserting new routings
37  * @param p_api_version API version field
38  * @param p_init_msg_list Flag to check if message list intialized
39  * @param p_commit Flag to check for commit
40  * @param p_routings Row type of GMD_ROUTINGS table
41  * @param p_routings_step_tbl Table structure of Routings Step details table
42  * @param p_routings_step_dep_tbl Table structure of Routings Step dependency table
43  * @param x_message_count Number of msg's on message stack
44  * @param x_message_list Message list
45  * @param x_return_status  'S'-Success, 'E'-Error, 'U'-Unexpected Error
46  * @rep:scope public
47  * @rep:lifecycle active
48  * @rep:displayname Insert Routing procedure
49  * @rep:compatibility S
50  */
51   PROCEDURE insert_routing
52   ( p_api_version            IN   NUMBER	                   :=  1
53   , p_init_msg_list          IN   BOOLEAN	                   :=  TRUE
54   , p_commit		     IN   BOOLEAN	                   :=  FALSE
55   , p_routings               IN   gmd_routings%ROWTYPE
56   , p_routings_step_tbl      IN   GMD_ROUTINGS_PUB.gmd_routings_step_tab
57   , p_routings_step_dep_tbl  IN   GMD_ROUTINGS_PUB.gmd_routings_step_dep_tab
58   , x_message_count          OUT NOCOPY  NUMBER
59   , x_message_list           OUT NOCOPY  VARCHAR2
60   , x_return_status          OUT NOCOPY  VARCHAR2
61   );
62 
63 /*#
64  * Update routings
65  * This is a PL/SQL procedure is responsible for updating routings
66  * @param p_api_version API version field
67  * @param p_init_msg_list Flag to check if message list intialized
68  * @param p_commit Flag to check for commit
69  * @param p_routing_id Routing ID
70  * @param p_routing_no Routing Number
71  * @param p_routing_vers Routing Version
72  * @param p_update_table Table structure containing column and table to be updated
73  * @param x_message_count Number of msg's on message stack
74  * @param x_message_list Message list
75  * @param x_return_status  'S'-Success, 'E'-Error, 'U'-Unexpected Error
76  * @rep:scope public
77  * @rep:lifecycle active
78  * @rep:displayname Update Routing procedure
79  * @rep:compatibility S
80  */
81   PROCEDURE update_routing
82   ( p_api_version 	IN 	NUMBER 			        := 1
83   , p_init_msg_list 	IN 	BOOLEAN 			:= TRUE
84   , p_commit		IN 	BOOLEAN 			:= FALSE
85   , p_routing_id	IN	gmd_routings.routing_id%TYPE    := NULL
86   , p_routing_no	IN	gmd_routings.routing_no%TYPE    := NULL
87   , p_routing_vers	IN	gmd_routings.routing_vers%TYPE  := NULL
88   , p_update_table	IN	update_tbl_type
89   , x_message_count 	OUT NOCOPY 	NUMBER
90   , x_message_list 	OUT NOCOPY 	VARCHAR2
91   , x_return_status	OUT NOCOPY 	VARCHAR2
92   );
93 
94 /*#
95  * Delete routings
96  * This is a PL/SQL procedure is responsible for deleting routings
97  * @param p_api_version API version field
98  * @param p_init_msg_list Flag to check if message list intialized
99  * @param p_commit Flag to check for commit
100  * @param p_routing_id Routing ID
101  * @param p_routing_no Routing Number
102  * @param p_routing_vers Routing Version
103  * @param x_message_count Number of msg's on message stack
104  * @param x_message_list Message list
105  * @param x_return_status  'S'-Success, 'E'-Error, 'U'-Unexpected Error
106  * @rep:scope public
107  * @rep:lifecycle active
108  * @rep:displayname Delete Routing procedure
109  * @rep:compatibility S
110  */
111   PROCEDURE delete_routing
112   ( p_api_version 	IN 	NUMBER 			        := 1
113   , p_init_msg_list 	IN 	BOOLEAN 			:= TRUE
114   , p_commit		IN 	BOOLEAN 			:= FALSE
115   , p_routing_id	IN	gmd_routings.routing_id%TYPE    := NULL
116   , p_routing_no	IN	gmd_routings.routing_no%TYPE    := NULL
117   , p_routing_vers	IN	gmd_routings.routing_vers%TYPE  := NULL
118   , x_message_count 	OUT NOCOPY 	NUMBER
119   , x_message_list 	OUT NOCOPY 	VARCHAR2
120   , x_return_status	OUT NOCOPY 	VARCHAR2
121   );
122 
123 /*#
124  * Undelete routings
125  * This is a PL/SQL procedure is responsible for undeleting a deleted routing
126  * after validation to see if deleted routing exists in Database
127  * @param p_api_version API version field
128  * @param p_init_msg_list Flag to check if message list intialized
129  * @param p_commit Flag to check for commit
130  * @param p_routing_id Routing ID
131  * @param p_routing_no Routing Number
132  * @param p_routing_vers Routing Version
133  * @param x_message_count Number of msg's on message stack
134  * @param x_message_list Message list
135  * @param x_return_status  'S'-Success, 'E'-Error, 'U'-Unexpected Error
136  * @rep:scope public
137  * @rep:lifecycle active
138  * @rep:displayname Delete Routing procedure
139  * @rep:compatibility S
140  */
141   PROCEDURE undelete_routing
142   ( p_api_version 	IN 	NUMBER 			        := 1
143   , p_init_msg_list 	IN 	BOOLEAN 			:= TRUE
144   , p_commit		IN 	BOOLEAN 			:= FALSE
145   , p_routing_id	IN	gmd_routings.routing_id%TYPE    := NULL
146   , p_routing_no	IN	gmd_routings.routing_no%TYPE    := NULL
147   , p_routing_vers	IN	gmd_routings.routing_vers%TYPE  := NULL
148   , x_message_count 	OUT NOCOPY 	NUMBER
149   , x_message_list 	OUT NOCOPY 	VARCHAR2
150   , x_return_status	OUT NOCOPY 	VARCHAR2
151   );
152 
153 
154 END GMD_ROUTINGS_PUB;