Class %iKnow.Queries.MetadataQAPI

class %iKnow.Queries.MetadataQAPI extends %iKnow.Queries.AbstractQAPI

This is an automatically generated class, offering a functionally equivalent set of methods and queries as %iKnow.Queries.MetadataAPI, exposed as SqlProc methods.

See the classdocs for %iKnow.Queries.MetadataAPI for more information.

This class was generated by %iKnow.Queries.MetadataAPI.

Inventory

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
		33	7

Summary

Methods
%%OIDGet	%AddToSaveSet	%ClassIsLatestVersion	%ClassName
%ConstructClone	%DispatchClassMethod	%DispatchGetModified	%DispatchGetProperty
%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty	%DispatchSetProperty
%Extends	%GetParameter	%IsA	%IsModified
%New	%NormalizeObject	%ObjectModified	%OriginalNamespace
%PackageName	%RemoveFromSaveSet	%SerializeObject	%SetModified
%ValidateObject	AddField	AddListOfValues	AddLovValue
GetFieldId	GetFieldValuesByIdClose	GetFieldValuesByIdExecute	GetFieldValuesByIdFetch
GetFieldValuesClose	GetFieldValuesExecute	GetFieldValuesFetch	GetFieldsClose
GetFieldsExecute	GetFieldsFetch	GetLovValuesClose	GetLovValuesExecute
GetLovValuesFetch	GetLovsClose	GetLovsExecute	GetLovsFetch
GetValue	GetValueById	GetValuesByIdClose	GetValuesByIdExecute
GetValuesByIdFetch	GetValuesClose	GetValuesExecute	GetValuesFetch
RemoveField	RemoveFieldById	SetValue	SetValueById
UpdateField	UpdateFieldById

Methods

• classmethod AddField(domainId As %Integer, fieldName As %String(MAXLEN=32767), supportedOperators As %String = $lb($$$MDOPEQUAL), dataType As %String(MAXLEN=32767)=$$$MDDTSTRING, buildBitstring As %Boolean = 0, caseSensitive As %Boolean = 0, lovId As %Integer = -1, validateLov As %Boolean = 1, hidden As %Boolean = 0, Output scText As %String = "") as %Library.Integer [ SQLProc ]

Adds a field definition with the given name and properties.

The supportedOperators parameter specifies which operations (such as $$$MDOPEQUAL) will be available for filtering criteria

If buildBitstring is true, the system will build a bitstring representation of all sources for every distinct metadata value, otherwise it will have entries for every source value and source.

For dataType, choose either $$$MDDTSTRING, $$$MDDTNUMBER or $$$MDDTDATE ($horolog format)

If buildBitstring is true, the system will build a bitstring representation of all sources for every distinct metadata value, otherwise it will have entries for every source value and source.

If dataType is $$$MDDTSTRING, caseSensitive controls whether or not string values should be treated as case-sensitive.

The lovId and validateLov parameters define wheter a List Of Values is available for this metadata field and whether input values should be verified against this list. See also AddListOfValues.

If hidden is set to true, the field will by default not appear in metadata field and value lists.

• classmethod AddListOfValues(domainId As %Integer, lovName As %String(MAXLEN=32767), autoExtend As %Boolean = 1, Output scText As %String = "") as %Library.Integer [ SQLProc ]

Adds a List Of Values to the domain, which can then be used as a list of allowable values for one or more metadata fields.

• classmethod AddLovValue(domainId As %Integer, lovId As %Integer, value As %String(MAXLEN=32767), ByRef rank As %Integer = -1) as %Boolean [ SQLProc ]

Adds a new value to an existing List Of Values

• classmethod GetFieldId(domainId As %Integer, fieldName As %String(MAXLEN=32767), Output scText As %String = "") as %Library.Integer [ SQLProc ]

Returns the metadata field ID corresponding to the supplied name, or "" if none exists in this domain.

• classmethod GetValue(domainId As %Integer, fieldName As %String(MAXLEN=32767), externalId As %String(MAXLEN=32767), Output scText As %String = "") as %Library.String [ SQLProc ]

Returns the actual value for a given metadata field (by name) and source (by External ID).

• classmethod GetValueById(domainId As %Integer, fieldId As %Integer, srcId As %Integer, Output scText As %String = "") as %Library.String [ SQLProc ]

Returns the actual value for a given metadata field (by ID) and source (by Source ID).

• classmethod RemoveField(domainId As %Integer, fieldName As %String(MAXLEN=32767)) as %Boolean [ SQLProc ]

Removes a metadata field (by name) from the domain, including all references by existing sources.

