1 PACKAGE GMO_DOCUMENT_NUMBERS_GRP
2 /* $Header: GMOGDNMS.pls 120.4 2006/01/19 09:26 swasubra noship $ */
3
4 AUTHID CURRENT_USER AS
5
6 --The package name
7 G_PKG_NAME CONSTANT VARCHAR2(30) := 'GMO_DOCUMENT_NUMBERS_GRP';
8
9 --This constant represents the valus of the zero pad option when padding used.
10 G_ZERO_PAD_YES CONSTANT VARCHAR2(1) := 'Y';
11
12 --This constant represents the value of the zero pad option when padding is not used.
13 G_ZERO_PAD_NO CONSTANT VARCHAR2(1) := 'N';
14
15 --This constant represents the value of the doc type when it set to automatic.
16 G_DOC_TYPE_AUTOMATIC CONSTANT VARCHAR2(1) := 'A';
17
18 --This constant represents the value of the doc type when it set to manual.
19 G_DOC_TYPE_MANUAL CONSTANT VARCHAR2(1) := 'M';
20
21
22 -- Start of comments
23 -- API name : GET_DOCUMENT_NUMBER_TYPE
24 -- Type : Public.
25 -- Function : This PROCEDURE is used to obtain the document number type associated with the
26 -- specified organization ID and transaction type.
27 -- Pre-reqs : None.
28 -- Parameters :
29 -- IN :P_API_VERSION(Required) - NUMBER - Specifies the API version.
30
31 -- P_INIT_MSG_LIST(Optional) - VARCHAR2 - Specifies if the message list should be initialized.
32 -- Default = FND_API.G_FALSE
33
34 -- P_ORGANIZATION_ID(Optional) - NUMBER - The organization ID representing the transaction.
35 --
36 -- P_TRANSACTION_TYPE(Required) - VARCHAR2 - The transaction type.
37
38 -- OUT :X_RETURN_STATUS - VARCHAR2 - The return status.
39 -- X_MSG_COUNT - NUMBER - The message count.
40 -- X_MSG_DATA - VARCHAR2 - The message data.
41 --
42 -- X_DOCUMENT_NUMBER_TYPE - VARCHAR2 - The document number type.
43 --
44 -- Version :Current version 1.0
45 -- Initial version 1.0
46 --
47 -- End of comments
48 PROCEDURE GET_DOCUMENT_NUMBER_TYPE
49 (P_API_VERSION IN NUMBER,
50 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
51 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
52 X_MSG_COUNT OUT NOCOPY NUMBER,
53 X_MSG_DATA OUT NOCOPY VARCHAR2,
54 P_ORGANIZATION_ID IN NUMBER,
55 P_TRANSACTION_TYPE IN VARCHAR2,
56 X_DOCUMENT_NUMBER_TYPE OUT NOCOPY VARCHAR2);
57
58
59
60 -- Start of comments
61 -- API name : GET_VALUE
62 -- Type : Public.
63 -- Function : This PROCEDURE is used to obtain the next document number in sequence associated with the
64 -- specified organization ID and transaction type.
65 -- Pre-reqs : None.
66 -- Parameters :
67 -- IN :P_API_VERSION(Required) - NUMBER - Specifies the API version.
68
69 -- P_INIT_MSG_LIST(Optional) - VARCHAR2 - Specifies if the message list should be initialized.
70 -- Default = FND_API.G_FALSE
71
72 -- P_ORGANIZATION_ID(Optional) - NUMBER - The organization ID representing the transaction.
73 --
74 -- P_TRANSACTION_TYPE(Required) - VARCHAR2 - The transaction type.
75
76 -- OUT :X_RETURN_STATUS - VARCHAR2 - The return status.
77 -- X_MSG_COUNT - NUMBER - The message count.
78 -- X_MSG_DATA - VARCHAR2 - The message data.
79 --
80 -- X_VALUE - VARCHAR2 - The next document number in sequence.
81 --
82 -- Version :Current version 1.0
83 -- Initial version 1.0
84 --
85 -- End of comments
86 PROCEDURE GET_NEXT_VALUE
87 (P_API_VERSION IN NUMBER,
88 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
89 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
90 X_MSG_COUNT OUT NOCOPY NUMBER,
91 X_MSG_DATA OUT NOCOPY VARCHAR2,
92 P_ORGANIZATION_ID IN NUMBER,
93 P_TRANSACTION_TYPE IN VARCHAR2,
94 X_VALUE OUT NOCOPY VARCHAR2);
95
96
97 -- Start of comments
98 -- API name : DOES_DOCUMENT_NUMBER_EXIST
99 -- Type : Public.
100 -- Function : This procedure is used to check if a document number entry exists for the specified
101 -- organization and transaction type.
102
103 -- Pre-reqs : None.
104 -- Parameters :
105 -- IN :P_API_VERSION(Required) - NUMBER - Specifies the API version.
106
107 -- P_INIT_MSG_LIST(Optional) - VARCHAR2 - Specifies if the message list should be initialized.
108 -- Default = FND_API.G_FALSE
109
110 -- P_ORGANIZATION_ID(Optional) - NUMBER - The organization ID representing the transaction.
111 --
112 -- P_TRANSACTION_TYPE(Required) - VARCHAR2 - The transaction type.
113
114 -- OUT :X_RETURN_STATUS - VARCHAR2 - The return status.
115 -- X_MSG_COUNT - NUMBER - The message count.
116 -- X_MSG_DATA - VARCHAR2 - The message data.
117 --
118 -- X_DOCUMENT_NUMBER_EXISTS - VARCHAR2 - A flag that indicates if a document number exists for the specified
119 -- organization and transaction type.
120 --
121 -- Version :Current version 1.0
122 -- Initial version 1.0
123 --
124 -- End of comments
125 PROCEDURE DOES_DOCUMENT_NUMBER_EXIST
126 (P_API_VERSION IN NUMBER,
127 P_INIT_MSG_LIST IN VARCHAR2 DEFAULT FND_API.G_FALSE,
128 X_RETURN_STATUS OUT NOCOPY VARCHAR2,
129 X_MSG_COUNT OUT NOCOPY NUMBER,
130 X_MSG_DATA OUT NOCOPY VARCHAR2,
131 P_ORGANIZATION_ID IN NUMBER,
132 P_TRANSACTION_TYPE IN VARCHAR2,
133 X_DOCUMENT_NUMBER_EXISTS OUT NOCOPY VARCHAR2);
134
135
136 END GMO_DOCUMENT_NUMBERS_GRP;
[Home] [Help]