1 PACKAGE FND_OAM_DSCFG_OBJECTS_PKG as
2 /* $Header: AFOAMDSCOBJS.pls 120.2 2006/01/17 11:33 ilawler noship $ */
3
4 ---------------
5 -- Constants --
6 ---------------
7 -- Object Types are stored in DSCFG_API_PKG.
8
9 ---------------------------------
10 -- Public Procedures/Functions --
11 ---------------------------------
12
13 -- This procedure adds a new configuration object. The configuration_instance_id is pulled from the
14 -- INSTANCES_PKG to force a call to CREATE/USE_CONFIG_INSTANCE. The import_proc_id is pulled from the
15 -- IMPORT_PROCS_PKG if possible. This is not autonomous so we can package properties, mapped keys or other
16 -- entities in the same commit.
17 -- Invariants:
18 -- Should only be called after a configuration instance has been created or set.
19 -- Parameters:
20 -- p_object_type Corresponds to API_PKG.G_OTYPE_*, determines what properties to look for later.
21 -- p_parent_object_id DSCFG_OBJECTS.OBJECT_ID of parent object, typically used to link argument objects to their
22 -- parent DML-operation object.
23 -- p_source_type [OPTIONAL]A VARCHAR2(30) field used for declaring a type of the source object, for use
24 -- in import procedures/objects to identify a link to part of the original configuration source.
25 -- p_source_id [OPTIONAL]A corresponding Number ID for the source_type. May refer to a mapped ID
26 -- obtained from FND_OAM_DSCFG_MAPPED_KEYS if the source requires a complex or varchar2 key.
27 -- p_errors_found_flag [OPTIONAL]FND_API.G_TRUE/G_FALSE boolean indicating if an error was encountered
28 -- for this object.
29 -- p_message [OPTIONAL]Field to store message explaining any warnings or errors encountered.
30 --
31 -- x_object_id: The corresponding ID of the newly created object.
32 -- Return Statuses:
33 -- Throws NO_DATA_FOUND if the configuration instance isn't initialized.
34 PROCEDURE ADD_OBJECT(p_object_type IN VARCHAR2,
35 p_parent_object_id IN NUMBER DEFAULT NULL,
36 p_source_type IN VARCHAR2 DEFAULT NULL,
37 p_source_id IN NUMBER DEFAULT NULL,
38 p_errors_found_flag IN VARCHAR2 DEFAULT NULL,
39 p_message IN VARCHAR2 DEFAULT NULL,
40 x_object_id OUT NOCOPY NUMBER);
41
42 -- This procedure obtains the object_id of any objects in the current configuration instance with
43 -- a given object_type. This allows an integrating procedure to store all its data using a given object_type
44 -- and then have another procedure fetch it all using this procedure.
45 -- Invariants:
46 -- Should only be called after a configuration instance has been created or set.
47 -- Parameters:
48 -- p_object_type Corresponds to API_PKG.G_OTYPE_* that we want to seach for.
49 --
50 -- x_object_ids: The corresponding IDs of the stored objects with matching parameters.
51 -- Return Statuses:
52 -- Throws NO_DATA_FOUND if the configuration instance isn't initialized.
53 PROCEDURE GET_OBJECTS_FOR_TYPE(p_object_type IN VARCHAR2,
54 x_object_ids OUT NOCOPY DBMS_SQL.NUMBER_TABLE);
55
56 -- This procedure obtains the object_id of any objects in the current configuration instance with
57 -- a given object_type and errors_found_flag. This allows an integrating procedure to store all its
58 -- data using a given object_type and then have another procedure fetch objects with a given error_state later.
59 -- Invariants:
60 -- Should only be called after a configuration instance has been created or set.
61 -- Parameters:
62 -- p_object_type Corresponds to API_PKG.G_OTYPE_* that we want to seach for.
63 -- p_errors_found_flag Limits the returned object_ids to only those with the specified errors_found_flag.
64 -- Value may be NULL.
65 --
66 -- x_object_ids: The corresponding IDs of the stored objects with matching parameters.
67 -- Return Statuses:
68 -- Throws NO_DATA_FOUND if the configuration instance isn't initialized.
69 PROCEDURE GET_OBJECTS_FOR_TYPE(p_object_type IN VARCHAR2,
70 p_errors_found_flag IN VARCHAR2,
71 x_object_ids OUT NOCOPY DBMS_SQL.NUMBER_TABLE);
72
73 -- This procedure deletes a config object
74 -- Invariants:
75 -- None
76 -- Parameters:
77 -- p_object_id: The object ID
78 -- p_recurse FND_API.G_TRUE/G_FALSE indicating whether to recurse and delete child objects/properties
79 -- Return Statuses:
80 -- Throws NO_DATA_FOUND if config instance does not exist.
81 FUNCTION DELETE_OBJECT(p_object_id IN NUMBER,
82 p_recurse IN VARCHAR2 DEFAULT NULL)
83 RETURN BOOLEAN;
84
85 END FND_OAM_DSCFG_OBJECTS_PKG;
[Home] [Help]