6 Domains

This is a public interface for Domain-related operations, including creating, modifying, and removing Domains. It also includes functions for copying and moving objects into Domains.

6.1 Define and Modify Domains

This section contains the following topics:

Section 6.1.1, "Create a Domain"
Section 6.1.2, "Modify a Domain"
Section 6.1.3, "Copy a Domain"
Section 6.1.4, "Move Objects into a Domain"
Section 6.1.5, "Copy Objects into a Domain"
Section 6.1.6, "Copy Objects into a Domain and Check In"
Section 6.1.7, "Remove a Domain"

6.1.1 Create a Domain

Use this API to create a new Domain.

Name CDR_PUB_DF_DOMAIN.CreateDomain

Signature

PROCEDURE CREATEDOMAIN( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_SOURCECDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE, 
  PO_DEFCLASSIFICATIONCOLL  IN    CDR_CLASSIFICATIONS_COLL 
);

Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:

PIO_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSIONS_OBJ_TYPE that contains CDR Naming Version attributes. For OBJECT_TYPE_RC enter $OBJTYPES$LIBDOMAIN.
PO_DEFCLASSIFICATIONCOLL (Optional) By default the new Domain is classified according to the subtype you assigned it in the CDR_NAMING_VERSION_OBJ_TYPE.

If you want to override the default classifications for one or more classification levels, use this parameter. This is a collection of CDR_CLA_OBJ_TYPEs, which have 5 attributes, including CLA_LEVEL_ID and CLASSIFICATION_ID. I

f you want the definition to inherit its classifications for a particular level from its parent, enter the classification level ID and, for the CLASSIFICATION_ID, enter 0 (zero).

If you want to explicitly assign one or more terms for a particular level, initialize a CDR_CLA_OBJ_TYPE for each term, entering the classification level ID and, for the CLASSIFICATION_ID, the term ID. The PAR_ attributes are not relevant to Domains. Do not enter any values for them.

6.1.2 Modify a Domain

Use this API to modify a Domain.

Name CDR_PUB_DF_DOMAIN.ModifyDomain

Signature

PROCEDURE MODIFYDOMAIN( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_SOURCECDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE 
);

Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:

PIO_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Domain and enter new values for the attributes you want to modify. The COMPANY_ID, OBJ_ID and OBJ_VER of the domain to be modified should be initialized.

Note:

Use separate APIs for modifying the validation status and the version label: CDR_PUB_VL_VALIDATION. UPDATEVALSTATUS and CDR_PUB_DF_NAMING. UPDATEVERSIONLABEL.

6.1.3 Copy a Domain

Use this API to make a copy of a Domain.

Name CDR_PUB_DF_DOMAIN.CopyDomain

Signature

PROCEDURE COPYDOMAIN( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL 
);

Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:

PI_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Domain that you want to copy, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER.

6.1.4 Move Objects into a Domain

Use this API to move subdomains, Application Areas, and object definitions from one Domain or Application Area, into another Domain.

Name CDR_PUB_DF_DOMAIN.MoveObjectsIntoDomain

Signature

PROCEDURE MOVEOBJECTSINTODOMAIN( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL, 
  PI_CDRTARGETCONTAINEROBJECT  IN OUT    CDR_BASE_OBJ_TYPE 
);

Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:

PI_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each object that you want to move, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER
PI_CDRTARGETCONTAINEROBJECT (Mandatory) This is a parameter of CDR_BASE_OBJ_TYPE and contains basic naming details about the Domain into which you want move objects.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, and OBJECT_VERSION_NUMBER).

6.1.5 Copy Objects into a Domain

Use this API to copy objects into a Domain. You can copy subdomains, Application Areas, and object definitions from other Domains or Application Areas.

Name CDR_PUB_DF_DOMAIN.CopyObjectsIntoDomain

Signature

PROCEDURE COPYOBJECTSINTODOMAIN( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL, 
  PI_CDRTARGETCONTAINEROBJECT  IN OUT    CDR_BASE_OBJ_TYPE 
);

Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:

PI_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each object that you want to copy, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
PI_CDRTARGETCONTAINEROBJECT (Mandatory) This is a parameter of CDR_BASE_OBJ_TYPE and contains basic naming details about the Domain into which you want copy objects.

The following attributes are required: COMPANY_ID, OBJ_ID,OBJ_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, and OBJECT_VERSION_NUMBER).

6.1.6 Copy Objects into a Domain and Check In

Use this overloaded API to check in the objects copied into a Domain (if they are checked out in the source Domain).

Name CDR_PUB_DF_DOMAIN.CopyObjectsIntoDomain

Signature

PROCEDURE COPYOBJECTSINTODOMAIN( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PI_CDRBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL, 
  PI_CDRTARGETCONTAINEROBJECT  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_CHECKINFLAG  IN    VARCHAR 
);

Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:

PI_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each object that you want to copy, initialize a CDR_BASE_OBJ_TYPE and then extend the collection.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER.
PI_CDRTARGETCONTAINEROBJECT (Mandatory) This is a parameter of CDR_BASE_OBJ_TYPE and contains basic naming details about the Domain into which you want copy objects.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, and OBJECT_VERSION_NUMBER).
PI_CHECKINFLAG (Mandatory) Enter $YESNO$YES if you want to check in the copied objects, if they are checked out, and $YESNO$NO if you do not want to check in the copied objects.

6.1.7 Remove a Domain

Use this API to delete a Domain.

Name CDR_PUB_DF_DOMAIN.RemoveDomain

Signature

PROCEDURE REMOVEDOMAIN( 
  P_API_VERSION  IN    NUMBER, 
  P_INIT_MSG_LIST  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_COMMIT  IN    VARCHAR2 := CDR_PUB_DEF_CONSTANTS.G_FALSE, 
  P_VALIDATION_LEVEL  IN    NUMBER := CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL, 
  X_RETURN_STATUS  OUT    VARCHAR2, 
  X_MSG_COUNT  OUT    NUMBER, 
  X_MSG_DATA  OUT    VARCHAR2, 
  PIO_DOMAIN  IN OUT    CDR_BASE_OBJ_TYPE 
);

Parameters This API has standard parameters (see "Standard Parameters") and the following parameters:

PIO_DOMAIN Mandatory) This is a parameter of CDR_BASE_OBJ_TYPE and contains basic naming details about the Domain you want to delete.

The following attributes are required: COMPANY_ID, OBJ_ID,OBJ_VER, NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, and OBJECT_VERSION_NUMBER).