Plugin API » Schema » SCHEMA (global) » Query functions » Qualifier queries

Qualifier queries

Plugins can query the schema to find out more information about the qualifiers defined in the current application.

Schema query

function SCHEMA.getQualifierInfo(qualifier)

Returns a JavaScript object with properties describing the qualifier, described below.

qualifier must be one of the QUAL properties. You should not rely on the exact underlying type of this value in your code.

Info properties

Each qualifier information object contains the following keys:

key name

The name of the qualifier, suitable for displaying to the user.

key code

The API code for the qualifier, eg "dc:qualifier:alternative". May be undefined if the qualifier does not have an API code.

key shortName

The short name, or “search name”, of the qualifier. Used in search constraints.