DBA Data[Home] [Help]

PACKAGE: APPS.HXC_FLD_MAPPING_API

Source


1 Package hxc_fld_mapping_api AUTHID CURRENT_USER as
2 /* $Header: hxcmapapi.pkh 120.0 2005/05/29 05:45:56 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |---------------------------< create_fld_mapping >-------------------------|
6 -- ----------------------------------------------------------------------------
7 --
8 -- {Start Of Comments}
9 --
10 -- Description:
11 --
12 -- This API creates a field mapping with a given name
13 --
14 -- Prerequisites:
15 --
16 -- None
17 --
18 -- In Parameters:
19 --   Name                           Reqd Type     Description
20 --
21 --   p_validate                     No   boolean  If TRUE then the database
22 --                                                remains unchanged. If FALSE
23 --                                                then a new data_approval_rule
24 --                                                is created. Default is FALSE.
25 --   p_mapping_id                   No   number   Primary Key for entity
26 --   p_object_version_number        No   number   Object Version Number
27 --   p_name                         Yes  varchar2 Name for the mapping
28 --
29 -- Post Success:
30 --
31 -- when the mapping has been created successfully the following
32 -- out parameters are set.
33 --
34 --   Name                           Type     Description
35 --
36 --   p_mapping_id                   Number   Primary Key for the new rule
37 --   p_object_version_number        Number   Object version number for the
38 --                                           new rule
39 --
40 -- Post Failure:
41 --
42 -- The mapping will not be inserted and an application error raised
43 --
44 -- Access Status:
45 --   Public.
46 --
47 -- {End Of Comments}
48 --
49 procedure create_fld_mapping
50   (p_validate                       in  boolean   default false
51   ,p_mapping_id                     in  out nocopy number
52   ,p_object_version_number          in  out nocopy number
53   ,p_name                           in     varchar2
54   );
55     --
56 -- ----------------------------------------------------------------------------
57 -- |--------------------------------<update_fld_mapping>----------------------|
58 -- ----------------------------------------------------------------------------
59 --
60 -- {Start Of Comments}
61 --
62 -- Description:
63 --
64 -- This API updates an existing Mapping with a given name, approval
65 -- rule usage covering a particular date range.
66 --
67 -- Prerequisites:
68 --
69 -- None
70 --
71 -- In Parameters:
72 --   Name                           Reqd Type     Description
73 --
74 --   p_validate                     No   boolean  If TRUE then the database
75 --                                                remains unchanged. If FALSE
76 --                                                then the data_approval_rule
77 --                                                is updated. Default is FALSE.
78 --   p_mapping_id                   Yes  number   Primary Key for entity
79 --   p_object_version_number        Yes  number   Object Version Number
80 --   p_name                         Yes  varchar2 Name for the mapping
81 --
82 -- Post Success:
83 --
84 -- when the mapping has been updated successfully the following
85 -- out parameters are set.
86 --
87 --   Name                           Type     Description
88 --
89 --   p_object_version_number        Number   Object version number for the
90 --                                           updated rule
91 --
92 -- Post Failure:
93 --
94 -- The mapping will not be updated and an application error raised
95 --
96 -- Access Status:
97 --   Public.
98 --
99 -- {End Of Comments}
100 --
101 procedure update_fld_mapping
102   (p_validate                       in  boolean   default false
103   ,p_mapping_id                     in  number
104   ,p_object_version_number          in  out nocopy number
105   ,p_name                           in     varchar2
106   );
107 --
108 -- ----------------------------------------------------------------------------
109 -- |-----------------------------< delete_fld_mapping >-----------------------|
110 -- ----------------------------------------------------------------------------
111 --
112 -- {Start Of Comments}
113 --
114 -- Description:
115 --
116 -- This API deletes an existing Mapping
117 --
118 -- Prerequisites:
119 --
120 -- None
121 --
122 -- In Parameters:
123 --   Name                           Reqd Type     Description
124 --
125 --   p_validate                     No   boolean  If TRUE then the database
126 --                                                remains unchanged. If FALSE
127 --                                                then the mapping
128 --                                                is deleted. Default is FALSE.
129 --   p_mapping_id                   Yes  number   Primary Key for entity
130 --   p_object_version_number        Yes  number   Object Version Number
131 --
132 -- Post Success:
133 --
134 -- when the mapping has been deleted successfully the process
135 -- completes with success.
136 --
137 -- Post Failure:
138 --
139 -- The mapping will not be deleted and an application error raised
140 --
141 -- Access Status:
142 --   Public.
143 --
144 -- {End Of Comments}
145 --
146 procedure delete_fld_mapping
147   (p_validate                       in  boolean  default false
148   ,p_mapping_id                     in  number
149   ,p_object_version_number          in  number
150   );
151 --
152 --
153 END hxc_fld_mapping_api;