iKnowBase


Package IKB_SERVICE_API


Field Summary
 VARCHAR2(2)DEFAULT_LANGUAGE_ID CONSTANT := 'us'
          
 VARCHAR2(10)NLS_OBJECT_TYPE CONSTANT := 'IKB_CORE'
          
 VARCHAR2(10)SAVE_OPERATION_REPLACEALL CONSTANT := 'REPLACEALL'
          
 VARCHAR2(10)SAVE_OPERATION_REPLACE CONSTANT := 'REPLACE'
          
 VARCHAR2(10)SAVE_OPERATION_DELETE CONSTANT := 'DELETE'
          
 VARCHAR2(12)SAVE_OPERATION_DELETE_VALUE CONSTANT := 'DELETE_VALUE'
          
 VARCHAR2(10)SAVE_OPERATION_MERGE CONSTANT := 'MERGE'
          
 VARCHAR2(10)SAVE_OPERATION_INSERT CONSTANT := 'INSERT'
          
 VARCHAR2(10)SAVE_OPERATION_NONE CONSTANT := 'NONE'
          
 VARCHAR2(4)GET_OPERATION_FULL CONSTANT := 'FULL'
          
 VARCHAR2(3)GET_OPERATION_MINIMAL CONSTANT := 'MIN'
          
 VARCHAR2(4)GET_OPERATION_NONE CONSTANT := 'NONE'
          
 VARCHAR2(15)DELETE_OPERATION_SOFT CONSTANT := 'SOFTDELETE'
          
 VARCHAR2(15)DELETE_OPERATION_HARD CONSTANT := 'HARDDELETE'
          
 VARCHAR2(15)SUBDOC_OPERATION_CHAIN CONSTANT := 'CHAIN'
          
 VARCHAR2(15)SUBDOC_OPERATION_DELETE_ALL CONSTANT := 'ALL'
          
 VARCHAR2(15)SUBDOC_OPERATION_DETACH CONSTANT := 'DETACH'
          
 PLS_INTEGERVERSION_MODE_NONE CONSTANT := 0
          
 PLS_INTEGERVERSION_MODE_INSERT_INACTIVE CONSTANT := 1
          
 PLS_INTEGERVERSION_MODE_INSERT_ACTIVE CONSTANT := 2
          
 PLS_INTEGERVERSION_MODE_UPDATE_ACTIVE CONSTANT := 3
          
 CHAR(1)NO_VALIDATION CONSTANT := 'N'
          
 CHAR(1)DO_VALIDATION CONSTANT := 'Y'
          

