DBA Data[Home] [Help]

PACKAGE: APPS.PER_SOLUTION_API

Source


1 Package per_solution_api as
2 /* $Header: pesolapi.pkh 120.0 2005/05/31 21:19:52 appldev noship $ */
3 --
4 -- ----------------------------------------------------------------------------
5 -- |--------------------------< CREATE_SOLUTION >-----------------------------|
6 -- ----------------------------------------------------------------------------
7 -- {Start Of Comments}
8 --
9 -- Description:
10 --   This business process adds a new solution.
11 --
12 -- Prerequisites:
13 --   None
14 --
15 -- In Parameters:
16 --   Name                           Reqd Type     Description
17 --   p_validate                     yes  Boolean  If true, the database remains
18 --                                                unchanged. If false the
19 --                                                assignment is updated in
20 --                                                the database.
21 --   p_effective_date               yes  date     Effective date
22 --   p_solution_name                yes  varchar2 Name of solution
23 --   p_description                  no   varchar2 Used on the summary page
24 --   p_link_to_full_description     no   varchar2 The name of the page where the
25 --                                                full description of the
26 --                                                solution is held
27 --   p_solution_type_name           yes  varchar2 FK to PER_SOLUTION_TYPES
28 --   p_vertical                     no   varchar2 Chosen from a lookup of type
29 --                                                PER_SOLUTION_VERTICALS
30 --   p_legislation_code             no   varchar2 Legislation Code
31 --   p_user_id                      no   varchar2 Used for user-defined
32 --                                                solutions only
33 --
34 --
35 --
36 -- Post Success:
37 --   When the solution is valid, the API sets the following out parameters.
38 --
39 --   Name                           Type     Description
40 --   p_solution_id                  number   If p_validate is false, this
41 --                                           uniquely identifies the Solution
42 --                                           created. If p_validate is true,
43 --                                           this parameter will be null.
44 --   p_object_version_number        number   If p_validate is false, this
45 --                                           will be set to the version number
46 --                                           of the Solution created. If
47 --                                           p_validate is true this parameter
48 --                                           will be set to null.
49 --
50 --
51 -- Post Failure:
52 --   The API does not create a Solution and raises an error.
53 --
54 --
55 -- Access Status:
56 --   Public.
57 --
58 -- {End Of Comments}
59 --
60 procedure create_solution
61   (p_validate                      in     boolean  default false
62   ,p_effective_date                in     date
63   ,p_solution_name                 in     varchar2
64   ,p_solution_type_name            in     varchar2
65   ,p_description                   in     varchar2   default null
66   ,p_link_to_full_description      in     varchar2   default null
67   ,p_vertical                      in     varchar2   default null
68   ,p_legislation_code              in     varchar2   default null
69   ,p_user_id                       in     varchar2   default null
70   ,p_solution_id                      out nocopy number
71   ,p_object_version_number            out nocopy number
72   );
73 
74 -- ----------------------------------------------------------------------------
75 -- |--------------------------< UPDATE_SOLUTION >-----------------------------|
76 -- ----------------------------------------------------------------------------
77 -- {Start Of Comments}
78 --
79 -- Description:
80 --   This business process updates a solution.
81 --
82 -- Prerequisites:
83 --   The Solution record identified by p_solution_id and
84 --   p_object_version_number must exist.
85 --
86 -- In Parameters:
87 --   Name                           Reqd Type     Description
88 --   p_validate                     yes  Boolean  If true, the database remains
89 --                                                unchanged. If false the
90 --                                                assignment is updated in
91 --                                                the database.
92 --   p_effective_date               yes  date     Effective date
93 --   p_solution_id                  yes  number   ID of solution
94 --   p_object_version_number        yes  number   Object Version Number
95 --   p_solution_name                yes  varchar2 Name of solution
96 --   p_description                  no   varchar2 Used on the summary page
97 --   p_link_to_full_description     no   varchar2 The name of the page where the
98 --                                                full description of the
99 --                                                solution is held
100 --   p_solution_type_name           yes  varchar2 FK to PER_SOLUTION_TYPES
101 --   p_vertical                     no   varchar2 Chosen from a lookup of type
102 --                                                PER_SOLUTION_VERTICALS
103 --   p_legislation_code             no   varchar2 Legislation Code
104 --   p_user_id                      no   varchar2 Used for user-defined
105 --                                                solutions only
106 --
107 --
108 --
109 -- Post Success:
110 --   The Solution record is updated and the API sets the following out
111 --   parameters.
112 --
113 --   Name                           Type     Description
114 --   p_object_version_number        number   If p_validate is false the
115 --                                           new version number is returned.
116 --                                           If p_validate is true then the
117 --                                           version number passed in is
118 --                                           returned.
119 --
120 -- Post Failure:
121 --   The API does not update a Solution and raises an error.
122 --
123 --
124 -- Access Status:
125 --   Public.
126 --
127 -- {End Of Comments}
128 --
129 procedure update_solution
130   (p_validate                      in     boolean  default false
131   ,p_effective_date                in     date
132   ,p_solution_id                   in     number
133   ,p_solution_name                 in     varchar2
134   ,p_solution_type_name            in     varchar2
135   ,p_description                   in     varchar2   default hr_api.g_varchar2
136   ,p_link_to_full_description      in     varchar2   default hr_api.g_varchar2
137   ,p_vertical                      in     varchar2   default hr_api.g_varchar2
138   ,p_legislation_code              in     varchar2   default hr_api.g_varchar2
139   ,p_user_id                       in     varchar2   default hr_api.g_varchar2
140   ,p_object_version_number         in out nocopy number
141   );
142 
143 -- ----------------------------------------------------------------------------
144 -- |--------------------------< DELETE_SOLUTION >-----------------------------|
145 -- ----------------------------------------------------------------------------
146 -- {Start Of Comments}
147 --
148 -- Description:
149 --   This business process deletes a solution.
150 --
151 -- Prerequisites:
152 --   The Solution record identified by p_solution_id and
153 --   p_object_version_number must exist.
154 --
155 -- In Parameters:
156 --   Name                           Reqd Type     Description
157 --   p_validate                     yes  Boolean  If true, the database remains
158 --                                                unchanged. If false the
159 --                                                assignment is updated in
160 --                                                the database.
161 --   p_solution_id                  yes  number   ID of solution
162 --   p_object_version_number        yes  number   Object Version Number
163 --
164 -- Post Success:
165 --   The Solution is deleted.
166 --
167 -- Post Failure:
168 --   The API does not delete a Solution and raises an error.
169 --
170 -- Access Status:
171 --   Public.
172 --
173 -- {End Of Comments}
174 --
175 procedure delete_solution
176   (p_validate                      in     boolean  default false
177   ,p_solution_id                   in     number
178   ,p_object_version_number         in     number
179   );
180 --
181 end per_solution_api;