30 Code Lists

This is a public interface for all operations related to Code Lists, including creation, deletion, modification, and checking in and out of these objects.

This section includes the Code List APIs from the following package: DME_PUB_CODE_LISTS.

Create and Modify Code Lists

This section contains the following public APIs:

Create a Code List
Modify a Code List
Remove a Code List
Check In a Code List
Check Out a Code List
Add Values to a Code List
Remove Values from a Code List
Get Code List Details for a Given Column

Create a Code List

Use this API to create a code list under a library domain. Code lists created with this API can be verified through public view 'DME_PUB_CODELIST_V'. For values refer 'DME_PUB_CODELIST_VALUES_V'.

Name DME_PUB_CODE_LISTS.CreateCodeList

Signature:

PROCEDURE CREATECODELIST
(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,
P_NAMING           IN OUT NOCOPY cdr_naming_version_obj_type,
P_CODELISTCOLL     IN CDR_CODE_LIST_COLL,
X_RETURN_STATUS OUT NOCOPY VARCHAR2,
X_MSG_COUNT OUT NOCOPY     NUMBER,
X_MSG_DATA OUT NOCOPY      VARCHAR2,
  );

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

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE that contains naming attributes. The attributes required for this API are:
- COMPANY_ID
- NAME
- NAMESPACE_OBJ_ID
- NAMESPACE_OBJ_VER
- NAMESPACE_START_OBJ_VER as 1
- NAMESPACE_END_OBJ_VER as 999999
- DESCRIPTION
- OBJECT_TYPE_RC as '$OBJTYPES$CODELIST'
P_CODELISTCOLL (Optional). This is a parameter of type CDR_CODE_LIST_COLL. Collection of code value pairs. For example:
```
CDR_CODE_LIST_COLL(CDR_CODE_LIST_OBJ_TYPE('CDE1', 'VAL1'), CDR_CODE_LIST_OBJ_TYPE('CDE2', 'VAL2');
```

Modify a Code List

Use this API to modify the naming attributes of a code list. Code lists modified with this API can be verified through public view 'DME_PUB_CODELIST_V'.

Name DME_PUB_CODE_LISTS.ModifyCodeList

Signature:

PROCEDURE MODIFYCODELIST
(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,
P_NAMING            IN OUT NOCOPY CDR_NAMING_VERSION_OBJ_TYPE,
X_RETURN_STATUS     OUT NOCOPY VARCHAR2,
X_MSG_COUNT         OUT NOCOPY NUMBER,
X_MSG_DATA          OUT NOCOPY VARCHAR2,
);

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

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE that contains naming attributes. Naming details of the Code list to which the code-value pairs have to be modified. Whole naming object needs to be populated for the object which needs to be modified. API 'CDR_PUB_DEF_FACTORY_SUPPORT.GETNAMINGOBJECT' can be used to populate naming object, and then the values, which user wanted to be modified, e.g: NAME, DESCRIPTION.

Remove a Code List

Use this API to remove a code list. After this API is executed, public view 'DME_PUB_CODELIST_V' will not display the code list.

Name DME_PUB_CODE_LISTS.RemoveCodeList

Signature:

PROCEDURE REMOVECODELIST
  (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,    P_NAMING           IN OUT NOCOPY cdr_naming_version_obj_type,    X_RETURN_STATUS OUT NOCOPY VARCHAR2,    X_MSG_COUNT OUT NOCOPY     NUMBER,    X_MSG_DATA OUT NOCOPY      VARCHAR2
);

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

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE that contains naming attributes. Naming details of the code list to which the code-value pairs have to be removed. Whole naming object needs to be populated for the object which needs to be removed. API 'CDR_PUB_DEF_FACTORY_SUPPORT.GETNAMINGOBJECT' can be used to populate naming object.

Check In a Code List

Use this API to check in a code list. Changed status can be verified through public view 'DME_PUB_CODELIST_V'.

Name DME_PUB_CODE_LISTS.CheckinCodeList

Signature:

PROCEDURE CHECKINCODELIST
  (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,    p_naming           IN OUT NOCOPY cdr_naming_version_obj_type,    x_return_status OUT NOCOPY VARCHAR2,    x_msg_count OUT NOCOPY     NUMBER,    x_msg_data OUT NOCOPY      VARCHAR2
);

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

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE that contains naming attributes. Whole naming object needs to be populated for the object which needs to be checked-in. API 'CDR_PUB_DEF_FACTORY_SUPPORT.GETNAMINGOBJECT' can be used to populate naming object