Method Summary
  BUILD_ATTRIBUTEARRAY(P_ATTRIBUTES IN OUT NOCOPY CT_DOCUMENT_ATTRIBUTES, P_ATTRIBUTE IN OT_OBJECTREFERENCE, P_VALUE_CHAR IN VARCHAR2 DEFAULT NULL, P_VALUE_DATE IN DATE DEFAULT NULL, P_VALUE_NUMBER IN NUMBER DEFAULT NULL, P_VALUE_CLOB IN CLOB DEFAULT NULL, P_VALUE_EXTERNAL IN VARCHAR2 DEFAULT NULL, P_VALUE_DOCUMENT_REFERENCE IN OT_OBJECTREFERENCE DEFAULT NULL, P_VALUE_DIMENSION_REFERENCE IN OT_OBJECTREFERENCE DEFAULT NULL, P_VALUE_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE DEFAULT NULL, P_VALUE_USER_REFERENCE IN OT_USERREFERENCE DEFAULT NULL, P_DO_INTERNAL_CHECK IN VARCHAR2 DEFAULT NO_VALIDATION, P_BUILD_METADATA IN VARCHAR2 DEFAULT 'N', P_EXTERNAL IN NUMBER DEFAULT NULL, P_LINE_NO IN NUMBER DEFAULT -1, P_VALUE_FILENAME IN VARCHAR2 DEFAULT NULL, P_VALUE_MIMETYPE IN VARCHAR2 DEFAULT NULL, P_VALUE_BLOB IN BLOB DEFAULT NULL, P_OBJECT_GUID IN RAW DEFAULT NULL, P_VALUE_XML IN SYS.XMLTYPE DEFAULT NULL)
           Builds an attribute list to be used in a document object.
 OT_OBJECTREFERENCE COPY_ACL(P_EXECUTION_USER IN OT_USERREFERENCE, P_ACL_REFERENCE IN OT_OBJECTREFERENCE)
           Copies the given acl (creates a new one based on another)
 OT_OBJECTREFERENCE COPY_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE, P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE)
           Copies the given attribute (create a new one based on another)
 OT_OBJECTREFERENCE COPY_DIMENSION_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, P_DIMENSION_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
           Copies the given dimension_type object (create a new one based on another)
 OT_OBJECTREFERENCE COPY_DOCUMENT_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
           Copies the given document type (create a new one based on another)
 OT_OBJECTREFERENCE COPY_GROUP(P_EXECUTION_USER IN OT_USERREFERENCE, P_GROUP_REFERENCE IN OT_OBJECTREFERENCE)
           Copies the given group (creates a new one based on another)
 OT_OBJECTREFERENCE COPY_SUBSYSTEM(P_EXECUTION_USER IN OT_USERREFERENCE, P_SUBSYSTEM_REFERENCE IN OT_OBJECTREFERENCE)
           Copies the given subsystem (create a new one based on another)
 OT_OBJECTREFERENCE COPY_VALUELIST(P_EXECUTION_USER IN OT_USERREFERENCE, P_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE)
           Copies the given valuelist (creates a new one based on another)
  DELETE_ACL(P_EXECUTION_USER IN OT_USERREFERENCE, P_ACL_REFERENCE IN OT_OBJECTREFERENCE)
           Deletes the given acl.
  DELETE_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE, P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE)
           Deletes the given attribute.
  DELETE_DIMENSION(P_EXECUTION_USER IN OT_USERREFERENCE, P_DIMENSION_REFERENCE IN OT_OBJECTREFERENCE)
           Deletes the given dimension.
  DELETE_DIMENSION_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, P_DIMENSION_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
           Deletes the given dimension type.
  DELETE_DOCUMENT(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT IN OT_DOCUMENT_REFERENCE, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.DELETE_OPERATION_SOFT, P_EVENT_MODE IN VARCHAR2 DEFAULT NULL, P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SUBDOC_OPERATION_DELETE_ALL)
           Deletes the given document.
  DELETE_DOCUMENT(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT IN OT_OBJECTREFERENCE, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.DELETE_OPERATION_SOFT, P_EVENT_MODE IN VARCHAR2 DEFAULT NULL, P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SUBDOC_OPERATION_DELETE_ALL)
           Deletes the given document.
  DELETE_DOCUMENT_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
           Deletes the given document type.
  DELETE_GROUP(P_EXECUTION_USER IN OT_USERREFERENCE, P_GROUP_REFERENCE IN OT_OBJECTREFERENCE)
           Deletes the given group.
  DELETE_SUBSYSTEM(P_EXECUTION_USER IN OT_USERREFERENCE, P_SUBSYSTEM_REFERENCE IN OT_OBJECTREFERENCE)
           Deletes the given subsystem.
  DELETE_USER(P_EXECUTION_USER IN OT_USERREFERENCE, P_USER_REFERENCE IN OT_USERREFERENCE, P_NEWOWNER_REFERENCE IN OT_USERREFERENCE)
           Deletes the user with the given user reference.
  DELETE_VALUELIST(P_EXECUTION_USER IN OT_USERREFERENCE, P_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE)
           Deletes the given valuelist.
 OT_ACL GET_ACL(P_EXECUTION_USER IN OT_USERREFERENCE, P_ACL_REFERENCE IN OT_OBJECTREFERENCE, P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_FULL)
           Retrieves the given access control list.
 OT_ATTRIBUTE GET_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE DEFAULT NULL, P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE, P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_FULL)
           Retrieves the given attribute.
 OT_DIMENSION GET_DIMENSION(P_EXECUTION_USER IN OT_USERREFERENCE, P_DIMENSION_REFERENCE IN OT_OBJECTREFERENCE)
           Retrieves the given dimension.
 OT_DIMENSION_TYPE GET_DIMENSION_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, P_DIMENSION_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
           Retrieves the given dimension type.
 OT_DOCUMENT GET_DOCUMENT(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_REFERENCE IN OT_OBJECTREFERENCE, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL, P_CONTENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_NONE, P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_NONE)
           Retrieves the given document, provided that performing user is authorized to perform the operation.
 OT_DOCUMENT GET_DOCUMENT(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_REFERENCE IN OT_DOCUMENT_REFERENCE, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL, P_CONTENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_NONE, P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_NONE)
          
 OT_DOCUMENT GET_DOCUMENT(P_DOCREF IN OT_OBJECTREFERENCE, P_USER_ID IN OT_USERREFERENCE, P_GET_CONTENT IN VARCHAR2 DEFAULT 'N', P_ATTRIBUTE_MODE IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_NONE, P_DOCUMENT_MODE IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL)
          
 OT_DOCUMENT_ATTRIBUTE GET_DOCUMENT_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_REFERENCE IN OT_OBJECTREFERENCE, P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL)
           Retrieves all values for the given document attribute
 OT_DOCUMENT_ATTRIBUTE GET_DOCUMENT_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_REFERENCE IN OT_DOCUMENT_REFERENCE, P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL)
           Retrieves all values for the given document attribute
 CT_DOCUMENT_ATTRIBUTES GET_DOCUMENT_ATTRIBUTES(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_REFERENCE IN OT_OBJECTREFERENCE, P_ATTRIBUTE_REFERENCES IN CT_OBJECTREFERENCE DEFAULT CT_OBJECTREFERENCE(), P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL)
           Retrieves all values for the given document attribute, also document properties
 CT_DOCUMENT_ATTRIBUTES GET_DOCUMENT_ATTRIBUTES(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_REFERENCE IN OT_DOCUMENT_REFERENCE, P_ATTRIBUTE_REFERENCES IN CT_OBJECTREFERENCE DEFAULT CT_OBJECTREFERENCE(), P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL)
           Retrieves all values for the given document attribute, also document properties
 OT_DOCUMENT_TYPE GET_DOCUMENT_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
           Retrieves the given document type.
 OT_GROUP GET_GROUP(P_EXECUTION_USER IN OT_USERREFERENCE, P_GROUP_REFERENCE IN OT_OBJECTREFERENCE, P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_FULL)
           Retrieves the group with the given group reference.
 OT_SUBSYSTEM GET_SUBSYSTEM(P_EXECUTION_USER IN OT_USERREFERENCE, P_SUBSYSTEM_REFERENCE IN OT_OBJECTREFERENCE)
           Retrieves the given subsystem.
 OT_USER GET_USER(P_EXECUTION_USER IN OT_USERREFERENCE, P_USER_REFERENCE IN OT_USERREFERENCE)
           Retrieves the user with the given user reference
 BOOLEAN GET_USER(P_USERREFERENCE IN OT_USERREFERENCE, P_USER_RECORD OUT NOCOPY OT_USER)
          
 OT_VALUELIST GET_VALUELIST(P_EXECUTION_USER IN OT_USERREFERENCE, P_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE)
           Retrieves the given valuelist.
 OT_VALUELIST_VALUE GET_VALUELIST_VALUE(P_EXECUTION_USER IN OT_USERREFERENCE, P_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE, P_VALUELIST_VALUE_REFERENCE IN OT_OBJECTREFERENCE)
           Retrieves the given valuelist value.
 OT_VALUELIST_VALUE GET_VALUELIST_VALUE_BY_ATTRIB(P_EXECUTION_USER IN OT_USERREFERENCE, P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE, P_VALUELIST_VALUE_REFERENCE IN OT_OBJECTREFERENCE)
           Retrieves the given valuelist value
 OT_OBJECTREFERENCE SAVE_ACL(P_EXECUTION_USER IN OT_USERREFERENCE DEFAULT NULL, P_ACL IN OT_ACL, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE, P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_REPLACEALL)
           Adds or updates the given access control list.
 OT_OBJECTREFERENCE SAVE_ACL(P_ACL IN OT_ACL, P_USER_REFERENCE IN OT_USERREFERENCE DEFAULT NULL, P_RESYNC_MEMBERS IN VARCHAR2 DEFAULT 'Y', P_UPDATE_ACL IN VARCHAR2 DEFAULT 'Y')
          
 OT_OBJECTREFERENCE SAVE_ACL_MEMBERS(P_EXECUTION_USER IN OT_USERREFERENCE, P_ACL_REFERENCE IN OT_OBJECTREFERENCE, P_MEMBERS IN CT_ACL_MEMBERS, P_CHILD_OPERATION IN VARCHAR2)
           Updates the list of members for the given acl.
 OT_OBJECTREFERENCE SAVE_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE, P_ATTRIBUTE IN OT_ATTRIBUTE, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
           Adds or updates the given attribute
 OT_OBJECTREFERENCE SAVE_DIMENSION(P_EXECUTION_USER IN OT_USERREFERENCE, P_DIMENSION IN OT_DIMENSION, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
           Adds or updates the given dimension
 OT_OBJECTREFERENCE SAVE_DIMENSION_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, P_DIMENSION_TYPE IN OT_DIMENSION_TYPE, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
           Adds or updates the given dimension type
 OT_OBJECTREFERENCE SAVE_DOCUMENT(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT IN OT_DOCUMENT, P_DOCUMENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE, P_ATTRIBUTE_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_REPLACEALL, P_CONTENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE, P_VERSION_MODE IN NUMBER DEFAULT NULL, P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL, P_EVENT_MODE IN VARCHAR2 DEFAULT NULL, P_IS_EXTERNAL IN BOOLEAN DEFAULT TRUE)
           Adds or updates the given document.
 OT_OBJECTREFERENCE SAVE_DOCUMENT(P_DOCUMENT IN OT_DOCUMENT, P_EXTERNAL_ENTITY IN VARCHAR2 DEFAULT NULL, P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL, P_VERSION_TYPE IN NUMBER DEFAULT NULL, P_USER_ID IN OT_USERREFERENCE, P_SAVE_METHOD IN VARCHAR2 DEFAULT 'COMPLETE', P_IS_EXTERNAL IN NUMBER DEFAULT 1, P_EVENT_MODE IN VARCHAR2 DEFAULT NULL)
          
 OT_OBJECTREFERENCE SAVE_DOCUMENT_ATTRIBUTES(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_REFERENCE IN OT_OBJECTREFERENCE DEFAULT OT_OBJECTREFERENCE(), P_ATTRIBUTES IN CT_DOCUMENT_ATTRIBUTES DEFAULT CT_DOCUMENT_ATTRIBUTES(), P_ATTRIBUTE_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE, P_VERSION_MODE IN NUMBER DEFAULT NULL, P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL, P_EVENT_MODE IN VARCHAR2 DEFAULT NULL, P_IS_EXTERNAL IN BOOLEAN DEFAULT TRUE)
           Adds or updates a set of attributes for the given document.
 OT_OBJECTREFERENCE SAVE_DOCUMENT_ATTRIBUTES(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_REFERENCE IN OT_DOCUMENT_REFERENCE DEFAULT OT_DOCUMENT_REFERENCE(), P_ATTRIBUTES IN CT_DOCUMENT_ATTRIBUTES DEFAULT CT_DOCUMENT_ATTRIBUTES(), P_ATTRIBUTE_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE, P_VERSION_MODE IN NUMBER DEFAULT NULL, P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL, P_EVENT_MODE IN VARCHAR2 DEFAULT NULL, P_IS_EXTERNAL IN BOOLEAN DEFAULT TRUE)
          
 OT_OBJECTREFERENCE SAVE_DOCUMENT_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENT_TYPE IN OT_DOCUMENT_TYPE, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
           Adds or updates the given document type
 CT_OBJECTREFERENCE SAVE_DOCUMENTS(P_EXECUTION_USER IN OT_USERREFERENCE, P_DOCUMENTS IN CT_DOCUMENTS, P_DOCUMENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE, P_ATTRIBUTE_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_REPLACEALL, P_CONTENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE, P_VERSION_MODE IN NUMBER DEFAULT NULL, P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL, P_EVENT_MODE IN VARCHAR2 DEFAULT NULL, P_IS_EXTERNAL IN BOOLEAN DEFAULT TRUE)
           Processes a collection of documents, by calling save_document for each.
 CT_OBJECTREFERENCE SAVE_DOCUMENTS(P_DOCUMENTS IN CT_DOCUMENTS, P_EXTERNAL_ENTITY IN VARCHAR2 DEFAULT NULL, P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL, P_VERSION_TYPE IN NUMBER DEFAULT NULL, P_USER_ID IN OT_USERREFERENCE, P_SAVE_METHOD IN VARCHAR2 DEFAULT 'COMPLETE', P_IS_EXTERNAL IN NUMBER DEFAULT 1, P_EVENT_MODE IN VARCHAR2 DEFAULT NULL)
          
 OT_OBJECTREFERENCE SAVE_GROUP(P_EXECUTION_USER IN OT_USERREFERENCE, P_GROUP IN OT_GROUP, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE, P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_REPLACEALL)
           Adds or modifies the given group.
 OT_OBJECTREFERENCE SAVE_GROUP_MEMBERS(P_EXECUTION_USER IN OT_USERREFERENCE, P_GROUP_REFERENCE IN OT_OBJECTREFERENCE, P_MEMBERS IN CT_USERREFERENCE, P_CHILD_OPERATION IN VARCHAR2)
           Updates the list of members for the given group.
 OT_OBJECTREFERENCE SAVE_SITE(P_EXECUTION_USER IN OT_USERREFERENCE, P_SITE IN OT_SITE, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
           Adds or updates the given site
 OT_OBJECTREFERENCE SAVE_SUBSYSTEM(P_EXECUTION_USER IN OT_USERREFERENCE, P_SUBSYSTEM IN OT_SUBSYSTEM, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
           Adds or updates the given subsystem
 OT_USERREFERENCE SAVE_USER(P_EXECUTION_USER IN OT_USERREFERENCE, P_USER IN OT_USER, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
           Adds or modifies the given user.
 OT_OBJECTREFERENCE SAVE_VALUELIST(P_EXECUTION_USER IN OT_USERREFERENCE, P_VALUELIST IN OT_VALUELIST, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE, P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_REPLACEALL)
           Adds or updates the given valuelist.
 OT_OBJECTREFERENCE SAVE_VALUELIST_VALUE(P_EXECUTION_USER IN OT_USERREFERENCE, P_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE, P_VALUELIST_VALUE IN OT_VALUELIST_VALUE, P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_INSERT)
           Adds, updates, or deletes the given value of the given valuelist.

Field Detail

DEFAULT_LANGUAGE_ID

        public VARCHAR2(2) DEFAULT_LANGUAGE_ID CONSTANT := 'us'

DELETE_OPERATION_HARD

        public VARCHAR2(15) DELETE_OPERATION_HARD CONSTANT := 'HARDDELETE'

DELETE_OPERATION_SOFT

        public VARCHAR2(15) DELETE_OPERATION_SOFT CONSTANT := 'SOFTDELETE'

DO_VALIDATION

        public CHAR(1) DO_VALIDATION CONSTANT := 'Y'

GET_OPERATION_FULL

        public VARCHAR2(4) GET_OPERATION_FULL CONSTANT := 'FULL'

GET_OPERATION_MINIMAL

        public VARCHAR2(3) GET_OPERATION_MINIMAL CONSTANT := 'MIN'

GET_OPERATION_NONE

        public VARCHAR2(4) GET_OPERATION_NONE CONSTANT := 'NONE'

NLS_OBJECT_TYPE

        public VARCHAR2(10) NLS_OBJECT_TYPE CONSTANT := 'IKB_CORE'

NO_VALIDATION

        public CHAR(1) NO_VALIDATION CONSTANT := 'N'

SAVE_OPERATION_DELETE

        public VARCHAR2(10) SAVE_OPERATION_DELETE CONSTANT := 'DELETE'

SAVE_OPERATION_DELETE_VALUE

        public VARCHAR2(12) SAVE_OPERATION_DELETE_VALUE CONSTANT := 'DELETE_VALUE'

SAVE_OPERATION_INSERT

        public VARCHAR2(10) SAVE_OPERATION_INSERT CONSTANT := 'INSERT'

SAVE_OPERATION_MERGE

        public VARCHAR2(10) SAVE_OPERATION_MERGE CONSTANT := 'MERGE'

SAVE_OPERATION_NONE

        public VARCHAR2(10) SAVE_OPERATION_NONE CONSTANT := 'NONE'

SAVE_OPERATION_REPLACE

        public VARCHAR2(10) SAVE_OPERATION_REPLACE CONSTANT := 'REPLACE'

SAVE_OPERATION_REPLACEALL

        public VARCHAR2(10) SAVE_OPERATION_REPLACEALL CONSTANT := 'REPLACEALL'

SUBDOC_OPERATION_CHAIN

        public VARCHAR2(15) SUBDOC_OPERATION_CHAIN CONSTANT := 'CHAIN'

SUBDOC_OPERATION_DELETE_ALL

        public VARCHAR2(15) SUBDOC_OPERATION_DELETE_ALL CONSTANT := 'ALL'

SUBDOC_OPERATION_DETACH

        public VARCHAR2(15) SUBDOC_OPERATION_DETACH CONSTANT := 'DETACH'

VERSION_MODE_INSERT_ACTIVE

        public PLS_INTEGER VERSION_MODE_INSERT_ACTIVE CONSTANT := 2

VERSION_MODE_INSERT_INACTIVE

        public PLS_INTEGER VERSION_MODE_INSERT_INACTIVE CONSTANT := 1

VERSION_MODE_NONE

        public PLS_INTEGER VERSION_MODE_NONE CONSTANT := 0

VERSION_MODE_UPDATE_ACTIVE

        public PLS_INTEGER VERSION_MODE_UPDATE_ACTIVE CONSTANT := 3

Method Detail

BUILD_ATTRIBUTEARRAY

public  BUILD_ATTRIBUTEARRAY(P_ATTRIBUTES IN OUT NOCOPY CT_DOCUMENT_ATTRIBUTES, 
P_ATTRIBUTE IN OT_OBJECTREFERENCE,
P_VALUE_CHAR IN VARCHAR2 DEFAULT NULL,
P_VALUE_DATE IN DATE DEFAULT NULL,
P_VALUE_NUMBER IN NUMBER DEFAULT NULL,
P_VALUE_CLOB IN CLOB DEFAULT NULL,
P_VALUE_EXTERNAL IN VARCHAR2 DEFAULT NULL,
P_VALUE_DOCUMENT_REFERENCE IN OT_OBJECTREFERENCE DEFAULT NULL,
P_VALUE_DIMENSION_REFERENCE IN OT_OBJECTREFERENCE DEFAULT NULL,
P_VALUE_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE DEFAULT NULL,
P_VALUE_USER_REFERENCE IN OT_USERREFERENCE DEFAULT NULL,
P_DO_INTERNAL_CHECK IN VARCHAR2 DEFAULT NO_VALIDATION,
P_BUILD_METADATA IN VARCHAR2 DEFAULT 'N',
P_EXTERNAL IN NUMBER DEFAULT NULL,
P_LINE_NO IN NUMBER DEFAULT -1,
P_VALUE_FILENAME IN VARCHAR2 DEFAULT NULL,
P_VALUE_MIMETYPE IN VARCHAR2 DEFAULT NULL,
P_VALUE_BLOB IN BLOB DEFAULT NULL,
P_OBJECT_GUID IN RAW DEFAULT NULL,
P_VALUE_XML IN SYS.XMLTYPE DEFAULT NULL)
Builds an attribute list to be used in a document object. The given attribute will be added to the given attribute list.
Parameters:
P_ATTRIBUTES - The list of attributes to which to add an attribute. This is an OUT parameter.
P_ATTRIBUTE - Defines the attribute to be added
P_VALUE_CHAR - If the attribute type is character, the value should be placed here
P_VALUE_DATE - If the attribute type is date, the value should be placed here. Use the format dd.mm.yyyy hh24:mi:ss or dd.mm.yyyy
P_VALUE_NUMBER - If the attribute type is number, the value should be placed here
P_VALUE_CLOB - If the attribute type is CLOB, the value should be placed here
P_VALUE_EXTERNAL - If the attribute type is a external value, the value should be placed here
P_VALUE_DOCUMENT_REFERENCE - If the attribute type is image or related document, the value should be placed here
P_VALUE_DIMENSION_REFERENCE - If the attribute type is dimension, the value should be placed here
P_VALUE_VALUELIST_REFERENCE - If the attribute type is value list, the value should be placed here
P_VALUE_USER_REFERENCE - If the attribute type is dimension and you want the value to be set based on the user dimension, the value (userinfo) should be placed here
P_DO_INTERNAL_CHECK - Y If external attribute, check if it exists internally. If so, do not insert; N If external attribute, insert the attribute even if it exists internally
P_BUILD_METADATA - Y for dimensions and valuelists:Will create an instance of the metadata (valuelist/dimension) if it doesn't exist; N Will not create any metadata
P_EXTERNAL - 0 means its an internal attribute, 1 means its an external. If NULL the value will be set in save_document
P_LINE_NO - -1 means a new line, > 0 defines an existing attribute value


COPY_ACL

public OT_OBJECTREFERENCE COPY_ACL(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_ACL_REFERENCE IN OT_OBJECTREFERENCE)
Copies the given acl (creates a new one based on another)
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_ACL_REFERENCE - Reference to the acl to be copied
Returns:
The new acl object reference


COPY_ATTRIBUTE

public OT_OBJECTREFERENCE COPY_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE)
Copies the given attribute (create a new one based on another)
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_ATTRIBUTE_REFERENCE - Reference to the attribute to be copied
Returns:
The new attribute object reference


COPY_DIMENSION_TYPE

public OT_OBJECTREFERENCE COPY_DIMENSION_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DIMENSION_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
Copies the given dimension_type object (create a new one based on another)
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DIMENSION_TYPE_REFERENCE - Reference to the dimension_type object to be copied
Returns:
The new dimensiontype object reference


COPY_DOCUMENT_TYPE

public OT_OBJECTREFERENCE COPY_DOCUMENT_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
Copies the given document type (create a new one based on another)
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT_TYPE_REFERENCE - Reference to the document type to be copied
Returns:
The new document type object reference


COPY_GROUP

public OT_OBJECTREFERENCE COPY_GROUP(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_GROUP_REFERENCE IN OT_OBJECTREFERENCE)
Copies the given group (creates a new one based on another)
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_GROUP_REFERENCE - Reference to the group to be copied
Returns:
The new group object reference


COPY_SUBSYSTEM

public OT_OBJECTREFERENCE COPY_SUBSYSTEM(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_SUBSYSTEM_REFERENCE IN OT_OBJECTREFERENCE)
Copies the given subsystem (create a new one based on another)
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_SUBSYSTEM_REFERENCE - Reference to the subsystem to be copied
Returns:
The new subsystem object reference


COPY_VALUELIST

public OT_OBJECTREFERENCE COPY_VALUELIST(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE)
Copies the given valuelist (creates a new one based on another)
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_VALUELIST_REFERENCE - Reference to the valuelist to be copied
Returns:
The new valuelist object reference


DELETE_ACL

public  DELETE_ACL(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_ACL_REFERENCE IN OT_OBJECTREFERENCE)
Deletes the given acl.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_ACL_REFERENCE - Reference to the acl to be deleted


DELETE_ATTRIBUTE

public  DELETE_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE)
Deletes the given attribute.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_ATTRIBUTE_REFERENCE - Reference to the attribute to be deleted


DELETE_DIMENSION

public  DELETE_DIMENSION(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DIMENSION_REFERENCE IN OT_OBJECTREFERENCE)
Deletes the given dimension.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DIMENSION_REFERENCE - Reference to the dimension to be deleted


DELETE_DIMENSION_TYPE

public  DELETE_DIMENSION_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DIMENSION_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
Deletes the given dimension type.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DIMENSION_TYPE_REFERENCE - Reference to the dimension type to be deleted


DELETE_DOCUMENT

public  DELETE_DOCUMENT(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT IN OT_DOCUMENT_REFERENCE,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.DELETE_OPERATION_SOFT,
P_EVENT_MODE IN VARCHAR2 DEFAULT NULL,
P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SUBDOC_OPERATION_DELETE_ALL)
Deletes the given document.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT - Reference to the document reference to be deleted. Both versions and 'real' documents can be deleted
P_OPERATION - Specifies how to delete the document, valid values are delete_operation_soft, and delete_operation_hard
P_EVENT_MODE - Mode (string) sent to the event engine
P_CHILD_OPERATION - Operation (string) to detemine what to do with the subdocuments. It will only be used when p_operation = delete_operation_hard Valid values are subdoc_operation_chain, subdoc_operation_delete_all and subdoc_operation_detach


DELETE_DOCUMENT

public  DELETE_DOCUMENT(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT IN OT_OBJECTREFERENCE,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.DELETE_OPERATION_SOFT,
P_EVENT_MODE IN VARCHAR2 DEFAULT NULL,
P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SUBDOC_OPERATION_DELETE_ALL)
Deletes the given document.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT - Reference to the object reference to be deleted. Versioned documents cannot be deleted by this procedure
P_OPERATION - Specifies how to delete the document, valid values are delete_operation_soft, and delete_operation_hard
P_EVENT_MODE - Mode (string) sent to the event engine
P_CHILD_OPERATION - Operation (string) to detemine what to do with the subdocuments. It will only be used when p_operation = delete_operation_hard Valid values are subdoc_operation_chain, subdoc_operation_delete_all and subdoc_operation_detach


DELETE_DOCUMENT_TYPE

public  DELETE_DOCUMENT_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
Deletes the given document type.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT_TYPE_REFERENCE - Reference to the document type to be deleted


DELETE_GROUP

public  DELETE_GROUP(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_GROUP_REFERENCE IN OT_OBJECTREFERENCE)
Deletes the given group.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_GROUP_REFERENCE - Reference to the group to be deleted


DELETE_SUBSYSTEM

public  DELETE_SUBSYSTEM(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_SUBSYSTEM_REFERENCE IN OT_OBJECTREFERENCE)
Deletes the given subsystem.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_SUBSYSTEM_REFERENCE - Reference to the subsystem to be deleted


DELETE_USER

public  DELETE_USER(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_USER_REFERENCE IN OT_USERREFERENCE,
P_NEWOWNER_REFERENCE IN OT_USERREFERENCE)
Deletes the user with the given user reference. Note that if the user directory is replicated from an external source (e.g. OID, Active Directory), the user may be recreated automatically by the synchronization jobs.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_USER_REFERENCE - Reference to the user to be deleted
P_NEWOWNER_REFERENCE - Reference to the new owner of all documents owned by user to be deleted


DELETE_VALUELIST

public  DELETE_VALUELIST(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE)
Deletes the given valuelist.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_VALUELIST_REFERENCE - Reference to the valuelist to be deleted


GET_ACL

public OT_ACL GET_ACL(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_ACL_REFERENCE IN OT_OBJECTREFERENCE,
P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_FULL)
Retrieves the given access control list.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_ACL_REFERENCE - Reference to the acl to be retrieved
P_CHILD_OPERATION - Specifies whether the acl members should be retrieved or not, valid values are get_operation_full and get_operation_none
Returns:
The acl object


GET_ATTRIBUTE

public OT_ATTRIBUTE GET_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE DEFAULT NULL, 
P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE,
P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_FULL)
Retrieves the given attribute.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_ATTRIBUTE_REFERENCE - Reference to the attribute to be retrieved
P_CHILD_OPERATION - Specifies whether to retrieve attribute dimensions/dimension types or not, valid values are get_operation_full, and get_operation_none,
Returns:
The attribute object


GET_DIMENSION

public OT_DIMENSION GET_DIMENSION(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DIMENSION_REFERENCE IN OT_OBJECTREFERENCE)
Retrieves the given dimension.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DIMENSION_REFERENCE - Reference of the dimension to retrieved
Returns:
The dimension object


GET_DIMENSION_TYPE

public OT_DIMENSION_TYPE GET_DIMENSION_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DIMENSION_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
Retrieves the given dimension type.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DIMENSION_TYPE_REFERENCE - Reference to the dimension type to be retrieved.


GET_DOCUMENT

public OT_DOCUMENT GET_DOCUMENT(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_REFERENCE IN OT_OBJECTREFERENCE,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL,
P_CONTENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_NONE,
P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_NONE)
Retrieves the given document, provided that performing user is authorized to perform the operation. For versioned documents, the active document will be retrieved. By default the content and attributes of the document is not retrieved.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT_REFERENCE - Reference to the document to be retrieved
P_OPERATION - Specifies how the document should be retrieved valid values are get_operation_full, and get_operation_minimal
P_CHILD_OPERATION - Specifies how the document attributes should be retrieved. valid values are get_operation_minimal, get_operation_full, and get_operation_none.
Returns:
The document object


GET_DOCUMENT

public OT_DOCUMENT GET_DOCUMENT(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_REFERENCE IN OT_DOCUMENT_REFERENCE,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL,
P_CONTENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_NONE,
P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_NONE)


GET_DOCUMENT

public OT_DOCUMENT GET_DOCUMENT(P_DOCREF IN OT_OBJECTREFERENCE, 
P_USER_ID IN OT_USERREFERENCE,
P_GET_CONTENT IN VARCHAR2 DEFAULT 'N',
P_ATTRIBUTE_MODE IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_NONE,
P_DOCUMENT_MODE IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL)


GET_DOCUMENT_ATTRIBUTE

public OT_DOCUMENT_ATTRIBUTE GET_DOCUMENT_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_REFERENCE IN OT_OBJECTREFERENCE,
P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL)
Retrieves all values for the given document attribute
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT_REFERENCE - Reference to the document which contains the attribute
P_ATTRIBUTE_REFERENCE - Reference to the attribute to be retrieved
P_OPERATION - Specifies how the values should be retrieved, valid values areget_operation_full, and get_operation_minimal
Returns:
The document attribute object


