DBA Data[Home] [Help]

PACKAGE: APPS.AK_QUERYOBJ_GRP

Source


1 package AK_QUERYOBJ_GRP as
2 /* $Header: akdgqrys.pls 120.2 2005/09/15 22:26:40 tshort ship $ */
3 
4 -- Global constants holding the package and file names to be used by
5 -- messaging routines in the case of an unexpected error.
6 
7 G_PKG_NAME      CONSTANT    VARCHAR2(30) := 'AK_QUERYOBJ_GRP';
8 --
9 -- Procedure specs
10 --
11 --=======================================================
12 --  Procedure   CREATE_QUERY_OBJECT
13 --
14 --  Usage       Group API for creating a query objec
15 --
16 --  Desc        Calls the private API to creates a query object
17 --              using the given info
18 --
19 --  Results     The API returns the standard p_return_status parameter
20 --              indicating one of the standard return statuses :
21 --                  * Unexpected error
22 --                  * Error
23 --                  * Success
24 --  Parameters  Query object columns
25 --
26 --  Version     Initial version number  =   1.0
27 --  History     Current version number  =   1.0
28 --=======================================================
29 procedure CREATE_QUERY_OBJECT (
30 p_validation_level         IN      NUMBER := FND_API.G_VALID_LEVEL_FULL,
31 p_api_version_number       IN      NUMBER,
32 p_init_msg_tbl             IN      BOOLEAN := FALSE,
33 p_msg_count                OUT NOCOPY     NUMBER,
34 p_msg_data                 OUT NOCOPY     VARCHAR2,
35 p_return_status            OUT NOCOPY     VARCHAR2,
36 p_query_code				 IN      VARCHAR2,
37 p_application_id			 IN      NUMBER,
38 p_created_by               IN     NUMBER := FND_API.G_MISS_NUM,
39 p_creation_date            IN      DATE := FND_API.G_MISS_DATE,
40 p_last_updated_by          IN     NUMBER := FND_API.G_MISS_NUM,
41 p_last_update_date         IN      DATE := FND_API.G_MISS_DATE,
42 p_last_update_login        IN     NUMBER := FND_API.G_MISS_NUM
43 );
44 
45 --=======================================================
46 --  Procedure   CREATE_QUERY_OBJECT_LINE
47 --
48 --  Usage       Group API for creating a query object line
49 --
50 --  Desc        Calls the private API to creates a query object line
51 --              using the given info
52 --
53 --  Results     The API returns the standard p_return_status parameter
54 --              indicating one of the standard return statuses :
55 --                  * Unexpected error
56 --                  * Error
57 --                  * Success
58 --  Parameters  Query object line columns
59 --
60 --  Version     Initial version number  =   1.0
61 --  History     Current version number  =   1.0
62 --=======================================================
63 procedure CREATE_QUERY_OBJECT_LINE (
64 p_validation_level         IN      NUMBER := FND_API.G_VALID_LEVEL_FULL,
65 p_api_version_number       IN      NUMBER,
66 p_init_msg_tbl             IN      BOOLEAN := FALSE,
67 p_msg_count                OUT NOCOPY     NUMBER,
68 p_msg_data                 OUT NOCOPY     VARCHAR2,
69 p_return_status            OUT NOCOPY     VARCHAR2,
70 p_query_code				 IN      VARCHAR2,
71 p_seq_num					 IN      NUMBER,
72 p_query_line_type			 IN		 VARCHAR2 := FND_API.G_MISS_CHAR,
73 p_query_line				 IN		 VARCHAR2 := FND_API.G_MISS_CHAR,
74 p_linked_parameter		 IN		 VARCHAR2 := FND_API.G_MISS_CHAR,
75 p_created_by               IN     NUMBER := FND_API.G_MISS_NUM,
76 p_creation_date            IN      DATE := FND_API.G_MISS_DATE,
77 p_last_updated_by          IN     NUMBER := FND_API.G_MISS_NUM,
78 p_last_update_date         IN      DATE := FND_API.G_MISS_DATE,
79 p_last_update_login        IN     NUMBER := FND_API.G_MISS_NUM
80 );
81 
82 --========================================================
83 --  Procedure   DOWNLOAD_QUERY_OBJECT
84 --
85 --  Usage       Group API for downloading query objects
86 --
87 --  Desc        This API first write out standard loader
88 --              file header for attributes to a flat file.
89 --              Then it calls the private API to extract the
90 --              attributes selected by application ID or by
91 --              key values from the database to the output file.
92 --
93 --  Results     The API returns the standard p_return_status parameter
94 --              indicating one of the standard return statuses :
95 --                  * Unexpected error
96 --                  * Error
97 --                  * Success
98 --  Parameters
99 --              p_nls_language : IN optional
100 --                  NLS language for database. If none if given,
101 --                  the current NLS language will be used.
102 --
103 --              One of the following three parameters must be given:
104 --
105 --              p_application_id : IN optional
106 --                  If given, all query objects for this application ID
107 --                  will be written to the output file.
108 --              p_application_short_name : IN optional
109 --                  If given, all query objects for this application short
110 --                  name will be written to the output file.
111 --                  Application short name will be ignored if an
112 --                  application ID is given.
113 --              p_queryobj_pk_tbl : IN optional
114 --                  If given, only query objects whose key values are
115 --                  included in this table will be written to the
116 --                  output file.
117 --
118 --
119 --  Version     Initial version number  =   1.0
120 --  History     Current version number  =   1.0
121 --=======================================================
122 procedure DOWNLOAD_QUERY_OBJECT (
123 p_validation_level         IN      NUMBER := FND_API.G_VALID_LEVEL_FULL,
124 p_api_version_number       IN      NUMBER,
125 p_init_msg_tbl             IN      BOOLEAN := FALSE,
126 p_msg_count                OUT NOCOPY     NUMBER,
127 p_msg_data                 OUT NOCOPY     VARCHAR2,
128 p_return_status            OUT NOCOPY     VARCHAR2,
129 p_nls_language             IN      VARCHAR2 := FND_API.G_MISS_CHAR,
130 p_application_id           IN      NUMBER := FND_API.G_MISS_NUM,
131 p_application_short_name   IN      VARCHAR2 := FND_API.G_MISS_CHAR,
132 p_queryobj_pk_tbl          IN      AK_QUERYOBJ_PUB.queryobj_PK_Tbl_Type :=
133 AK_QUERYOBJ_PUB.G_MISS_QUERYOBJ_PK_TBL
134 );
135 
136 end AK_QUERYOBJ_GRP;