1 Package HR_AUTHORIA_VARIABLEMAP_API AUTHID CURRENT_USER as
2 /* $Header: hravmapi.pkh 120.0 2005/05/30 23:00:07 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |---------------------< CREATE_VARIABLEMAP >-------------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 -- This API is provided to allow creation of new entries within the
11 -- HR_ATH_VARIABLEMAP table.
12 --
13 -- Prerequisites:
14 -- none
15 --
16 -- In Parameters:
17 -- Name Reqd Type Description
18 -- p_validate No boolean Commit or rollback
19 -- p_ath_dsn Yes varchar2 The dsn
20 -- p_ath_tablename Yes varchar2 The table name
21 -- p_ath_columnname Yes varchar2 The column name
22 -- p_ath_varname Yes varchar2 The variable name
23 --
24 -- Post Success:
25 -- When the mapping has been sucessfully been inserted the following
26 -- parameters are set:
27 --
28 -- Name Type Description
29 -- p_ath_variablemap_id number PK of HR_ATH_VARIABLEMAP
30 -- p_object_version_number number Set to 1
31 --
32 -- Post Failure:
33 -- The API does not create the mapping and raises an error.
34 --
35 -- Access Status:
36 -- Public.
37 --
38 -- {End Of Comments}
39 --
40 procedure CREATE_VARIABLEMAP
41 (p_validate in boolean default false
42 ,p_ath_dsn in varchar2
43 ,p_ath_tablename in varchar2
44 ,p_ath_columnname in varchar2
45 ,p_ath_varname in varchar2
46 ,p_ath_variablemap_id out nocopy number
47 ,p_object_version_number out nocopy number
48 );
49 --
50 --
51 -- ----------------------------------------------------------------------------
52 -- |----------------------<UPDATE_VARIABLEMAP>--------------------------------|
53 -- ----------------------------------------------------------------------------
54 -- {Start Of Comments}
55 --
56 -- Description:
57 -- This API is provided to allow updating of entries within the
58 -- HR_ATH_VARIABLEMAP table.
59 --
60 -- Prerequisites:
61 -- (i) The ATH_VARIABLEMAP_ID must exist within the HR_ATH_VARIABLEMAP
62 -- table.
63 --
64 --
65 -- In Parameters:
66 -- Name Reqd Type Description
67 -- p_validate No boolean Commit or rollback
68 -- p_ath_dsn Yes varchar2 The dsn
69 -- p_ath_tablename Yes varchar2 The table name
70 -- p_ath_columnname Yes varchar2 The column name
71 -- p_ath_varname Yes varchar2 The variable name
72 -- p_ath_variablemap_id Yes number The PK of HR_ATH_VARIABLEMAP
73 -- p_object_version_number Yes number The version of the row
74 --
75 -- Post Success:
76 -- When the document has been sucessfully been updated the following
77 -- parameters are set:
78 --
79 -- Name Type Description
80 -- p_object_version_number number Set to OVN++
81 --
82 -- Post Failure:
83 -- The API does not update the mapping for the party and raises an error.
84 --
85 -- Access Status:
86 -- Public.
87 --
88 -- {End Of Comments}
89 --
90 procedure update_variablemap
91 (p_validate in boolean default false
92 ,p_ath_dsn in varchar2
93 ,p_ath_tablename in varchar2
94 ,p_ath_columnname in varchar2
95 ,p_ath_varname in varchar2
96 ,p_ath_variablemap_id in number
97 ,p_object_version_number in out nocopy number
98 );
99 --
100 --
101 -- ----------------------------------------------------------------------------
102 -- |------------------------< DELETE_VARIABLEMAP >----------------------------|
103 -- ----------------------------------------------------------------------------
104 -- {Start Of Comments}
105 --
106 -- Description:
107 -- This API is provided to allow deletion of mappings within the
108 -- HR_ATH_VARIABLEMAP table.
109 --
110 -- Prerequisites:
111 -- (i) The ATH_VARIABLEMAP_ID must exist within the HR_ATH_VARIABLEMAP
112 -- table.
113 --
114 --
115 -- In Parameters:
116 -- Name Reqd Type Description
117 -- p_ath_variablemap_id Yes number The PK of HR_ATH_VARIABLEMAP
118 -- p_object_version_number Yes number The version of the row
119 --
120 -- Post Success:
121 -- The record will cease to exist.
122 --
123 -- Post Failure:
124 -- The record will exist, and an error will be raised.
125 --
126 -- Access Status:
127 -- Public.
128 --
129 -- {End Of Comments}
130 --
131 procedure DELETE_VARIABLEMAP
132 (p_validate in boolean default false
133 ,p_ath_variablemap_id in number
134 ,p_object_version_number in number
135 );
136 --
137 --
138 end HR_AUTHORIA_VARIABLEMAP_API;
[Home] [Help]