GET_DOCUMENT_ATTRIBUTE

public OT_DOCUMENT_ATTRIBUTE GET_DOCUMENT_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_REFERENCE IN OT_DOCUMENT_REFERENCE,
P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL)
Retrieves all values for the given document attribute
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT_REFERENCE - Reference to the document which contains the attribute
P_ATTRIBUTE_REFERENCE - Reference to the attribute to be retrieved
P_OPERATION - Specifies how the values should be retrieved, valid values areget_operation_full, and get_operation_minimal
Returns:
The document attribute object


GET_DOCUMENT_ATTRIBUTES

public CT_DOCUMENT_ATTRIBUTES GET_DOCUMENT_ATTRIBUTES(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_REFERENCE IN OT_OBJECTREFERENCE,
P_ATTRIBUTE_REFERENCES IN CT_OBJECTREFERENCE DEFAULT CT_OBJECTREFERENCE(),
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL)
Retrieves all values for the given document attribute, also document properties
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT_REFERENCE - Reference to the document which contains the attribute
P_ATTRIBUTE_REFERENCES - Either null (return all attributes) or one or more reference to an attribute
P_OPERATION - Specifies how the values should be retrieved, valid values areget_operation_full, and get_operation_minimal
Returns:
The document attribute objects


GET_DOCUMENT_ATTRIBUTES

