9 Parameter Sets

This is a public interface for operations involving Parameter sets. These APIs provide procedures to create Parameter sets, modify Parameter set details, remove Parameter sets, check in, check out and uncheckout Parameter sets.

9.1 Create and Modify Parameter Sets

This section contains the following topics:

• Section 9.1.1, "Create a Parameter Set Definition"

• Section 9.1.2, "Check out a Parameter Set Definition"

• Section 9.1.3, "Modify a Parameter Set Definition"

• Section 9.1.4, "Modify a Parameter Set Detail"

• Section 9.1.5, "Check in a Parameter Set Definition"

• Section 9.1.6, "Remove a Parameter Set Definition"

9.1.1 Create a Parameter Set Definition

Use this API to create a new Parameter Set definition, a new instance of an existing Parameter Set definition, or a new definition and an instance of it.

Name CDR_PUB_DF_PARAMETER_SET.CREATEPARAMETERSET

Signature 

PROCEDURE CREATEPARAMETERSET( 
  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_CDRPSOBJTYPE  IN    CDR_PARAM_SETS_OBJ_TYPE, 
  PI_CREATEOBJECT  IN    VARCHAR2, 
  PI_INSTANCE_SUBTYPE_ID  IN    CDR_NAMINGS.OBJECT_SUBTYPE_ID%TYPE, 
  PI_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.

  If you are creating a new definition only or a new definition and an instance of it, enter values for the new definition.

  If you are creating an instance of an existing definition, enter values to identify the definition. For OBJECT_TYPE_RC enter $OBJTYPES$PARAMSET if you are creating a definition only; $OBJTYPES$PARAMSETREF if you are creating an instance of an existing definition; and NULL if you are creating a new definition and an instance of it.

• PI_CDRPSOBJTYPE (Optional) This is a parameter of table type CDR_PARAM_SETS_OBJ_TYPE that contains object attributes specific to Parameter Sets.

  If you are creating a new definition, enter values for the new Parameter Set.

  The following attributes are required: COMPANY_ID, USAGE, PR_REF_ID, PR_REF_VER.

  If you are creating an instance of an existing Parameter Set, do not enter any values here.

• PI_CREATEOBJECT (Mandatory) Enter DEFN to create a definition only; INST to create a instance of an existing definition; or BOTH to create a new definition and an instance of it.

• PI_INSTANCE_SUBTYPE_ID (Optional) If you are creating a new instance, enter the ID for the subtype you want to give the instance.

  If you are creating a definition only, do not enter a value for this parameter.

• PI_DEFCLASSIFICATIONCOLL (Optional) By default, the new definition 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 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 Parameter Sets. Do not enter any values for them.

  If you are not creating a new definition, do not enter values here.

9.1.2 Check out a Parameter Set Definition

Use this API to check out a Parameter Set definition either directly or through an instance of it.

Name CDR_PUB_DF_PARAMETER_SET.CHECKOUTPARAMETERSET

Signature 

PROCEDURE CHECKOUTPARAMETERSET( 
  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_BASEOBJECT  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_COMMENT  IN    VARCHAR2, 
  PI_ISINSTONLY  IN    VARCHAR2 
); 

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

• PIO_BASEOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE that contains object attributes. Enter values to identify the Parameter Set that you want to check out.

  If you are checking out the Parameter Set definition directly, enter values to identify the definition.

  If you are checking out a Parameter Set definition through an instance of it, enter values to identify the instance.

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

• PI_COMMENT (Optional) Enter the reason you are checking out the Parameter Set.

• PI_ISINSTONLY (Mandatory) Enter $YESNO$NO.

9.1.3 Modify a Parameter Set Definition

Use this API to modify the name or description of a Parameter Set definition.

Name CDR_PUB_DF_PARAMETER_SET.MODIFYPARAMETERSETDEFINITION

Signature 

PROCEDURE MODIFYPARAMETERSETDEFINITION( 
  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_CDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE 
); 

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

PIO_CDRNAMING (Mandatory) This is a parameter of table type CDR_NAMING_VERSION_OBJ_TYPE that contains object attributes. Enter values to identify the Parameter Set and enter new values for the attributes you want to modify. You can change the name or description.

Note:

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

9.1.4 Modify a Parameter Set Detail

Use this API to modify Parameter Set details.

Name CDR_PUB_DF_PARAMETER_SET.MODIFYPARAMETERSETDETAILS

Signature 

PROCEDURE MODIFYPARAMETERSETDETAILS( 
  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_CDRNAMING  IN OUT    CDR_NAMING_VERSION_OBJ_TYPE 
);

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

PIO_CDRNAMING Naming details of the parameter set object to be modified.

9.1.5 Check in a Parameter Set Definition

Use this API to check in a Parameter Set definition.

Name CDR_PUB_DF_PARAMETER_SET.CHECKINPARAMETERSETDEFINITION

Signature 

PROCEDURE CHECKINPARAMETERSETDEFINITION( 
  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_BASEOBJECT  IN OUT    CDR_BASE_OBJ_TYPE, 
  PI_COMMENT  IN    VARCHAR2 
);

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

• PIO_BASEOBJECT (Mandatory) This is a parameter of table type CDR_BASE_OBJ_TYPE that contains object attributes. Enter values to identify the Parameter Set definition that you want to check in.

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

• PI_COMMENT (Optional) Enter the reason you are checking in the Parameter Set.

9.1.6 Remove a Parameter Set Definition

Use this API to remove one or more Parameter Set definitions or instances.

Name CDR_PUB_DF_PARAMETER_SET.REMOVEPARAMETERSET

Signature 

PROCEDURE REMOVEPARAMETERSET( 
  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_CDRBASEOBJCOLL  IN OUT    CDR_BASE_OBJ_COLL 
); 

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

PIO_CDRBASEOBJCOLL (Mandatory) This is a collection of CDR_BASE_OBJ_TYPEs.

For each Parameter Set that you want to remove, 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.