Get Flag Name Definitions

Use this API to retrieve information about DMW flag name definitions.

Name

DME_PUB_FLAG_NAME.GetFlagNames

Signature

PROCEDURE GETFLAGNAMES
( P_API_VERSION IN VARCHAR2,   
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_CATEGORY_ID IN NUMBER DEFAULT NULL,
PI_SUBJECT_VISIT IN VARCHAR2 DEFAULT NULL,
PI_USER_SETTABLE IN VARCHAR2 DEFAULT NULL,
PO_FLAG_NAMES OUT NOCOPY DME_FLAG_NAME_COLL,
  );

Parameters

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

  • PI_CATEGORY_ID (Optional). Set to null to retrieve flags in all categories. To get flags from a given category, provide a valid category ID.
  • PI_SUBJECT_VISIT (Optional). Set to null to retrieve all flags irrespective of their being marked as subject_visit flags or not. To retrieve only subject_visit flags, enter either $YESNO$YES. To retrieve only record flags, enter $YESNO$NO.
  • PI_USER_SETTABLE (Optional). Set to null to retrieve flags whether or not they are settable by the user. To retrieve only user-settable flags, enter $YESNO$YES. To retrieve flags not settable by users, enter $YESNO$NO.
  • PO_FLAG_NAMES (Mandatory). This is a parameter of type DME_FLAG_NAME_COLL for the returned values.