public CT_DOCUMENT_ATTRIBUTES GET_DOCUMENT_ATTRIBUTES(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_REFERENCE IN OT_DOCUMENT_REFERENCE,
P_ATTRIBUTE_REFERENCES IN CT_OBJECTREFERENCE DEFAULT CT_OBJECTREFERENCE(),
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_MINIMAL)
Retrieves all values for the given document attribute, also document properties
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT_REFERENCE - Reference to the document which contains the attribute
P_ATTRIBUTE_REFERENCES - Either null (return all attributes) or one or more reference to an attribute
P_OPERATION - Specifies how the values should be retrieved, valid values areget_operation_full, and get_operation_minimal
Returns:
The document attribute objects


GET_DOCUMENT_TYPE

public OT_DOCUMENT_TYPE GET_DOCUMENT_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_TYPE_REFERENCE IN OT_OBJECTREFERENCE)
Retrieves the given document type.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT_TYPE_REFERENCE - Reference of the document type to be retrieved
Returns:
The document type object


GET_GROUP

public OT_GROUP GET_GROUP(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_GROUP_REFERENCE IN OT_OBJECTREFERENCE,
P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.GET_OPERATION_FULL)
Retrieves the group with the given group reference.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_GROUP_REFERENCE - Reference to the group to be retrieved.
P_CHILD_OPERATION - Specifies whether the group members should be retrieved or not, valid values are get_operation_full and get_operation_none
Returns:
The group object


