3 Application Areas

This is a public interface for Application Area-related operationsâ creating, modifying, and removing Application Areas; as well as copying and moving object definitions into an Application Area.

3.1 Define and Modify Application Areas

This section contains the following topics:

Section 3.1.1, "Create an Application Area"
Section 3.1.2, "Modify an Application Area"
Section 3.1.3, "Remove an Application Area"
Section 3.1.4, "Copy Objects into an Application Area"
Section 3.1.5, "Move Objects into an Application Area"

3.1.1 Create an Application Area

Use this API to create a new Application Area.

Name CDR_PUB_DF_APPLICATIONAREA.CreateApplicationArea

Signature

PROCEDURE CREATEAPPLICATIONAREA( 
  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, 
  PI_DEFCLASSIFICATIONCOLL  IN    CDR_CLASSIFICATIONS_COLL 
);

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

PIO_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values for the Application Area you want to create.

The following attributes are required: company_id, namespace_obj_id, namespace_obj_ver, object_type_rc. for object_type_rc enter $objtypes$applarea.
PI_DEFCLASSIFICATIONCOLL(Optional) By default the new Application Area 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. If you want the Application Area to inherit its classifications for a particular level from its parent Domain, 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 Application Areas. Do not enter any values for them.

3.1.2 Modify an Application Area

Use this API to modify the name or description of an existing Application Area.

Name CDR_PUB_DF_APPLICATIONAREA.ModifyApplicationArea

Signature

PROCEDURE MODIFYAPPLICATIONAREA( 
  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 (see "Standard Parameters") as well as the following:

PIO_SOURCECDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE. Enter values to identify the Application Area you want to modify and for the attributes you want to modify. You can modify the name and description. All attributes are required.

3.1.3 Remove an Application Area

Use this API to remove one or more Application Areas and all its/their contents.

Name CDR_PUB_DF_APPLICATIONAREA.RemoveApplicationAreas

Signature

PROCEDURE REMOVEAPPLICATIONAREAS( 
  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_BASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL 
);

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

PI_BASEOBJCOLL Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each Application Area that you want to remove (including all its contents), 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.

3.1.4 Copy Objects into an Application Area

Use this API to copy object definitions into an Application Area.

Name CDR_PUB_DF_APPLICATIONAREA.CopyObjectIntoAA

Signature

PROCEDURE COPYOBJECTINTOAA( 
  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    VARCHAR2 
);

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

PI_CDRBASEOBJCOLL (Mandatory). This is a collection of CDR_BASE_OBJ_TYPEs. For each object that you want to copy into the Application Area, 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 table type CDR_BASE_OBJ_TYPE. Enter values to identify the Application Area into which you want to copy objects.

The following attributes are required: COMPANY_ID, OBJECT_ID, OBJECT_VER,NAMESPACE_OBJ_ID, NAMESPACE_OBJ_VER, OBJECT_VERSION_NUMBER.
PI_CHECKINFLAG (Mandatory). Enter $YESNO$NO if you want any checked-out copied objects to remain checked out, or $YESNO$YES if you want the system to check them in after the copy operation.

3.1.5 Move Objects into an Application Area

Use this API to move LSH objects into an Application Area.

Name CDR_PUB_DF_APPLICATIONAREA.MoveObjectIntoAA

Signature

PROCEDURE MOVEOBJECTINTOAA( 
  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 (see "Standard Parameters") as well as the following parameters:

PI_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs. For each object that you want to move into the Application Area, 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 table type CDR_BASE_OBJ_TYPE. Enter values to identify the Application Area into which you want to move objects.

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