Check Out a Code List

Use this API to check out a code list. Changed status can be verified through public view 'DME_PUB_CODELIST_V'.

Name DME_PUB_CODE_LISTS.CheckoutCodeList

Signature:

PROCEDURE CHECKOUTCODELIST
  ( 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,    P_NAMING           IN OUT NOCOPY cdr_naming_version_obj_type,    X_RETURN_STATUS OUT NOCOPY VARCHAR2,    X_MSG_COUNT OUT NOCOPY     NUMBER,    X_MSG_DATA OUT NOCOPY      VARCHAR2)
);

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

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE that contains naming attributes. Whole naming object needs to be populated for the object which needs to be checked-out. API 'CDR_PUB_DEF_FACTORY_SUPPORT.GETNAMINGOBJECT' can be used to populate naming object.

Add Values to a Code List

Use this API to add code value pairs to a code list. Code list values created with this API can be verified through public view 'DME_PUB_CODELIST_VALUES_V'.

Name DME_PUB_CODE_LISTS.AddCodeListValues

Signature:

PROCEDURE ADDCODELISTVALUES
  (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,    P_NAMING           IN OUT NOCOPY cdr_naming_version_obj_type ,    P_CODELISTCOLL     IN CDR_CODE_LIST_COLL ,    X_RETURN_STATUS OUT NOCOPY VARCHAR2 ,    X_MSG_COUNT OUT NOCOPY     NUMBER ,    X_MSG_DATA OUT NOCOPY      VARCHAR2)
);

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

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE that contains naming attributes. Whole naming object needs to be populated for the object which needs code values to be added to it. API 'CDR_PUB_DEF_FACTORY_SUPPORT.GETNAMINGOBJECT' can be used to populate naming object.
P_CODELISTCOLL (Mandatory). This is a parameter of type CDR_CODE_LIST_COLL. Collection of code value pairs. For example:

CDR_CODE_LIST_COLL(CDR_CODE_LIST_OBJ_TYPE('CDE1', 'VAL1'), CDR_CODE_LIST_OBJ_TYPE('CDE2', 'VAL2');

Remove Values from a Code List

Use this API to remove code value pairs to a code list. After this API is executed, public view 'DME_PUB_CODELIST_V' will not display the code list values.

Name DME_PUB_CODE_LISTS.AddCodeListValues

Signature:

PROCEDURE REMOVECODELISTVALUES
  (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,    P_NAMING           IN OUT NOCOPY cdr_naming_version_obj_type,    P_CODELISTCOLL     IN CDR_CODE_LIST_COLL,    X_RETURN_STATUS OUT NOCOPY VARCHAR2,    X_MSG_COUNT OUT NOCOPY     NUMBER,    X_MSG_DATA OUT NOCOPY      VARCHAR2
);

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

P_NAMING (Mandatory). This is a parameter of type CDR_NAMING_VERSION_OBJ_TYPE that contains naming attributes. Whole naming object needs to be populated for the object which needs code values to be added to it. API 'CDR_PUB_DEF_FACTORY_SUPPORT.GETNAMINGOBJECT' can be used to populate naming object.
P_CODELISTCOLL (Mandatory). This is a parameter of type CDR_CODE_LIST_COLL. Collection of code value pairs. For example:
```
CDR_CODE_LIST_COLL(CDR_CODE_LIST_OBJ_TYPE('CDE1', 'VAL1'), CDR_CODE_LIST_OBJ_TYPE('CDE2', 'VAL2');
```

Get Code List Details for a Given Column

Use this API to get the code list details for a given column.

Name DME_PUB_CODE_LISTS. getCodeListDetail

Signature:

PROCEDURE GETCODELISTDETAIL
  (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,    PI_COLCOMPANYID    IN cdr_naming_versions.company_id%type,    PI_COLOBJID        IN cdr_naming_versions.obj_id%type,    PI_COLOBJVER       IN cdr_naming_versions.obj_ver%type,    PO_CODELISTID      OUT NOCOPY cdr_naming_versions.obj_id%type,    PO_CODELISTVER     OUT NOCOPY cdr_naming_versions.obj_Ver%type
);

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

PI_COLCOMPANYID (Mandatory). COMPANY_ID of a Column.
PI_COLOBJID (Mandatory). Object Identifier of a Column
PI_COLOBJVER (Mandatory). Object Version of a Column
PO_CODELISTID . This is out parameter. It returns the Object Id of associated code list.
PO_CODELISTVER. This is out parameter. It returns the Object Version of associated code list.