GET_SUBSYSTEM

public OT_SUBSYSTEM GET_SUBSYSTEM(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_SUBSYSTEM_REFERENCE IN OT_OBJECTREFERENCE)
Retrieves the given subsystem.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_SUBSYSTEM_REFERENCE - Reference of the subsystem to be retrieved
Returns:
The subsystem object


GET_USER

public OT_USER GET_USER(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_USER_REFERENCE IN OT_USERREFERENCE)
Retrieves the user with the given user reference
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_USER_REFERENCE - Reference to the user to be retrieved
Returns:
The user object


GET_USER

public BOOLEAN GET_USER(P_USERREFERENCE IN OT_USERREFERENCE, 
P_USER_RECORD OUT NOCOPY OT_USER)


GET_VALUELIST

public OT_VALUELIST GET_VALUELIST(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE)
Retrieves the given valuelist.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_VALUELIST_REFERENCE - Reference to the valuelist to be retrieved


GET_VALUELIST_VALUE

public OT_VALUELIST_VALUE GET_VALUELIST_VALUE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE,
P_VALUELIST_VALUE_REFERENCE IN OT_OBJECTREFERENCE)
Retrieves the given valuelist value.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_VALUELIST_REFERENCE - Reference to the valuelist object from which the value should be retrieved
P_VALUELIST_VALUE_REFERENCE - Reference to the value to be retrieved
Returns:
The valuelist value object


