DBA Data[Home] [Help]

PACKAGE: APPS.IBC_AUDIT_LOG_GRP

Source


1 PACKAGE IBC_AUDIT_LOG_GRP AUTHID CURRENT_USER as
2 /* $Header: ibcalogs.pls 120.1 2005/05/31 23:17:26 appldev  $ */
3  /*#
4    * This is the private API for OCM Audit Log (History) functionality.
5    * Some of these methods are exposed as Java APIs in AuditLog.class
6    * @rep:scope private
7    * @rep:product IBC
8    * @rep:displayname Oracle Content Manager Audit Log API
9    * @rep:category BUSINESS_ENTITY IBC_AUDIT_LOG
10    */
11 
12 
13   G_API_VERSION_DEFAULT CONSTANT NUMBER := 1.0;
14 
15   -- audit object constants
16   G_CONTENT_TYPE        CONSTANT VARCHAR2(30) := 'CTYPE';
17   G_CONTENT_ITEM        CONSTANT VARCHAR2(30) := 'CITEM';
18   G_CITEM_VERSION       CONSTANT VARCHAR2(30) := 'CIVERSION';
19   G_ATTRIBUTE_BUNDLE    CONSTANT VARCHAR2(30) := 'ABUNDLE';
20   G_ASSOCIATION         CONSTANT VARCHAR2(30) := 'ASSOC';
21   G_COMPONENT           CONSTANT VARCHAR2(30) := 'COMP';
22   G_LABEL               CONSTANT VARCHAR2(30) := 'LABEL';
23   G_DIRECTORY_NODE      CONSTANT VARCHAR2(30) := 'DIRNODE';
24 
25   -- Extra Information Types
26   G_EI_CONSTANT         CONSTANT VARCHAR2(30) := 'CONSTANT';
27   G_EI_LOOKUP           CONSTANT VARCHAR2(30) := 'LOOKUP';
28   G_EI_MESSAGE          CONSTANT VARCHAR2(30) := 'MESSAGE';
29   G_EI_CS_LOOKUP        CONSTANT VARCHAR2(30) := 'CS_LOOKUP'; -- Comma Separated Lookups
30 
31   /*#
32    *  Procedure to store an audit log
33    *
34    *  @param p_activity             Activity Code
35    *  @param p_object_type          Object Type
36    *  @param p_object_value1        Primary Key for object being audited
37    *  @param p_object_value2        Primary Key for object being audited
38    *  @param p_object_value3        Primary Key for object being audited
39    *  @param p_object_value4        Primary Key for object being audited
40    *  @param p_object_value5        Primary Key for object being audited
41    *  @param p_parent_value         Parent Value
42    *  @param p_message_application  Application owner of audit message
43    *  @param p_message_name         Message Name (FND_MESSAGES)
44    *  @param p_extra_info1_type     Extra Information segment type
45    *                                i.e. CONSTANT, LOOKUP, CS_LOOKUP or MESSAGE
46    *  @param p_extra_info1_ref_type Lookup Type (in case of LOOKUP, CS_LOOKUP)
47    *  @param p_extra_info1_value    Value (Constant, lookup code or
48    *                                message name).
49    *  @param p_extra_info2_type     Extra Information segment type
50    *                                i.e. CONSTANT, LOOKUP, CS_LOOKUP or MESSAGE
51    *  @param p_extra_info2_ref_type Lookup Type (in case of LOOKUP, CS_LOOKUP)
52    *  @param p_extra_info2_value    Value (Constant, lookup code or
53    *                                message name).
54    *  @param p_extra_info3_type     Extra Information segment type
55    *                                i.e. CONSTANT, LOOKUP, CS_LOOKUP or MESSAGE
56    *  @param p_extra_info3_ref_type Lookup Type (in case of LOOKUP, CS_LOOKUP)
57    *  @param p_extra_info3_value    Value (Constant, lookup code or
58    *                                message name).
59    *  @param p_extra_info4_type     Extra Information segment type
60    *                                i.e. CONSTANT, LOOKUP, CS_LOOKUP or MESSAGE
61    *  @param p_extra_info4_ref_type Lookup Type (in case of LOOKUP, CS_LOOKUP)
62    *  @param p_extra_info4_value    Value (Constant, lookup code or
63    *                                message name).
64    *  @param p_extra_info5_type     Extra Information segment type
65    *                                i.e. CONSTANT, LOOKUP, CS_LOOKUP or MESSAGE
66    *  @param p_extra_info5_ref_type Lookup Type (in case of LOOKUP, CS_LOOKUP)
67    *  @param p_extra_info5_value    Value (Constant, lookup code or
68    *                                message name).
69    *  @param p_commit               standard parm - Commit flag
70    *  @param p_api_version          standard parm - API Version
71    *  @param p_init_msg_list        standard parm - Initialize message list
72    *  @param x_return_status        standard parm - Return Status
73    *  @param x_msg_count            standard parm - Message Count
74    *  @param x_msg_data             standard parm - Message Data
75    *
76    *  @rep:displayname log_action
77    *
78    */
79   PROCEDURE log_action(
80     p_activity              IN VARCHAR2
81     ,p_object_type          IN VARCHAR2
82     ,p_object_value1        IN VARCHAR2
83     ,p_object_value2        IN VARCHAR2 DEFAULT NULL
84     ,p_object_value3        IN VARCHAR2 DEFAULT NULL
85     ,p_object_value4        IN VARCHAR2 DEFAULT NULL
86     ,p_object_value5        IN VARCHAR2 DEFAULT NULL
87     ,p_parent_value         IN VARCHAR2 DEFAULT NULL
88     ,p_message_application  IN VARCHAR2 DEFAULT NULL
89     ,p_message_name         IN VARCHAR2 DEFAULT 'IBC_DFLT_AUDIT_MSG'
90     ,p_extra_info1_type     IN VARCHAR2 DEFAULT NULL
91     ,p_extra_info1_ref_type IN VARCHAR2 DEFAULT NULL
92     ,p_extra_info1_value    IN VARCHAR2 DEFAULT NULL
93     ,p_extra_info2_type     IN VARCHAR2 DEFAULT NULL
94     ,p_extra_info2_ref_type IN VARCHAR2 DEFAULT NULL
95     ,p_extra_info2_value    IN VARCHAR2 DEFAULT NULL
96     ,p_extra_info3_type     IN VARCHAR2 DEFAULT NULL
97     ,p_extra_info3_ref_type IN VARCHAR2 DEFAULT NULL
98     ,p_extra_info3_value    IN VARCHAR2 DEFAULT NULL
99     ,p_extra_info4_type     IN VARCHAR2 DEFAULT NULL
100     ,p_extra_info4_ref_type IN VARCHAR2 DEFAULT NULL
101     ,p_extra_info4_value    IN VARCHAR2 DEFAULT NULL
102     ,p_extra_info5_type     IN VARCHAR2 DEFAULT NULL
103     ,p_extra_info5_ref_type IN VARCHAR2 DEFAULT NULL
104     ,p_extra_info5_value    IN VARCHAR2 DEFAULT NULL
105   -- Standard API parms
106     ,p_commit               IN  VARCHAR2 DEFAULT FND_API.g_false
107     ,p_api_version          IN  NUMBER   DEFAULT 1.0
108     ,p_init_msg_list        IN  VARCHAR2 DEFAULT fnd_api.g_false
109     ,x_return_status	    OUT NOCOPY VARCHAR2
110     ,x_msg_count	    OUT NOCOPY NUMBER
111     ,x_msg_data	            OUT NOCOPY VARCHAR2
112   );
113 
114   /*#
115    *  Given an Audit Log Id it resolves the appropriate message
116    *  (replacing tokens, etc.)
117    *
118    *  @param p_audit_log_id      Audit Log Id
119    *  @return Audit Message
120    *
121    *  @rep:displayname get_audit_message
122    *
123    */
124   FUNCTION get_audit_message(
125      p_audit_log_id IN NUMBER
126   ) RETURN VARCHAR2;
127   pragma restrict_references(get_audit_message, WNDS);
128 
129   /*#
130    *  Given an Audit Log Id it returns the extra information segment
131    *  (based on p_info_number).
132    *
133    *  @param p_audit_log_id      Audit Log Id
134    *  @param p_info_number       Indicates which segment to return
135    *  @return Extra information message
136    *
137    *  @rep:displayname get_extra_info
138    *
139    */
140   FUNCTION get_extra_info(
141      p_audit_log_id IN NUMBER
142      ,p_info_number IN NUMBER
143   ) RETURN VARCHAR2;
144   pragma restrict_references(get_extra_info, WNDS);
145 
146 END IBC_AUDIT_LOG_GRP;