1 PACKAGE HZ_RELATIONSHIP_TYPE_V2PUB AS
2 /*$Header: ARH2RTSS.pls 120.9 2006/08/17 10:15:11 idali noship $ */
3 /*#
4 * This package contains the public APIs for relationship types.
5 * @rep:scope public
6 * @rep:product HZ
7 * @rep:displayname Relationship Type
8 * @rep:category BUSINESS_ENTITY HZ_RELATIONSHIP_TYPE
9 * @rep:lifecycle active
10 * @rep:doccd 120hztig.pdf Relationship Type APIs, Oracle Trading Community Architecture Technical Implementation Guide
11 */
12
13 --------------------------------------
14 -- declaration of record type
15 --------------------------------------
16
17 TYPE relationship_type_rec_type IS RECORD(
18 relationship_type_id NUMBER,
19 relationship_type VARCHAR2(30),
20 forward_rel_code VARCHAR2(30),
21 backward_rel_code VARCHAR2(30),
22 direction_code VARCHAR2(30),
23 hierarchical_flag VARCHAR2(1),
24 create_party_flag VARCHAR2(1),
25 allow_relate_to_self_flag VARCHAR2(1),
26 allow_circular_relationships VARCHAR2(1),
27 subject_type VARCHAR2(30),
28 object_type VARCHAR2(30),
29 status VARCHAR2(1),
30 created_by_module VARCHAR2(150),
31 application_id NUMBER,
32 multiple_parent_allowed VARCHAR2(1),
33 incl_unrelated_entities VARCHAR2(1),
34 forward_role VARCHAR2(30),
35 backward_role VARCHAR2(30)
36 );
37
38 G_MISS_REL_TYPE_REC RELATIONSHIP_TYPE_REC_TYPE;
39
40 --------------------------------------
41 -- declaration of public procedures and functions
42 --------------------------------------
43
44 /**
45 * PROCEDURE create_relationship_type
46 *
47 * DESCRIPTION
48 * Creates relationship type.
49 *
50 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
51 *
52 * ARGUMENTS
53 * IN:
54 * p_init_msg_list Initialize message stack if it is set to
55 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
56 * p_relationship_type_rec Relationship type record.
57 * IN/OUT:
58 * OUT:
59 * x_relationship_type_id Relationship type ID.
60 * x_return_status Return status after the call. The status can
61 * be FND_API.G_RET_STS_SUCCESS (success),
62 * FND_API.G_RET_STS_ERROR (error),
63 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
64 * x_msg_count Number of messages in message stack.
65 * x_msg_data Message text if x_msg_count is 1.
66 *
67 * NOTES
68 *
69 * MODIFICATION HISTORY
70 *
71 * 07-23-2001 Indrajit Sen o Created.
72 *
73 */
74
75 /*#
76 * Use this routine to create a relationship type. This API creates records in the
77 * HZ_RELATIONSHIP_TYPES table. The relationship type defines the relationships that you
78 * can create between different types of parties or other entities. This API internally
79 * creates an additional record when the forward and backward relationship codes are
80 * different, indicating that you can create the relationship in two ways.
81 * @rep:scope public
82 * @rep:lifecycle active
83 * @rep:displayname Create Relationship Type
84 * @rep:doccd 120hztig.pdf Relationship Type APIs, Oracle Trading Community Architecture Technical Implementation Guide
85 */
86
87 PROCEDURE create_relationship_type (
88 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
89 p_relationship_type_rec IN RELATIONSHIP_TYPE_REC_TYPE,
90 x_relationship_type_id OUT NOCOPY NUMBER,
91 x_return_status OUT NOCOPY VARCHAR2,
92 x_msg_count OUT NOCOPY NUMBER,
93 x_msg_data OUT NOCOPY VARCHAR2
94 );
95
96 /**
97 * PROCEDURE update_relationship_type
98 *
99 * DESCRIPTION
100 * Creates relationship type.
101 *
102 * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
103 *
104 * ARGUMENTS
105 * IN:
106 * p_init_msg_list Initialize message stack if it is set to
107 * FND_API.G_TRUE. Default is FND_API.G_FALSE.
108 * p_relationship_type_rec Relationship type record.
109 * IN/OUT:
110 * OUT:
111 * x_relationship_type_id Relationship type ID.
112 * x_return_status Return status after the call. The status can
113 * be FND_API.G_RET_STS_SUCCESS (success),
114 * FND_API.G_RET_STS_ERROR (error),
115 * FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
116 * x_msg_count Number of messages in message stack.
117 * x_msg_data Message text if x_msg_count is 1.
118 *
119 * NOTES
120 *
121 * MODIFICATION HISTORY
122 *
123 * 07-23-2001 Indrajit Sen o Created.
124 *
125 */
126
127 /*#
128 * Use this routine to update a relationship type. This API updates records
129 * in the HZ_RELATIONSHIP_TYPES table.
130 * @rep:scope public
131 * @rep:lifecycle active
132 * @rep:displayname Update Relationship Type
133 * @rep:doccd 120hztig.pdf Relationship Type APIs, Oracle Trading Community Architecture Technical Implementation Guide
134 */
135 PROCEDURE update_relationship_type (
136 p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,
137 p_relationship_type_rec IN RELATIONSHIP_TYPE_REC_TYPE,
138 p_object_version_number IN OUT NOCOPY NUMBER,
139 x_return_status OUT NOCOPY VARCHAR2,
140 x_msg_count OUT NOCOPY NUMBER,
141 x_msg_data OUT NOCOPY VARCHAR2
142 );
143
144 FUNCTION in_instance_sets (
145 p_instance_set_name IN VARCHAR2,
146 p_instance_id IN VARCHAR2
147 ) RETURN VARCHAR2;
148
149 END HZ_RELATIONSHIP_TYPE_V2PUB;