GET_VALUELIST_VALUE_BY_ATTRIB

public OT_VALUELIST_VALUE GET_VALUELIST_VALUE_BY_ATTRIB(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_ATTRIBUTE_REFERENCE IN OT_OBJECTREFERENCE,
P_VALUELIST_VALUE_REFERENCE IN OT_OBJECTREFERENCE)
Retrieves the given valuelist value
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_ATTRIBUTE_REFERENCE - Reference to the attribute which identifies the valuelist object from which the value should be retrieved.
P_VALUELIST_VALUE_REFERENCE - Reference of the value to be retrieved.
Returns:
The valuelist value object


SAVE_ACL

public OT_OBJECTREFERENCE SAVE_ACL(P_EXECUTION_USER IN OT_USERREFERENCE DEFAULT NULL, 
P_ACL IN OT_ACL,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE,
P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_REPLACEALL)
Adds or updates the given access control list.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_ACL - The acl object to be saved
P_OPERATION - Specifies how the acl should be saved, valid values are save_operation_merge, save_operation_insert, and save_operation_none
P_CHILD_OPERATION - Specifies how the acl members should be saved, valid values are save_operation_replaceall,save_operation_delete, save_operation_insert, and save_operation_merge
Returns:
The acl object reference


SAVE_ACL

public OT_OBJECTREFERENCE SAVE_ACL(P_ACL IN OT_ACL, 
P_USER_REFERENCE IN OT_USERREFERENCE DEFAULT NULL,
P_RESYNC_MEMBERS IN VARCHAR2 DEFAULT 'Y',
P_UPDATE_ACL IN VARCHAR2 DEFAULT 'Y')


