DBA Data[Home] [Help]

PACKAGE: APPS.HZ_HIERARCHY_PUB

Source


1 PACKAGE HZ_HIERARCHY_PUB AS
2 /*$Header: ARHHINSS.pls 120.2 2005/06/16 21:11:59 jhuang noship $*/
3 
4 -----------------------------
5 -- declaration of record type
6 -----------------------------
7 
8 TYPE hierarchy_node_rec_type IS RECORD(
9     hierarchy_type             VARCHAR2(30),
10     parent_id                  NUMBER(15),
11     parent_table_name          VARCHAR2(30),
12     parent_object_type         VARCHAR2(30),
13     child_id                   NUMBER(15),
14     child_table_name           VARCHAR2(30),
15     child_object_type          VARCHAR2(30),
16     effective_start_date       DATE,
17     effective_end_date         DATE,
18     status                     VARCHAR2(1),
19     relationship_id            NUMBER(15),
20     actual_content_source      VARCHAR2(30)
21 );
22 
23 -------------------------------------------------
24 -- declaration of public procedures and functions
25 -------------------------------------------------
26 
27 /**
28  * PROCEDURE create_link
29  *
30  * DESCRIPTION
31  *     Creates a hierarchial relationship between two nodes.
32  *
33  * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
34  *
35  * ARGUMENTS
36  *   IN:
37  *     p_init_msg_list                Initialize message stack if it is set to
38  *                                    FND_API.G_TRUE. Default is FND_API.G_FALSE.
39  *     p_hierarchy_node_rec           Hierarchy node record.
40  *   IN/OUT:
41  *   OUT:
42  *     x_return_status                Return status after the call. The status can
43  *                                    be FND_API.G_RET_STS_SUCCESS (success),
44  *                                    FND_API.G_RET_STS_ERROR (error),
45  *                                    FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
46  *     x_msg_count                    Number of messages in message stack.
47  *     x_msg_data                     Message text if x_msg_count is 1.
48  *
49  * NOTES
50  *
51  * MODIFICATION HISTORY
52  *
53  *    31-JAN-00  Indrajit Sen   o Created
54  *
55  */
56 
57 PROCEDURE create_link(
58     p_init_msg_list                         IN      VARCHAR2 := FND_API.G_FALSE,
59     p_hierarchy_node_rec                    IN      HIERARCHY_NODE_REC_TYPE,
60     x_return_status                         OUT     NOCOPY VARCHAR2,
61     x_msg_count                             OUT     NOCOPY NUMBER,
62     x_msg_data                              OUT     NOCOPY VARCHAR2
63 );
64 
65 
66 /**
67  * PROCEDURE update_link
68  *
69  * DESCRIPTION
70  *     Updates a hierarchial relationship between two nodes.
71  *
72  * EXTERNAL PROCEDURES/FUNCTIONS ACCESSED
73  *
74  * ARGUMENTS
75  *   IN:
76  *     p_init_msg_list                Initialize message stack if it is set to
77  *                                    FND_API.G_TRUE. Default is FND_API.G_FALSE.
78  *     p_hierarchy_node_rec           Hierarchy node record.
79  *   IN/OUT:
80  *   OUT:
81  *     x_return_status                Return status after the call. The status can
82  *                                    be FND_API.G_RET_STS_SUCCESS (success),
83  *                                    FND_API.G_RET_STS_ERROR (error),
84  *                                    FND_API.G_RET_STS_UNEXP_ERROR (unexpected error).
85  *     x_msg_count                    Number of messages in message stack.
86  *     x_msg_data                     Message text if x_msg_count is 1.
87  *
88  * NOTES
89  *
90  * MODIFICATION HISTORY
91  *
92  *    31-JAN-00  Indrajit Sen   o Created
93  *
94  */
95 
96 PROCEDURE update_link(
97     p_init_msg_list                         IN      VARCHAR2 := FND_API.G_FALSE,
98     p_hierarchy_node_rec                    IN      HIERARCHY_NODE_REC_TYPE,
99     x_return_status                         OUT     NOCOPY VARCHAR2,
100     x_msg_count                             OUT     NOCOPY NUMBER,
101     x_msg_data                              OUT     NOCOPY VARCHAR2
102 );
103 
104 
105 /**
106  * PROCEDURE
107  *     convert_rel_type
108  *
109  * DESCRIPTION
110  *     Procedure to convert a particular relationship type
111  *     to a hierarchical relationship type
112  *
113  * SCOPE - Public
114  *
115  * ARGUMENTS  : IN:
116  *                       p_rel_type
117  *                       p_multi_parent_allowed
118  *                       p_incl_unrelated_entities
119  *              OUT:
120  *          IN/ OUT:
121  *
122  * RETURNS    :
123  *                       Errbuf
124  *                       Retcode
125  *
126  * NOTES      : p_rel_type can be non-hierarchical relationship type
127  *              p_multi_parent_allowed is Y/N
128  *              p_incl_unrelated_entities is Y/N
129  *
130  * MODIFICATION HISTORY
131  *
132  *    31-JAN-00  Indrajit Sen   o Created
133  *
134  */
135 
136 PROCEDURE convert_rel_type(
137     Errbuf                                  OUT     NOCOPY VARCHAR2,
138     Retcode                                 OUT     NOCOPY VARCHAR2,
139     p_rel_type                              IN      VARCHAR2,
140     p_multi_parent_allowed                  IN      VARCHAR2 DEFAULT 'N',
141     p_incl_unrelated_entities               IN      VARCHAR2 DEFAULT 'N'
142 );
143 
144 END HZ_HIERARCHY_PUB;