1 PACKAGE jtf_objects_pub AUTHID CURRENT_USER AS
2 /* $Header: jtfptkos.pls 120.3 2006/09/29 22:23:48 twan ship $ */
3 /*#
4 * This is the public interface to the Comon Applications Calendar business metadata.
5 * It allows various meta-data manipulation. It is also known as JTF Objects
6 *
7 * @rep:scope private
8 * @rep:product CAC
9 * @rep:lifecycle active
10 * @rep:displayname Object Metadata
11 * @rep:compatibility S
12 * @rep:category BUSINESS_ENTITY CAC_BUSINESS_OBJECT_META_DATA
13 */
14
15 /*#
16 * Creates the query statement for given metadata.
17 * The metadata are coming from the table <code>JTF_OBJECTS_B<code>.
18 * This method returns null if the SQL statement cannot be created
19 * (for example, the parameter from_table is null).
20 *
21 * @param select_id the source id to be queried
22 * @param select_name the source name to be queried
23 * @param select_details the additional source details to be queried
24 * @param from_table the table name to be queried from
25 * @param where_clause the selection criteria to be applied to the query
26 * @param p_inactive_clause the additional exclusion criteria to be applied to the query
27 * @param order_by_clause the sorting criteria to be applied to the query result
28 * @return the query statement
29 * @paraminfo {@rep:precision 6000}
30 *
31 * @rep:scope private
32 * @rep:lifecycle active
33 * @rep:displayname Create Select Statement
34 * @rep:compatibility N
35 */
36 FUNCTION jtf_obj_select_stmt (
37 select_id IN jtf_objects_b.select_id%TYPE DEFAULT NULL,
38 select_name IN jtf_objects_b.select_name%TYPE DEFAULT NULL,
39 select_details IN jtf_objects_b.select_details%TYPE DEFAULT NULL,
40 from_table IN jtf_objects_b.from_table%TYPE DEFAULT NULL,
41 where_clause IN jtf_objects_b.where_clause%TYPE DEFAULT NULL,
42 p_inactive_clause IN jtf_objects_b.inactive_clause%TYPE DEFAULT NULL,
43 order_by_clause IN jtf_objects_b.order_by_clause%TYPE DEFAULT NULL
44 ) RETURN VARCHAR2;
45
46 /*#
47 * Creates the query statement for given metadata. It also checks syntax
48 * of the formed query and throws an error for an invalid query.
49 * @see #jtf_obj_select_stmt
50 *
51 * @param p_api_version the standard API version number
52 * @param p_init_msg_list the standard API flag allows API callers to request that the API does the initialization of the message list on their behalf. By default, the message list will not be initialized.
53 * @param p_commit the standard API flag is used by API callers to ask the API to commit on their behalf after performing its function. By default, the commit will not be performed.
54 * @param x_return_status returns the result of all the operations performed by the API and must have one of the following values:
55 * <LI><Code>FND_API.G_RET_STS_SUCCESS</Code>
56 * <LI><Code>FND_API.G_RET_STS_ERROR</Code>
57 * <LI><Code>FND_API.G_RET_STS_UNEXP_ERROR</Code>
58 * @param x_msg_count returns the number of messages in the API message list
59 * @param x_msg_data returns the message in an encoded format if <code>x_msg_count</code> returns number one.
60 * @param p_select_id the id to be queried
61 * @param p_select_name the name to be queried
62 * @param p_select_details the additional details to be queried
63 * @param p_from_table the table name to be queried from
64 * @param p_where_clause the selection criteria to be applied to the query
65 * @param p_inactive_clause the additional exclusion criteria to be applied to the query
66 * @param p_order_by_clause the sorting criteria to be applied to the result
67 * @param x_sql_statement returns the query statement or null
68 * @paraminfo {@rep:precision 6000}
69 *
70 * @rep:scope private
71 * @rep:lifecycle active
72 * @rep:displayname Create and Check Select Statement
73 * @rep:compatibility S
74 */
75 PROCEDURE check_syntax (
76 p_api_version IN NUMBER,
77 p_init_msg_list IN VARCHAR2 DEFAULT fnd_api.g_false,
78 p_commit IN VARCHAR2 DEFAULT fnd_api.g_false,
79 p_select_id IN jtf_objects_b.select_id%TYPE DEFAULT NULL,
80 p_select_name IN jtf_objects_b.select_name%TYPE DEFAULT NULL,
81 p_select_details IN jtf_objects_b.select_details%TYPE DEFAULT NULL,
82 p_from_table IN jtf_objects_b.from_table%TYPE DEFAULT NULL,
83 p_where_clause IN jtf_objects_b.where_clause%TYPE DEFAULT NULL,
84 p_inactive_clause IN jtf_objects_b.inactive_clause%TYPE DEFAULT NULL,
85 p_order_by_clause IN jtf_objects_b.order_by_clause%TYPE DEFAULT NULL,
86 x_return_status OUT NOCOPY VARCHAR2,
87 x_msg_count OUT NOCOPY NUMBER,
88 x_msg_data OUT NOCOPY VARCHAR2,
89 x_sql_statement OUT NOCOPY VARCHAR2
90 );
91
92 --
93 -- Input record structure
94 --
95 TYPE PG_INPUT_REC IS RECORD
96 (
97 ENTITY VARCHAR2(30),
98 OBJECT_CODE VARCHAR2(30),
99 SOURCE_OBJECT_ID NUMBER,
100 TASK_ID NUMBER,
101 TASK_ASSIGNMENT_ID NUMBER,
102 CAL_ITEM_ID NUMBER,
103 SCHEDULE_ID NUMBER,
104 HR_CAL_EVENT_ID NUMBER
105 );
106
107 /*#
108 * Initializes the cache for objects page and parameters
109 *
110 * @paraminfo {@rep:precision 6000}
111 *
112 * @rep:scope private
113 * @rep:lifecycle active
114 * @rep:displayname Get JTF Objects Page drilldown
115 * @rep:compatibility S
116 */
117 PROCEDURE initialize_cache;
118
119 /*#
120 * Determines the page and parameters for any entity
121 *
122 * @param p_input_rec the input structure used for fetching data
123 * @param x_pg_function returns the page function
124 * @param x_pg_parameters returns the page parameters in the format param1=valu1¶m2=value2
125 * @paraminfo {@rep:precision 6000}
126 *
127 * @rep:scope private
128 * @rep:lifecycle active
129 * @rep:displayname Get JTF Objects Page drilldown
130 * @rep:compatibility S
131 */
132 PROCEDURE get_drilldown_page (
133 p_input_rec IN PG_INPUT_REC,
134 x_pg_function OUT NOCOPY VARCHAR2,
135 x_pg_parameters OUT NOCOPY VARCHAR2
136 );
137
138 END jtf_objects_pub;
[Home] [Help]