SAVE_ACL_MEMBERS

public OT_OBJECTREFERENCE SAVE_ACL_MEMBERS(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_ACL_REFERENCE IN OT_OBJECTREFERENCE,
P_MEMBERS IN CT_ACL_MEMBERS,
P_CHILD_OPERATION IN VARCHAR2)
Updates the list of members for the given acl.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_ACL_REFERENCE - Reference to the acl to be updated
P_MEMBERS - List of acl members
P_CHILD_OPERATION - Specifies how the acl members should be saved, valid values are save_operation_replaceall, save_operation_delete, save_operation_insert, and save_operation_merge
Returns:
The acl object reference


SAVE_ATTRIBUTE

public OT_OBJECTREFERENCE SAVE_ATTRIBUTE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_ATTRIBUTE IN OT_ATTRIBUTE,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
Adds or updates the given attribute
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_ATTRIBUTE - The attribute object to be saved
P_OPERATION - Specifies how the attribute should be saved, valid values are save_operation_merge, and save_operation_insert
Returns:
The attrbute object reference


SAVE_DIMENSION

public OT_OBJECTREFERENCE SAVE_DIMENSION(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DIMENSION IN OT_DIMENSION,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
Adds or updates the given dimension
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DIMENSION - The dimension object to be saved
P_OPERATION - Specifies how the dimension should be saved, valid values are save_operation_merge, and save_operation_insert
Returns:
The dimension object reference


SAVE_DIMENSION_TYPE

public OT_OBJECTREFERENCE SAVE_DIMENSION_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DIMENSION_TYPE IN OT_DIMENSION_TYPE,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
Adds or updates the given dimension type
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DIMENSION_TYPE - The dimension type object to be saved.
P_OPERATION - Specifies how the dimension type should be saved, valid values are save_operation_merge, and save_operation_insert
Returns:
The dimension type object reference


SAVE_DOCUMENT

public OT_OBJECTREFERENCE SAVE_DOCUMENT(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT IN OT_DOCUMENT,
P_DOCUMENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE,
P_ATTRIBUTE_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_REPLACEALL,
P_CONTENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE,
P_VERSION_MODE IN NUMBER DEFAULT NULL,
P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL,
P_EVENT_MODE IN VARCHAR2 DEFAULT NULL,
P_IS_EXTERNAL IN BOOLEAN DEFAULT TRUE)
Adds or updates the given document.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT - The document to be saved
P_DOCUMENT_OPERATION - Specifies how the document should be saved, valid values are save_operation_merge, save_operation_replace,and save_operation_none
P_ATTRIBUTE_OPERATION - Specifies how the document attributes should be saved, valid values are save_operation_merge, save_operation_none, and save_operation_replaceall
P_CONTENT_OPERATION - Specifies how the document content should be saved, valid values are save_operation_merge, save_operation_replace, save_operation_replace_all save_operation_delete, save_operation_delete_value and save_operation_none
P_VERSION_MODE - Version type to use. Used together with version control, which is given by the information type of the document (applicable both for insert and update of a document):
  • For insert, given version control = "Prompt":
    • 0 - to insert document without version control
    • 1 - to insert document with version control "Simple"
  • For update, given version control = "Audit":
    • 1 - to insert a new, inactive version of the document
    • 2 - to insert a new, active version of the document.
  • For update, given version control = "Simple":
    • 1 - to insert a new, inactive version of the document
    • 2 - to insert a new, active version of the document
    • 3 - to update the active version of the document, rather than insert a new version.
P_VERSION_COMMENT - Version comment
P_EVENT_MODE - Mode (string) sent to the event engine.
P_IS_EXTERNAL - DEPRECATED FROM 6.7 TRUE indicates that the document to be saved is external to iKB, FALSE indicates that the document to be saved has its origin in iKB
Returns:
The document object reference


SAVE_DOCUMENT

public OT_OBJECTREFERENCE SAVE_DOCUMENT(P_DOCUMENT IN OT_DOCUMENT, 
P_EXTERNAL_ENTITY IN VARCHAR2 DEFAULT NULL,
P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL,
P_VERSION_TYPE IN NUMBER DEFAULT NULL,
P_USER_ID IN OT_USERREFERENCE,
P_SAVE_METHOD IN VARCHAR2 DEFAULT 'COMPLETE',
P_IS_EXTERNAL IN NUMBER DEFAULT 1,
P_EVENT_MODE IN VARCHAR2 DEFAULT NULL)


SAVE_DOCUMENT_ATTRIBUTES

public OT_OBJECTREFERENCE SAVE_DOCUMENT_ATTRIBUTES(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_REFERENCE IN OT_OBJECTREFERENCE DEFAULT OT_OBJECTREFERENCE(),
P_ATTRIBUTES IN CT_DOCUMENT_ATTRIBUTES DEFAULT CT_DOCUMENT_ATTRIBUTES(),
P_ATTRIBUTE_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE,
P_VERSION_MODE IN NUMBER DEFAULT NULL,
P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL,
P_EVENT_MODE IN VARCHAR2 DEFAULT NULL,
P_IS_EXTERNAL IN BOOLEAN DEFAULT TRUE)
Adds or updates a set of attributes for the given document.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT_REFERENCE - Reference to the document for which to save the given attributes
P_ATTRIBUTES - The attributes to be saved
P_ATTRIBUTE_OPERATION - Specifies how the attributes should be saved, valid values are save_operation_merge, save_operation_replace, save_operation_delete, save_operation_delete_value and save_operation_replaceall,
P_VERSION_MODE - Version type to use, see save_document for further information
P_VERSION_COMMENT - Version comment
P_EVENT_MODE - Mode (string) sent to the event engine.
P_IS_EXTERNAL - DEPRECATED FROM 6.7 TRUE indicates that the document to be processed is external to iKB, FALSE indicates that the document to be processed has its origin in iKB
Returns:
The document object reference


SAVE_DOCUMENT_ATTRIBUTES

public OT_OBJECTREFERENCE SAVE_DOCUMENT_ATTRIBUTES(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_REFERENCE IN OT_DOCUMENT_REFERENCE DEFAULT OT_DOCUMENT_REFERENCE(),
P_ATTRIBUTES IN CT_DOCUMENT_ATTRIBUTES DEFAULT CT_DOCUMENT_ATTRIBUTES(),
P_ATTRIBUTE_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE,
P_VERSION_MODE IN NUMBER DEFAULT NULL,
P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL,
P_EVENT_MODE IN VARCHAR2 DEFAULT NULL,
P_IS_EXTERNAL IN BOOLEAN DEFAULT TRUE)


SAVE_DOCUMENT_TYPE

public OT_OBJECTREFERENCE SAVE_DOCUMENT_TYPE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENT_TYPE IN OT_DOCUMENT_TYPE,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
Adds or updates the given document type
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_DOCUMENT_TYPE - The document type object to be saved
P_OPERATION - Specifies how the document type should be saved, valid values are save_operation_merge, and save_operation_insert
Returns:
The document type object reference


SAVE_DOCUMENTS

public CT_OBJECTREFERENCE SAVE_DOCUMENTS(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_DOCUMENTS IN CT_DOCUMENTS,
P_DOCUMENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE,
P_ATTRIBUTE_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_REPLACEALL,
P_CONTENT_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE,
P_VERSION_MODE IN NUMBER DEFAULT NULL,
P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL,
P_EVENT_MODE IN VARCHAR2 DEFAULT NULL,
P_IS_EXTERNAL IN BOOLEAN DEFAULT TRUE)
Processes a collection of documents, by calling save_document for each.

See also:
ikb_service_api.save_document

SAVE_DOCUMENTS

public CT_OBJECTREFERENCE SAVE_DOCUMENTS(P_DOCUMENTS IN CT_DOCUMENTS, 
P_EXTERNAL_ENTITY IN VARCHAR2 DEFAULT NULL,
P_VERSION_COMMENT IN VARCHAR2 DEFAULT NULL,
P_VERSION_TYPE IN NUMBER DEFAULT NULL,
P_USER_ID IN OT_USERREFERENCE,
P_SAVE_METHOD IN VARCHAR2 DEFAULT 'COMPLETE',
P_IS_EXTERNAL IN NUMBER DEFAULT 1,
P_EVENT_MODE IN VARCHAR2 DEFAULT NULL)


SAVE_GROUP

public OT_OBJECTREFERENCE SAVE_GROUP(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_GROUP IN OT_GROUP,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE,
P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_REPLACEALL)
Adds or modifies the given group.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_GROUP - The group object to be saved, inclusive all members and prompts
P_OPERATION - Specifies how the group should be saved, valid values are save_operation_merge, save_operation_insert, and save_operation_none
P_CHILD_OPERATION - Specifies how the group members should be saved, valid values are save_operation_replaceall, save_operation_delete, save_operation_insert, and save_operation_merge
Returns:
The group object reference


SAVE_GROUP_MEMBERS

public OT_OBJECTREFERENCE SAVE_GROUP_MEMBERS(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_GROUP_REFERENCE IN OT_OBJECTREFERENCE,
P_MEMBERS IN CT_USERREFERENCE,
P_CHILD_OPERATION IN VARCHAR2)
Updates the list of members for the given group.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_GROUP_REFERENCE - Reference to the group to be updated
P_MEMBERS - List of group members
P_CHILD_OPERATION - Specifies how the group members should be saved, valid values are save_operation_replaceall, save_operation_delete, save_operation_insert, and save_operation_merge
Returns:
The group object reference


SAVE_SITE

public OT_OBJECTREFERENCE SAVE_SITE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_SITE IN OT_SITE,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
Adds or updates the given site
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_SITE - The site object to be saved
P_OPERATION - Specifies how the site should be saved. valid values are save_operation_merge, and save_operation_insert
Returns:
The site object reference


SAVE_SUBSYSTEM

public OT_OBJECTREFERENCE SAVE_SUBSYSTEM(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_SUBSYSTEM IN OT_SUBSYSTEM,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
Adds or updates the given subsystem
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_SUBSYSTEM - The subsystem object to be saved
P_OPERATION - Specifies how the subsystem should be saved. valid values are save_operation_merge, and save_operation_insert
Returns:
The subsystem object reference


SAVE_USER

public OT_USERREFERENCE SAVE_USER(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_USER IN OT_USER,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE)
Adds or modifies the given user.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_USER - The user object to be saved
P_OPERATION - Specifies how the user should be saved, valid values are save_operation_merge and save_operation_insert
Returns:
The user object reference


SAVE_VALUELIST

public OT_OBJECTREFERENCE SAVE_VALUELIST(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_VALUELIST IN OT_VALUELIST,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_MERGE,
P_CHILD_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_REPLACEALL)
Adds or updates the given valuelist.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_VALUELIST - The valuelist object to be saved
P_OPERATION - Specifies how the valuelist should be saved, valid values are save_operation_merge, save_operation_insert, and save_operation_none
P_CHILD_OPERATION - Specifies how the valuelist's values should be saved, valid values are save_operation_replaceall,save_operation_delete, save_operation_insert, and save_operation_merge
Returns:
The valuelist object reference


SAVE_VALUELIST_VALUE

public OT_OBJECTREFERENCE SAVE_VALUELIST_VALUE(P_EXECUTION_USER IN OT_USERREFERENCE, 
P_VALUELIST_REFERENCE IN OT_OBJECTREFERENCE,
P_VALUELIST_VALUE IN OT_VALUELIST_VALUE,
P_OPERATION IN VARCHAR2 DEFAULT IKB_SERVICE_API.SAVE_OPERATION_INSERT)
Adds, updates, or deletes the given value of the given valuelist.
Parameters:
P_EXECUTION_USER - Reference to the authenticated user executing the statement
P_VALUELIST_REFERENCE - Reference to the valuelist object for which to add/update/delete the given value
P_VALUELIST_VALUE - The valuelist value object
P_OPERATION - Specifies how the valuelist's values should be saved, valid values are save_operation_delete, save_operation_insert, and save_operation_merge
Returns:
The valuelist value object reference or NULL if the value is deleted


iKnowBase