24 Classification

This section contains the following topics:

Section 24.1, "Classify Objects"
Section 24.2, "Classify Subtypes"
Section 24.3, "Create and Modify Classification Hierarchy Values"

24.1 Classify Objects

This is a public interface for assigning and removing object classifications.

This section contains the following topics:

Section 24.1.1, "Classify an Object"
Section 24.1.2, "Declassify an Object"

24.1.1 Classify an Object

Use this API to classify Objects

Name CDR_PUB_CLA_OBJ_CLASSIFICATION.AssignObjectClassification

Signature

PROCEDURE ASSIGNOBJECTCLASSIFICATION( 
  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_OCLASSIFICATIONS  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_VERSION_OBJ_TYPE. Enter values to identify the object that you want to classify.

The following attributes are required: COMPANY_ID,OBJ_ID,OBJ_VER,OBJECT_VERSION_NUMBER,NAMESPACE_OBJ_ID,NAMESPACE_OBJ_VER,OBJECT_SUBTYPE_ID.
PI_OCLASSIFICATIONS This is a collection of CDR_CLA_OBJ_TYPEs, which have 5 attributes, including CLA_LEVEL_ID and CLASSIFICATION_ID.

If you want the OBJECT 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 relevant only to Planned Outputs.

If you are not classifying a Planned Output, do not enter any values for them.

If you are classifying a Planned Output and want to use a Parameter with a classification-driven list of values, use the PAR attributes to identify the Parameter you want to use.

24.1.2 Declassify an Object

Use this procedure to remove a single classification value from a defined Object.

Name CDR_PUB_CLA_OBJ_CLASSIFICATION.Declassify

Signature

PROCEDURE DECLASSIFY( 
  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_NOBJECTID  IN    CDR_NAMINGS.OBJ_ID%TYPE, 
  PI_NCLALEVELID  IN    PLS_INTEGER, 
  PI_NCLASSIFICATIONID  IN    PLS_INTEGER 
);

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

PI_NOBJECTID (Mandatory) Enter the object ID of the object from which you want to remove classifications.)
PI_NCLALEVELID (Mandatory) Enter the ID of the classification hierarchy level that contains the classification value, or term, that you want to remove.
PI_NCLASSIFICATIONID (Mandatory) Enter the ID of the classification value, or term, that you want to remove.

24.2 Classify Subtypes

This is a public interface for all Classification functions related to Subtypes.

This section contains the following topics:

Section 24.2.1, "Get a Subtype Classification Level"
Section 24.2.2, "Get an Object Classification Value"
Section 24.2.3, "Get a Parent Term"

24.2.1 Get a Subtype Classification Level

Use this API to retrieve all the classification hierarchy levels assigned to an Object Subtype. The function returns a collection of CDR_HIER_LEVEL_VAL_OBJ_TYPE.

Name CDR_PUB_CLA_SUBTYPES.GetClassificationLevels

Signature

FUNCTION GETCLASSIFICATIONLEVELS( 
  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, 
  PIOBJECTSUBTYPEID  IN    CDR_OBJECT_SUBTYPES_TL.OBJECT_SUBTYPE_ID%TYPE 
) RETURN CDR_HIER_LEVEL_VALUES_COLL;

Return

Type CDR_HIER_LEVEL_VALUES_COLL

Description classification levels.

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

PIOBJECTSUBTYPEID Enter the ID of the Object Subtype whose assigned classification levels you want to retrieve.

24.2.2 Get an Object Classification Value

Use this API to get the classifications assigned to the given object ID and version.

Name CDR_PUB_CLA_SUBTYPES.GetObjectClaValues

Signature

FUNCTION GETOBJECTCLAVALUES( 
  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, 
  POBJECTID  IN    CDR_OBJ_CLA_MAPPINGS.OBJ_ID%TYPE, 
  PIOBJECTSUBTYPEID  IN    CDR_OBJECT_SUBTYPES_TL.OBJECT_SUBTYPE_ID%TYPE 
) RETURN CDR_HIER_LEVEL_VALUES_COLL;

Return

Type CDR_HIER_LEVEL_VALUES_COLL

Description Classification values

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

POBJECTID (Mandatory) Enter the Object Id.
PIOBJECTSUBTYPEID (Mandatory) Enter the Object Subtype Id.

24.2.3 Get a Parent Term

Use this API to retrieve some or all of the terms on a particular level that are children of a particular parent term. The function returns a collection of CDR_HIER_LEVEL_VAL_OBJ_TYPEs.

Name CDR_PUB_CLA_SUBTYPES.GetClaHierValues

Signature

