%iKnow.Queries.MetadataI
abstract class %iKnow.Queries.MetadataI extends %Library.RegisteredObject
This is the interface to interact with metadata as expected by other parts of the iKnow libraries. A simple but flexible implementation is provided through %iKnow.Queries.MetadataAPI, but customers can choose to develop their own or wire to an existing metadata infrastructure by implementing the interface specified in this class.
Method Inventory
- AddField()
- CreateFilter()
- EndBatch()
- GetFieldId()
- GetFieldInfo()
- GetFieldInfoById()
- GetFields()
- GetValue()
- GetValueById()
- SetValue()
- SetValueById()
- StartBatch()
Parameters
Methods
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
- For dataType, choose either $$$MDDTSTRING, $$$MDDTNUMBER or $$$MDDTDATE ($horolog format)
- Use storage to control the way how values are stored: $$$MDSTNORMAL for cases where you would use a normal Caché index, $$$MDSTBITMAP where you would use a Caché bitmap index (few different metadata values compared to total # of records)
- 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.
Ends a metadata batch. See StartBatch() for more details.
Returns all field definitions (including their properties) for the given domain.
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.
Sets (or replaces if it exists) the value for a given metadata field (by ID) for a given source (by Source ID).
Values for fields of type $$$MDDTSTRING are normalized and stripped of whitespace and control characters at the beginning and end of the string.
Starts a 'batch' during which metadata values can be set. Some setting operations and index recalculations are optimized for batch processing.
NOTE: It is currently up to the user to make sure no metadata values are read during the batch and no values exist already (as replacing a value involves reading it). Reading metadata field values during a batch is not guaranteed to return correct results.
Inherited Members
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()