DBA Data[Home] [Help]

PACKAGE: APPS.FND_OAM_DSCFG_UTILS_PKG

Source


1 PACKAGE FND_OAM_DSCFG_UTILS_PKG AUTHID CURRENT_USER as
2 /* $Header: AFOAMDSCUTILS.pls 120.1 2005/12/19 09:47 ilawler noship $ */
3 
4    ---------------
5    -- Constants --
6    ---------------
7 
8    ---------------------------------
9    -- Public Procedures/Functions --
10    ---------------------------------
11 
12    -- Converts booleans to their canonical representation
13    -- Invariants:
14    --   None
15    -- Parameters:
16    --   p_boolean               Input boolean
17    -- Returns:
18    --   FND_API.G_TRUE for TRUE, FND_API.G_FALSE for FALSE.
19    -- Exceptions:
20    --   None
21    FUNCTION BOOLEAN_TO_CANONICAL(p_boolean              IN BOOLEAN)
22       RETURN VARCHAR2;
23 
24    -- Converts the canonical representation of booleans to actual booleans
25    -- Invariants:
26    --   None
27    -- Parameters:
28    --   p_canonical_value               Input boolean in canonical format
29    -- Returns:
30    --   TRUE for FND_API.G_TRUE, FALSE for FND_API.G_FALSE, exception VALUE_ERROR otherwise
31    -- Exceptions:
32    --   VALUE_ERROR - when the input is unmatched
33    FUNCTION CANONICAL_TO_BOOLEAN(p_canonical_value      IN VARCHAR2)
34       RETURN BOOLEAN;
35 
36    -- Converts a number to its canonical representation.  Uses FND_NUMBER.
37    -- Invariants:
38    --   None
39    -- Parameters:
40    --   p_number                The number
41    -- Returns:
42    --   The canonical representation.
43    -- Exceptions:
44    --   None
45    FUNCTION NUMBER_TO_CANONICAL(p_number                IN NUMBER)
46       RETURN VARCHAR2;
47 
48    -- Converts the canonical representation of numbers to actual numbers.  Uses FND_NUMBER.
49    -- Invariants:
50    --   None
51    -- Parameters:
52    --   p_canonical_value               Input number in canonical format
53    -- Returns:
54    --   A number.
55    -- Exceptions:
56    --   VALUE_ERROR - when the input is not a number.
57    FUNCTION CANONICAL_TO_NUMBER(p_canonical_value       IN VARCHAR2)
58       RETURN NUMBER;
59 
60    -- Converts a date to its canonical representation.  Uses FND_DATE.
61    -- Invariants:
62    --   None
63    -- Parameters:
64    --   p_number                The date
65    -- Returns:
66    --   The canonical representation.
67    -- Exceptions:
68    --   None
69    FUNCTION DATE_TO_CANONICAL(p_date            IN DATE)
70       RETURN VARCHAR2;
71 
72    -- Converts the canonical representation of dates to actual dates.  Uses FND_DATE.
73    -- Invariants:
74    --   None
75    -- Parameters:
76    --   p_canonical_value               Input date in canonical format
77    -- Returns:
78    --   A number.
79    -- Exceptions:
80    --   VALUE_ERROR - when the input is not a date.
81    FUNCTION CANONICAL_TO_DATE(p_canonical_value         IN VARCHAR2)
82       RETURN DATE;
83 
84    -- Looks up the owner for a table_name with no table_owner.
85    -- Invariants:
86    --   None
87    -- Parameters:
88    --   p_table_name            Table Name
89    -- Returns:
90    --   The table's owner
91    -- Exceptions:
92    --   NO_DATA_FOUND -- no table with that name
93    --   TOO_MANY_ROWS -- more than one owner
94    FUNCTION GET_TABLE_OWNER(p_table_name                IN VARCHAR2)
95       RETURN VARCHAR2;
96 
97    -- Computes the weight of a given table.  Currently this is done by fetching the "blocks" field from dba_tables.
98    -- Invariants:
99    --   None
100    -- Parameters:
101    --   p_table_owner           Table Owner
102    --   p_table_name            Table Name
103    -- Returns:
104    --   The weight
105    -- Exceptions:
106    --   NO_DATA_FOUND -- no table with that owner/name
107    FUNCTION GET_TABLE_WEIGHT(p_table_owner      IN VARCHAR2,
108                              p_table_name       IN VARCHAR2)
109       RETURN NUMBER;
110 
111 END FND_OAM_DSCFG_UTILS_PKG;