Check Out a Table

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

Name

CDR_PUB_DF_TABLE.Checkout

Signature

Procedure checkout(
p_api_version IN NUMBER
,p_init_msg_list IN VARCHAR2 default CDR_PUB_DEF_CONSTANTS.G_FALSE
,p_commit IN VARCHAR2 default CDR_PUB_DEF_CONSTANTS.G_FALSE
,p_validation_level IN NUMBER default CDR_PUB_DEF_CONSTANTS.G_VALID_LEVEL_FULL
,x_return_status OUT NOCOPY VARCHAR2
,x_msg_count OUT NOCOPY NUMBER
,x_msg_data OUT NOCOPY VARCHAR2
, pio_baseObject IN OUT NOCOPY 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 Table definition or an instance of it:
    • Pass the Table definition details if you want to check out and subsequently modify only the definition.
    • Pass the details of an instance of the Table definition if you want the instance to point to the new version of the Table definition.

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

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

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

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