• classmethod RemoveFieldById(domainId As %Integer, fieldId As %Integer) as %Boolean [ SQLProc ]

Removes a metadata field (by ID) from the domain, including all references by existing sources.

• classmethod SetValue(domainId As %Integer, fieldName As %String(MAXLEN=32767), externalId As %String(MAXLEN=32767), value As %String(MAXLEN=32767)) as %Boolean [ SQLProc ]

Sets (or replaces if it exists) the value for a given metadata field (by name) for a given source (by External ID).

Values for fields of type $$$MDDTSTRING are normalized and stripped of whitespace and control characters at the beginning and end of the string.

• classmethod SetValueById(domainId As %Integer, fieldId As %Integer, srcId As %Integer, value As %String(MAXLEN=32767)) as %Boolean [ SQLProc ]

Sets (or replaces if it exists) the value for a given metadata field (by ID) for a given source (by Source ID). Explicitly setting a value to "" (null/empty string) will erase the current value.

Values for fields of type $$$MDDTSTRING are normalized and stripped of whitespace and control characters at the beginning and end of the string.

• classmethod UpdateField(domainId As %Integer, fieldName As %String(MAXLEN=32767), supportedOperators As %String = "", buildBitstring As %Integer = -1, hidden As %Integer = -1, lovId As %Integer = -2, validateLov As %Integer = -1) as %Boolean [ SQLProc ]

Updates the properties for a given metadata field (by name). See also AddField.

Specifying a "" for the supportedOperators will leave the current value for that property. Similarly, specifying -1 for buildBitString, hidden and validateLov or -2 for lovId will leave their respective values unmodified. Setting lovId to -1 will unset the LOV for this field.

• classmethod UpdateFieldById(domainId As %Integer, fieldId As %Integer, supportedOperators As %String = "", buildBitstring As %Integer = -1, hidden As %Integer = -1, lovId As %Integer = -2, validateLov As %Integer = -1) as %Boolean [ SQLProc ]

Updates the properties for a given metadata field (by ID). See also AddField.

Specifying a "" for the supportedOperators will leave the current value for that property. Similarly, specifying -1 for buildBitString, hidden and validateLov or -2 for lovId will leave their respective values unmodified. Setting lovId to -1 will unset the LOV for this field.

Queries

• query GetFieldValues(domainId As %Integer, fieldName As %String(MAXLEN=32767), page As %Integer = 1, pageSize As %Integer = 10)

Selects value As %String(MAXLEN=32767)

Returns all the distinct values currently in use for a given metadata field (by name).

• query GetFieldValuesById(domainId As %Integer, mdFieldId As %Integer, page As %Integer = 1, pageSize As %Integer = 10)

Selects value As %String(MAXLEN=32767)

Returns all the distinct values currently in use for a given metadata field (by ID).

• query GetFields(domainId As %Integer, includeHidden As %Boolean = 0)

Selects mdFieldId As %Integer, fieldName As %String(MAXLEN=32767), supportedOperators As %List, dataType As %String(MAXLEN=32767), buildBitstring As %Boolean, caseSensitive As %Boolean, lovId As %Integer, validateLov As %Boolean, hidden As %Boolean

Returns all field definitions (including their properties) for the given domain.

Setting includeHidden to true will also return any metadata fields marked as 'hidden'.

• query GetLovValues(domainId As %Integer, lovId As %Integer)

Selects value As %String(MAXLEN=32767)

Returns all the allowed values for a given metadata LOV.

• query GetLovs(domainId As %Integer, page As %Integer = 1, pageSize As %Integer = 10)

Selects lovId As %Integer, name As %String(MAXLEN=32767), autoExtend As %Boolean

Returns a list of all the LOVs (List of Values) registered for this domain.

• query GetValues(domainId As %Integer, externalId As %String(MAXLEN=32767), includeHidden As %Boolean = 0)

Selects mdFieldId As %Integer, fieldName As %String(MAXLEN=32767), value As %String(MAXLEN=32767)

Returns the actual metadata values for the given source (by External ID).

Setting includeHidden to true will also return the values for hidden metadata fields.

• query GetValuesById(domainId As %Integer, srcId As %Integer, includeHidden As %Boolean = 0)

Selects mdFieldId As %Integer, fieldName As %String(MAXLEN=32767), value As %String(MAXLEN=32767)

Returns the actual metadata values for the given source (by Source ID).

Setting includeHidden to true will also return the values for hidden metadata fields.


[BASEXML] > [%iKnow] > [Queries] > [MetadataQAPI]		Private Storage