FUNCTION GETCLAHIERVALUES( 
  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, 
  PLEVELIDS  IN    CDR_OPA_ID_COLL, 
  PTERMS  IN    CDR_OPA_STRING_COLL, 
  PDOMAINID  IN    PLS_INTEGER, 
  PCLALEVELID  IN    CDR_SUBTYPE_CLA_LEVELS.CLA_LEVEL_ID%TYPE 
) RETURN CDR_HIER_LEVEL_VALUES_COLL;

Return

Type CDR_HIER_LEVEL_VALUES_COLL

Description Classification hierarchy values

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

PLEVELIDS (Mandatory) This is a collection of CDR_OPA_ID_OBJ_TYPEs. For each hierarchy level from the top level to the level from which you want to retrieve terms (but not lower), initialize a CDR_OPA_ID_OBJ_TYPE and then extend the collection.

The following attribute is required: CDR_OPA_ID.
PTERMS (Mandatory) This is a collection of CDR_OPA_STRING_OBJ_TYPEs. For each hierarchy level from the top level to the one from which you want to retrieve terms (but not lower), initialize a CDR_OPA_ID_OBJ_TYPE and then extend the collection. For the required attribute, CDR_OPA_STRING, enter the term whose related terms you want to retrieve, in order starting with the top level.
PDOMAINID Enter the ID of the LSH Instance Domain. Use the following query to get this ID: select * from TMS.TMS_DEF_DOMAINS where name = 'CDR_USER_HIER'
PCLALEVELID Enter the ID of the classification hierarchy level that contains the terms you are searching for.

24.3 Create and Modify Classification Hierarchy Values

This is a public interface for classification hierarchy value-related operations.

This section contains the following topics:

Section 24.3.1, "Insert a Classification Value"
Section 24.3.2, "Update a Classification Value"
Section 24.3.3, "Delete a Classification Value"

24.3.1 Insert a Classification Value

Use this API to insert values, or terms, into a classification hierarchy level, related to a term in the next higher level. The function returns 0 if the transaction failed and 1 if it succeeded.

Name CDR_PUB_CLA_HIERARCHY_VALS.InsertValues

Signature

FUNCTION INSERTVALUES( 
  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, 
  PPARENTCONTENTID  IN    TMS.TMS_DICT_CONTENTS.DICT_CONTENT_ID%TYPE, 
  PLEVELID  IN    TMS.TMS_DEF_LEVELS.DEF_LEVEL_ID%TYPE, 
  PVALUES  IN OUT    CDR_HIER_VAL_COLL 
) RETURN PLS_INTEGER;

Return

Type PLS_INTEGER

Description 0 is returned if the transaction fails

1 is returned if the transaction succeeds.

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

PPARENTCONTENTID Enter the ID of a term that serves as a parent to the terms you are inserting.
PLEVELID Enter the ID of the classification hierarchy level into which you want to insert the terms.
PVALUES (Mandatory) This is a collection of CDR_HIER_VAL_TYPEs. For each classification value (term) that you want to add as a child to the term you specified, initialize a CDR_HIER_VAL_TYPE and then extend the collection.

The following attributes are required: CONTENT_ID,TERM,ERROR_MSG,APPROVED_FLAG.

24.3.2 Update a Classification Value

Use this API to modify classification hierarchy values. It returns 1 for transaction success and 0 for failure. It also returns a PVALUES collection that includes error messages for any terms that could not be updated.

Name CDR_PUB_CLA_HIERARCHY_VALS.UpdateValues

Signature

FUNCTION UPDATEVALUES( 
  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, 
  PVALUES  IN OUT    CDR_HIER_VAL_COLL 
) RETURN PLS_INTEGER;

Return

Type PLS_INTEGER

Description 0 is returned if the transaction fails (Values will contain the errors).

1 is returned if the transaction succeeds.

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

PVALUES (Mandatory) This is a collection of CDR_HIER_VAL_TYPEs. For each classification value (term) that you want to modify, initialize a CDR_HIER_VAL_TYPE and then extend the collection.

The following attributes are required: CONTENT_ID,TERM,APPROVED_FLAG.

You can modify the term itself or its Approved flag value.

24.3.3 Delete a Classification Value

Use this API to delete classification values (terms). The API does not delete terms if they have been assigned as the default value for an object subtype or if they have been assigned to any object. If neither case is true, then the API deletes the term and any related terms it may have lower in the classification hierarchy.

Name CDR_PUB_CLA_HIERARCHY_VALS.DeleteValues

Signature

PROCEDURE DELETEVALUES( 
  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, 
  PVALUES  IN OUT    CDR_HIER_VAL_COLL 
);

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

PVALUES (Mandatory) This is a collection of CDR_HIER_VAL_TYPEs. For each classification value (term) that you want to delete, initialize a CDR_HIER_VAL_TYPE and then extend the collection.

The following attribute is required: CONTENT_ID.