DBA Data[Home] [Help]

PACKAGE: APPS.FND_OAM_DS_ALGOS_PKG

Source


1 PACKAGE FND_OAM_DS_ALGOS_PKG as
2 /* $Header: AFOAMDSALGOS.pls 120.3 2006/01/17 11:40 ilawler noship $ */
3 
4    ---------------
5    -- Constants --
6    ---------------
7 
8    ---------------------------------
9    -- Public Procedures/Functions --
10    ---------------------------------
11 
12    -- This function converts an algorithm name into its corresponding ID. This method does not
13    -- traverse the use_algo_id.
14    -- Invariants:
15    --   None.
16    -- Parameter(s):
17    --   p_display_name          Algorithm Display Name to lookup
18    -- Returns:
19    --   Corresponding algo_id for the name.
20    -- Exception(s):
21    --   NO_DATA_FOUND           Thrown when the algo_name is null or not found.
22    FUNCTION GET_ALGO_ID(p_display_name  IN VARCHAR2)
23       RETURN NUMBER;
24 
25    -- This API is used to resolve an algorithm ID into value text that can be directly inserted into a SQL statement.
26    -- Invariants:
27    --   None.
28    -- Parameter(s):
29    --   p_algo_id               Algorithm ID to resolve
30    --   p_table_owner           Used for algorithm token substitution, represents the owner of the target table.
31    --   p_table_name            Used for algorithm token substitution, represents the target table.
32    --   p_column_name           Used for algorithm token substitution, represents the target column in the target table.
33    --   x_new_column_value      SQL Text that can be inserted directly into a SQL statement.
34    -- Exception(s):
35    --   NO_DATA_FOUND           Thrown when the algo_id is invalid.
36    --   VALUE_ERROR             When the resolved algo text is beyond the max length.
37    PROCEDURE RESOLVE_ALGO_ID(p_algo_id                  IN NUMBER,
38                              p_table_owner              IN VARCHAR2 DEFAULT NULL,
39                              p_table_name               IN VARCHAR2 DEFAULT NULL,
40                              p_column_name              IN VARCHAR2 DEFAULT NULL,
41                              x_new_column_value         OUT NOCOPY VARCHAR2,
42                              x_weight_modifier          OUT NOCOPY NUMBER);
43 
44    -- This API is used to lookup the default algorithm for a given datatype.  Uses the DEFAULT_FOR_DATATYPE_FLAG in
45    -- the DS_ALGOS_B table.
46    -- Invariants:
47    --   None.  Low enough level that there's no safety harness to higher state.
48    -- Parameter(s):
49    --   p_datatype              Datatype from DSCFG_API_PKG.G_DATATYPE_*
50    --
51    --   x_algo_id               Found default algorithm ID.
52    -- Exception(s):
53    --   NO_DATA_FOUND           Thrown when no default is flagged
54    --   TOO_MANY_ROWS           Thrown when more than one algorithm is marked as the default
55    PROCEDURE GET_DEFAULT_ALGO_FOR_DATATYPE(p_datatype   IN VARCHAR2,
56                                            x_algo_id    OUT NOCOPY NUMBER);
57 
58 
59    --procedures required by FNDLOADER
60 
61   procedure LOAD_ROW (
62       X_ALGO_ID             in NUMBER,
63       X_START_DATE          IN DATE,
64       X_END_DATE            IN DATE,
65       X_USE_ALGO_ID         IN NUMBER,
66       X_DEFAULT_FOR_DATATYPE_FLAG IN VARCHAR2,
67       X_DATATYPE            IN VARCHAR2,
68       X_ALGO_TEXT           IN VARCHAR2,
69       X_WEIGHT_MODIFIER     IN NUMBER,
70       X_OWNER               in VARCHAR2,
71         X_DISPLAY_NAME        IN VARCHAR2,
72       X_DESCRIPTION         IN VARCHAR2,
73       x_custom_mode         in varchar2,
74       x_last_update_date    in varchar2);
75 
76  procedure LOAD_ROW (
77       X_ALGO_ID             in NUMBER,
78       X_START_DATE          IN DATE,
79       X_END_DATE            IN DATE,
80       X_USE_ALGO_ID         IN NUMBER,
81       X_DEFAULT_FOR_DATATYPE_FLAG IN VARCHAR2,
82       X_DATATYPE            IN VARCHAR2,
83       X_ALGO_TEXT           IN VARCHAR2,
84       X_WEIGHT_MODIFIER     IN NUMBER,
85       X_OWNER               in VARCHAR2,
86         X_DISPLAY_NAME        IN VARCHAR2,
87       X_DESCRIPTION         IN VARCHAR2);
88 
89 
90    procedure TRANSLATE_ROW (
91       X_ALGO_ID             in NUMBER,
92         X_DISPLAY_NAME        IN VARCHAR2,
93       X_DESCRIPTION         IN VARCHAR2,
94       X_OWNER               in  VARCHAR2,
95       X_CUSTOM_MODE                   in        VARCHAR2,
96       X_LAST_UPDATE_DATE          in    VARCHAR2);
97 
98    procedure TRANSLATE_ROW (
99       X_ALGO_ID             in NUMBER,
100         X_DISPLAY_NAME        IN VARCHAR2,
101       X_DESCRIPTION         IN VARCHAR2,
102       X_OWNER               in  VARCHAR2);
103 
104   procedure INSERT_ROW (
105       X_ROWID               in out nocopy VARCHAR2,
106       X_ALGO_ID             in NUMBER,
107         X_DISPLAY_NAME        IN VARCHAR2,
108       X_DESCRIPTION         IN VARCHAR2,
109       X_START_DATE          IN DATE,
110       X_END_DATE            IN DATE,
111       X_USE_ALGO_ID         IN NUMBER,
112       X_DEFAULT_FOR_DATATYPE_FLAG IN VARCHAR2,
113       X_DATATYPE            IN VARCHAR2,
114       X_ALGO_TEXT           IN VARCHAR2,
115       X_WEIGHT_MODIFIER     IN NUMBER,
116       X_CREATED_BY          in NUMBER,
117       X_CREATION_DATE       in DATE,
118       X_LAST_UPDATED_BY     in NUMBER,
119       X_LAST_UPDATE_DATE    in DATE,
120       X_LAST_UPDATE_LOGIN   in NUMBER);
121 
122   procedure LOCK_ROW (
123       X_ROWID               in out nocopy VARCHAR2,
124       X_ALGO_ID             in NUMBER,
125         X_DISPLAY_NAME        IN VARCHAR2,
126       X_DESCRIPTION         IN VARCHAR2,
127       X_START_DATE          IN DATE,
128       X_END_DATE            IN DATE,
129       X_USE_ALGO_ID         IN NUMBER,
130       X_DEFAULT_FOR_DATATYPE_FLAG IN VARCHAR2,
131       X_DATATYPE            IN VARCHAR2,
132       X_ALGO_TEXT           IN VARCHAR2,
133       X_WEIGHT_MODIFIER     IN NUMBER,
134       X_CREATED_BY          in NUMBER,
135       X_CREATION_DATE       in DATE,
136       X_LAST_UPDATED_BY     in NUMBER,
137       X_LAST_UPDATE_DATE    in DATE,
138       X_LAST_UPDATE_LOGIN   in NUMBER);
139 
140   procedure UPDATE_ROW (
141       X_ALGO_ID             in NUMBER,
142         X_DISPLAY_NAME        IN VARCHAR2,
143       X_DESCRIPTION         IN VARCHAR2,
144       X_START_DATE          IN DATE,
145       X_END_DATE            IN DATE,
146       X_USE_ALGO_ID         IN NUMBER,
147       X_DEFAULT_FOR_DATATYPE_FLAG IN VARCHAR2,
148       X_DATATYPE            IN VARCHAR2,
149       X_ALGO_TEXT           IN VARCHAR2,
150       X_WEIGHT_MODIFIER     IN NUMBER,
151       X_LAST_UPDATED_BY     in NUMBER,
152       X_LAST_UPDATE_DATE    in DATE,
153       X_LAST_UPDATE_LOGIN   in NUMBER);
154 
155 
156   procedure DELETE_ROW (
157       X_ALGO_ID           in NUMBER);
158 
159   procedure ADD_LANGUAGE;
160 
161   procedure TRANSLATE_ROW
162   (
163       x_ALGO_ID             in NUMBER,
164       x_DISPLAY_NAME        in varchar2,
165       X_LAST_UPDATED_BY     in NUMBER,
166       X_LAST_UPDATE_DATE    in DATE,
167       X_LAST_UPDATE_LOGIN   in NUMBER);
168 
169 END FND_OAM_DS_ALGOS_PKG;