1 PACKAGE HZ_EXTENSIBILITY_PUB AS
2 /* $Header: ARHEXTSS.pls 120.1 2006/10/05 19:00:41 nsinghai noship $ */
3 /*#
4 * Contains the public APIs to create and update extensions.
5 * Extensions involve extended, custom attributes for specific entities, for example
6 * organization and person profiles.
7 * @rep:scope public
8 * @rep:product HZ
9 * @rep:displayname Extensions
10 * @rep:category BUSINESS_ENTITY HZ_ORGANIZATION
11 * @rep:category BUSINESS_ENTITY HZ_PERSON
12 * @rep:category BUSINESS_ENTITY HZ_ADDRESS
13 * @rep:category BUSINESS_ENTITY HZ_PARTY
14 * @rep:lifecycle active
15 * @rep:doccd 120hztig.pdf Extensions APIs, Oracle Trading Community Architecture Technical Implementation Guide
16 */
17
18 G_FILE_NAME CONSTANT VARCHAR2(12) := 'ARHEXTSS.pls';
19
20 G_RET_STS_SUCCESS CONSTANT VARCHAR2(1) := FND_API.g_RET_STS_SUCCESS; --'S'
21 G_RET_STS_ERROR CONSTANT VARCHAR2(1) := FND_API.g_RET_STS_ERROR; --'E'
22 G_RET_STS_UNEXP_ERROR CONSTANT VARCHAR2(1) := FND_API.g_RET_STS_UNEXP_ERROR; --'U'
23
24 G_MISS_NUM CONSTANT NUMBER := 9.99E125;
25 G_MISS_CHAR CONSTANT VARCHAR2(1) := CHR(0);
26 G_MISS_DATE CONSTANT DATE := TO_DATE('1','j');
27 G_FALSE CONSTANT VARCHAR2(1) := FND_API.G_FALSE; -- 'F'
28 G_TRUE CONSTANT VARCHAR2(1) := FND_API.G_TRUE; -- 'T'
29
30 /*#
31 * Creates or updates information in extensions tables for organization profiles.
32 * The HZ_ORG_PROFILES_EXT_B and HZ_ORG_PROFILES_EXT_TL tables hold extended, custom
33 * attributes about organizations. Use this API to maintain records in these tables
34 * for a given organization.
35 * @rep:scope public
36 * @rep:category BUSINESS_ENTITY HZ_ORGANIZATION
37 * @rep:lifecycle active
38 * @rep:displayname Create or Update Organization Profile Extension
39 * @rep:doccd 120hztig.pdf Extensions APIs, Oracle Trading Community Architecture Technical Implementation Guide
40 */
41
42 PROCEDURE Process_Organization_Record (
43 p_api_version IN NUMBER
44 ,p_org_profile_id IN NUMBER
45 ,p_attributes_row_table IN EGO_USER_ATTR_ROW_TABLE
46 ,p_attributes_data_table IN EGO_USER_ATTR_DATA_TABLE
47 ,p_change_info_table IN EGO_USER_ATTR_CHANGE_TABLE DEFAULT NULL
48 ,p_entity_id IN NUMBER DEFAULT NULL
49 ,p_entity_index IN NUMBER DEFAULT NULL
50 ,p_entity_code IN VARCHAR2 DEFAULT NULL
51 ,p_debug_level IN NUMBER DEFAULT 0
52 ,p_init_error_handler IN VARCHAR2 DEFAULT FND_API.G_TRUE
53 ,p_write_to_concurrent_log IN VARCHAR2 DEFAULT FND_API.G_FALSE
54 ,p_init_fnd_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE
55 ,p_log_errors IN VARCHAR2 DEFAULT FND_API.G_TRUE
56 ,p_add_errors_to_fnd_stack IN VARCHAR2 DEFAULT FND_API.G_FALSE
57 ,p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE
58 ,x_failed_row_id_list OUT NOCOPY VARCHAR2
59 ,x_return_status OUT NOCOPY VARCHAR2
60 ,x_errorcode OUT NOCOPY NUMBER
61 ,x_msg_count OUT NOCOPY NUMBER
62 ,x_msg_data OUT NOCOPY VARCHAR2);
63
64 /*#
65 * Creates or updates information in extensions tables for person profiles.
66 * The HZ_PER_PROFILES_EXT_B and HZ_PER_PROFILES_EXT_TL tables hold extended, custom attributes
67 * about persons. Use this API to maintain records in these tables for a given person.
68 * @rep:scope public
69 * @rep:category BUSINESS_ENTITY HZ_PERSON
70 * @rep:lifecycle active
71 * @rep:displayname Create or Update Person Profile Extension
72 * @rep:doccd 120hztig.pdf Extensions APIs, Oracle Trading Community Architecture Technical Implementation Guide
73 */
74
75 PROCEDURE Process_Person_Record (
76 p_api_version IN NUMBER
77 ,p_person_profile_id IN NUMBER
78 ,p_attributes_row_table IN EGO_USER_ATTR_ROW_TABLE
79 ,p_attributes_data_table IN EGO_USER_ATTR_DATA_TABLE
80 ,p_change_info_table IN EGO_USER_ATTR_CHANGE_TABLE DEFAULT NULL
81 ,p_entity_id IN NUMBER DEFAULT NULL
82 ,p_entity_index IN NUMBER DEFAULT NULL
83 ,p_entity_code IN VARCHAR2 DEFAULT NULL
84 ,p_debug_level IN NUMBER DEFAULT 0
85 ,p_init_error_handler IN VARCHAR2 DEFAULT FND_API.G_TRUE
86 ,p_write_to_concurrent_log IN VARCHAR2 DEFAULT FND_API.G_FALSE
87 ,p_init_fnd_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE
88 ,p_log_errors IN VARCHAR2 DEFAULT FND_API.G_TRUE
89 ,p_add_errors_to_fnd_stack IN VARCHAR2 DEFAULT FND_API.G_FALSE
90 ,p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE
91 ,x_failed_row_id_list OUT NOCOPY VARCHAR2
92 ,x_return_status OUT NOCOPY VARCHAR2
93 ,x_errorcode OUT NOCOPY NUMBER
94 ,x_msg_count OUT NOCOPY NUMBER
95 ,x_msg_data OUT NOCOPY VARCHAR2);
96
97 /*#
98 * Creates or updates information in extensions tables for locations.
99 * The HZ_LOCATIONS_EXT_B and HZ_LOCATIONS_EXT_TL tables hold extended, custom attributes about
100 * locations. Use this API to maintain records in these tables for a given location.
101 * @rep:scope public
102 * @rep:category BUSINESS_ENTITY HZ_ADDRESS
103 * @rep:lifecycle active
104 * @rep:displayname Create or Update Location Extension
105 * @rep:doccd 120hztig.pdf Extensions APIs, Oracle Trading Community Architecture Technical Implementation Guide
106 */
107
108 PROCEDURE Process_Location_Record (
109 p_api_version IN NUMBER
110 ,p_location_id IN NUMBER
111 ,p_attributes_row_table IN EGO_USER_ATTR_ROW_TABLE
112 ,p_attributes_data_table IN EGO_USER_ATTR_DATA_TABLE
113 ,p_change_info_table IN EGO_USER_ATTR_CHANGE_TABLE DEFAULT NULL
114 ,p_entity_id IN NUMBER DEFAULT NULL
115 ,p_entity_index IN NUMBER DEFAULT NULL
116 ,p_entity_code IN VARCHAR2 DEFAULT NULL
117 ,p_debug_level IN NUMBER DEFAULT 0
118 ,p_init_error_handler IN VARCHAR2 DEFAULT FND_API.G_TRUE
119 ,p_write_to_concurrent_log IN VARCHAR2 DEFAULT FND_API.G_FALSE
120 ,p_init_fnd_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE
121 ,p_log_errors IN VARCHAR2 DEFAULT FND_API.G_TRUE
122 ,p_add_errors_to_fnd_stack IN VARCHAR2 DEFAULT FND_API.G_FALSE
123 ,p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE
124 ,x_failed_row_id_list OUT NOCOPY VARCHAR2
125 ,x_return_status OUT NOCOPY VARCHAR2
126 ,x_errorcode OUT NOCOPY NUMBER
127 ,x_msg_count OUT NOCOPY NUMBER
128 ,x_msg_data OUT NOCOPY VARCHAR2);
129
130 /*#
131 * Creates or updates information in extensions tables for party sites.
132 * The HZ_PARTY_SITES_EXT_B and HZ_PARTY_SITES_EXT_TL tables hold extended, custom attributes
133 * about party sites. Use this API to maintain records in these tables for a given party site.
134 * @rep:scope public
135 * @rep:category BUSINESS_ENTITY HZ_ADDRESS
136 * @rep:lifecycle active
137 * @rep:displayname Create or Update Party Site Extension
138 * @rep:doccd 120hztig.pdf Extensions APIs, Oracle Trading Community Architecture Technical Implementation Guide
139 */
140
141 PROCEDURE Process_PartySite_Record (
142 p_api_version IN NUMBER
143 ,p_party_site_id IN NUMBER
144 ,p_attributes_row_table IN EGO_USER_ATTR_ROW_TABLE
145 ,p_attributes_data_table IN EGO_USER_ATTR_DATA_TABLE
146 ,p_change_info_table IN EGO_USER_ATTR_CHANGE_TABLE DEFAULT NULL
147 ,p_entity_id IN NUMBER DEFAULT NULL
148 ,p_entity_index IN NUMBER DEFAULT NULL
149 ,p_entity_code IN VARCHAR2 DEFAULT NULL
150 ,p_debug_level IN NUMBER DEFAULT 0
151 ,p_init_error_handler IN VARCHAR2 DEFAULT FND_API.G_TRUE
152 ,p_write_to_concurrent_log IN VARCHAR2 DEFAULT FND_API.G_FALSE
153 ,p_init_fnd_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE
154 ,p_log_errors IN VARCHAR2 DEFAULT FND_API.G_TRUE
155 ,p_add_errors_to_fnd_stack IN VARCHAR2 DEFAULT FND_API.G_FALSE
156 ,p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE
157 ,x_failed_row_id_list OUT NOCOPY VARCHAR2
158 ,x_return_status OUT NOCOPY VARCHAR2
159 ,x_errorcode OUT NOCOPY NUMBER
160 ,x_msg_count OUT NOCOPY NUMBER
161 ,x_msg_data OUT NOCOPY VARCHAR2);
162
163 PROCEDURE Get_User_Attrs_For_Item (
164 p_api_version IN NUMBER
165 ,p_org_profile_id IN NUMBER
166 ,p_attr_group_request_table IN EGO_ATTR_GROUP_REQUEST_TABLE
167 ,p_entity_id IN NUMBER DEFAULT NULL
168 ,p_entity_index IN NUMBER DEFAULT NULL
169 ,p_entity_code IN VARCHAR2 DEFAULT NULL
170 ,p_debug_level IN NUMBER DEFAULT 0
171 ,p_init_error_handler IN VARCHAR2 DEFAULT FND_API.G_TRUE
172 ,p_init_fnd_msg_list IN VARCHAR2 DEFAULT FND_API.G_FALSE
173 ,p_add_errors_to_fnd_stack IN VARCHAR2 DEFAULT FND_API.G_FALSE
174 ,p_commit IN VARCHAR2 DEFAULT FND_API.G_FALSE
175 ,x_attributes_row_table OUT NOCOPY EGO_USER_ATTR_ROW_TABLE
176 ,x_attributes_data_table OUT NOCOPY EGO_USER_ATTR_DATA_TABLE
177 ,x_return_status OUT NOCOPY VARCHAR2
178 ,x_errorcode OUT NOCOPY NUMBER
179 ,x_msg_count OUT NOCOPY NUMBER
180 ,x_msg_data OUT NOCOPY VARCHAR2);
181
182 END HZ_EXTENSIBILITY_PUB;
[Home] [Help]