Check Out a Load Set

Use this API to check out a Load Set definition or definition and instance.

Name

CDR_PUB_DF_LOADSET.CheckOutLoadSet

Signature

PROCEDURE CHECKOUTLOADSET( 
  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. You can enter values to identify either the Load Set definition or an instance of it:
  • Pass the Load Set definition details if you want to check out and subsequently modify only the definition.
  • Pass the details of an instance of the Load Set definition if you want the instance to point to the new version of the Load Set definition.

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

  To get the OBJECT_VERSION_NUMBER, enter the following query: select Max(OBJECT_VERSION_NUMBER) from cdr_vl_val_docs_v where OBJ_ID = <objid> and OBJ_VER = <objver> and DOC_STATUS_RC ='$VALINFOSTATUS$ACTIVE';

  NAMESPACE_OBJ_ID. If you are entering information about the Load Set definition, enter the object ID of its containing Application Area. If you are entering information about the Load Set instance, enter the object ID of its containing Work Area.

  NAMESPACE_OBJ_VER. If you are entering information about the Load Set, definition, enter the object version number of its containing Application Area. If you are entering information about the Load Set instance, enter the object version number of its containing Work Area.

• PI_COMMENT (Optional) Enter the reason you are checking out the Load Set.
• PI_ISINSTONLY Enter $YESNO$NO if you are checking out only the definition. Enter $YESNO$YES if you are checking out the definition through its instance.