[Home] [Help]
PACKAGE: APPS.CS_TP_CHOICES_PVT
Source
1 package CS_TP_CHOICES_PVT AUTHID CURRENT_USER as
2 /* $Header: cstpcsms.pls 115.13 2002/12/04 02:02:15 wzli noship $ */
3
4
5 --
6 -- Start of Comments
7 --
8 -- Record: Choice
9 --
10 --
11 -- mChoiceID NUMBER
12 -- mChoiceName VARCHAR2(1000)
13 -- mLookUpID NUMBER
14 -- mScore NUMBER
15 -- mLast_Updated_Date VARCHAR2(60)
16
17 -- End of Comments
18
19 TYPE Choice is RECORD (
20 mChoiceID NUMBER := FND_API.G_MISS_NUM,
21 mChoiceName VARCHAR2(1000) := FND_API.G_MISS_CHAR ,
22 mLookupID NUMBER := FND_API.G_MISS_NUM,
23 mScore NUMBER := FND_API.G_MISS_NUM,
24 mLast_Updated_Date VARCHAR2(60) := FND_API.G_MISS_CHAR
25 ,mDefaultChoiceFlag VARCHAR2(1) := FND_API.G_MISS_CHAR
26 );
27
28 --
29 -- Start of Comments
30 --
31 -- Table: Binary Indexed Table of Choice
32 --
33 -- End of Comments
34
35 TYPE Choice_List is TABLE OF Choice
36 INDEX BY BINARY_INTEGER;
37
38 --
39 -- Start of Comments
40 --
41 -- Record: Freetext
42 -- mFreetextID NUMBER
43 -- mFreetextSize NUMBER
44 -- mFreeTextDefaultText VARCAHR2
45 -- mLookUpID NUMBER
46 -- mLast_Updated_Date VARCHAR2
47
48 TYPE FREETEXT is RECORD (
49 mFreetextID NUMBER :=FND_API.G_MISS_NUM,
50 mFreetextSize NUMBER :=FND_API.G_MISS_NUM,
51 mFreeTextDefaultText VARCHAR2(1000) :=FND_API.G_MISS_CHAR,
52 mLookUpID NUMBER :=FND_API.G_MISS_NUM,
53 mLast_Updated_Date VARCHAR2(200) :=FND_API.G_MISS_CHAR
54 );
55
56 --
57 -- Display Order Constants are used to dictate the order of the list of templates/questions queried
58 -- ALPHABATICAL
59 -- REVERSE_ALPHABATICAL
60 -- NORMAL
61 -- CRONOLOGICAL
62 -- REVERSE_CRONOLOGICAL
63 ALPHABATICAL CONSTANT VARCHAR(60):='ALPHABATICAL';
64 REVERSE_ALPHABATICAL CONSTANT VARCHAR(60):='REVERSE_ALPHABATICAL';
65 NORMAL CONSTANT VARCHAR(60):='NORMAL';
66 CRONOLOGICAL CONSTANT VARCHAR(60):='CRONOLOGICAL';
67 REVERSE_CRONOLOGICAL CONSTANT VARCHAR(60):='REVERSE_CRONOLOGICAL';
68
69 --
70 -- Start of Comments
71 -- This procedure Add_Choice add an additional choice to the CS_TP_CHOICES_B and CS_TP_CHOICES_TL
72 -- In each choice record, the choice name, score, and lookup ID are required.
73 -- Validation is performed to see if the lookup ID is valid.
74 --
75 --
76 -- @param p_Choice required
77 -- @param p_api_version_number required
78 -- @param p_commit
79 -- @param p_init_msg_list
80
81
82 -- @return X_Msg_Count
83 -- X_Msg_Data
84 -- X_Return_Status
85 -- X_Choice_ID
86 -- End of Comments
87
88 procedure Add_Choice (
89 p_api_version_number IN NUMBER,
90 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
91 p_commit IN VARCHAR := FND_API.G_FALSE,
92 p_One_Choice IN Choice,
93 X_Msg_Count OUT NOCOPY NUMBER,
94 X_Msg_Data OUT NOCOPY VARCHAR2,
95 X_Return_Status OUT NOCOPY VARCHAR2,
96 X_Choice_ID OUT NOCOPY NUMBER);
97
98 --
99 -- Start of Comments
100 -- This procedure Delete_Choice deletes an existing choice with passed in Choice_ID
101 --@param p_api_version_number
102 --@param p_init_msg_list
103 --@param p_commit
104 --@param p_One_Question
105
106 --@return X_Msg_Count
107 -- X_Msg_Data
108 -- X_Return_Status
109 -- End of Comments
110
111 procedure Delete_Choice (
112 p_api_version_number IN NUMBER,
113 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
114 p_commit IN VARCHAR := FND_API.G_FALSE,
115 P_Choice_ID IN NUMBER,
116 X_Msg_Count OUT NOCOPY NUMBER,
117 X_Msg_Data OUT NOCOPY VARCHAR2,
118 X_Return_Status OUT NOCOPY VARCHAR2
119 );
120
121 --
122 -- Start of Comments
123 -- This procedure Sort_Choicess sorts the choices in the order of the list of
124 -- the choices passed in. The user calls Show_Choices with P_Display_Order equ
125 --al to normal after calling Sort_Choices and the Show_Choices will return a li
126 --st of choices in the same order as the order user passed into the Sort_Choice
127 --s.
128 -- In the list of choices passed in, the lookup ID needs to be the same for each choice.
129 --@param p_api_version_number required
130 --@param p_init_msg_list
131 --@param p_commit
132 --@param P_Choice required
133
134 --@return X_Msg_Count
135 -- X_Msg_Data
136 -- X_Return_Status
137 -- End of Comments
138 procedure Sort_Choices (
139 p_api_version_number IN NUMBER,
140 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
141 p_commit IN VARCHAR := FND_API.G_FALSE,
142 P_Choices In Choice_List,
143 X_Msg_Count OUT NOCOPY NUMBER,
144 X_Msg_Data OUT NOCOPY VARCHAR2,
145 X_Return_Status OUT NOCOPY VARCHAR2
146 );
147 --
148 -- Start of Comments
149 --
150 -- Show_Choices takes a Lookup_ID and returns a list of choices associated with the Lookup_ID
151 --@param P_Lookup_Id
152 --@param P_Display_Order
153 -- @param p_api_version_number required
154 -- @param p_commit
155 -- @param p_init_msg_list
156 -- @return X_Msg_Count
157 -- X_Msg_Data
158 -- X_Return_Status
159 -- X_Choice_List_To_Show
160
161 procedure Show_Choices (
162 p_api_version_number IN NUMBER,
163 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
164 p_commit IN VARCHAR := FND_API.G_FALSE,
165 P_Lookup_Id IN NUMBER,
166 P_Display_Order IN VARCHAR2,
167 X_Msg_Count OUT NOCOPY NUMBER,
168 X_Msg_Data OUT NOCOPY VARCHAR2,
169 X_Return_Status OUT NOCOPY VARCHAR2,
170 X_Choice_List_To_Show OUT NOCOPY Choice_List
171 );
172 --
173 -- Start of Comments
174 --
175 -- Update_Choices takes a list of choices and save it to database
176 -- @param p_api_version_number required
177 -- @param p_commit
178 -- @param p_init_msg_list
179 -- @param Choice_List
180 -- @param
181 -- @return X_Msg_Count
182 -- X_Msg_Data
183 -- X_Return_Status
184
185 procedure Update_Choices (
186 p_api_version_number IN NUMBER,
187 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
188 p_commit IN VARCHAR := FND_API.G_FALSE,
189 P_Choices In Choice_List,
190 X_Msg_Count OUT NOCOPY NUMBER,
191 X_Msg_Data OUT NOCOPY VARCHAR2,
192 X_Return_Status OUT NOCOPY VARCHAR2
193 );
194 --
195 -- Start of Comments
196 --
197 -- Add Freetext adds the freetext to the CS_TP_FREETEXTS table
198 -- There is a freetext row associated with the lookup id in the freetext record passed in , then update the CS_TP_FREETEXTS table
199 -- otherwise insert the freetext.
200 --@param P_Lookup_Id required
201 --@param P_Freetext required
202 -- @param p_api_version_number required
203 -- @param p_commit
204 -- @param p_init_msg_list
205 -- @return X_Msg_Count
206 -- X_Msg_Data
207 -- X_Return_Status
208 -- X_Freetext_ID
209
210 procedure Add_Freetext (
211 p_api_version_number IN NUMBER,
212 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
213 p_commit IN VARCHAR := FND_API.G_FALSE,
214 P_One_Freetext in Freetext,
215 X_Msg_Count OUT NOCOPY NUMBER,
216 X_Msg_Data OUT NOCOPY VARCHAR2,
217 X_Return_Status OUT NOCOPY VARCHAR2,
218 X_Freetext_ID OUT NOCOPY NUMBER
219 );
220
221 --
222 -- Start of Comments
223 --
224 -- Show_Freetext displays the freetext.
225 --@param P_Lookup_Id required
226 -- @param p_api_version_number required
227 -- @param p_commit
228 -- @param p_init_msg_list
229 -- @return X_Msg_Count
230 -- X_Msg_Data
231 -- X_Return_Status
232 -- X_Freetext
233 procedure Show_Freetext (
234 p_api_version_number IN NUMBER,
235 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
236 p_commit IN VARCHAR := FND_API.G_FALSE,
237 P_Lookup_ID IN NUMBER,
238 X_Msg_Count OUT NOCOPY NUMBER,
239 X_Msg_Data OUT NOCOPY VARCHAR2,
240 X_Return_Status OUT NOCOPY VARCHAR2,
241 X_Freetext OUT NOCOPY FREETEXT
242 );
243
244 end CS_TP_CHOICES_PVT;