MetadataWSAPI Class Reference

Inheritance diagram for MetadataWSAPI:

Collaboration diagram for MetadataWSAPI:

Static Public Member Functions
_.Library.Integer	AddField (_.Library.Integer domainId, _.Library.String fieldName, _.Library.ListOfDataTypes supportedOperators, _.Library.String dataType, _.Library.Integer storage, _.Library.Boolean caseSensitive, _.Library.Integer lovId, _.Library.Boolean validateLov, _.Library.Boolean hidden)
_.Library.Integer	AddListOfValues (_.Library.Integer domainId, _.Library.String lovName, _.Library.Boolean autoExtend)
_.Library.Boolean	AddLovValue (_.Library.Integer domainId, _.Library.Integer lovId, _.Library.String value, _.Library.Integer rank)
	Adds a new value to an existing List Of Values.
_.iKnow.Filters.Filter	CreateFilter (_.Library.Integer pDomainId, _.Library.String pFieldName, _.Library.String pOperator, _.Library.String pValue)
_.Library.Integer	GetFieldId (_.Library.Integer domainId, _.Library.String fieldName)
	Returns the metadata field ID corresponding to the supplied name, or "" if none exists in this domain.
_.XML.DataSet	GetFieldValues (_.Library.Integer domainId, _.Library.String fieldName, _.Library.Integer page, _.Library.Integer pageSize)
	Returns all the distinct values currently in use for a given metadata field (by name). More...
_.XML.DataSet	GetFieldValuesById (_.Library.Integer domainId, _.Library.Integer mdFieldId, _.Library.Integer page, _.Library.Integer pageSize)
	Returns all the distinct values currently in use for a given metadata field (by ID).
_.XML.DataSet	GetFields (_.Library.Integer domainId, _.Library.Boolean includeHidden)
_.XML.DataSet	GetLovValues (_.Library.Integer domainId, _.Library.Integer lovId)
	Returns all the allowed values for a given metadata LOV.
_.XML.DataSet	GetLovs (_.Library.Integer domainId, _.Library.Integer page, _.Library.Integer pageSize)
	Returns all LOVs (List of Values) registered for this domain.
_.Library.Integer	GetMetaSpreadByEntities (_.Library.Integer pDomainId, _.Library.String pFieldName, _.Library.ListOfDataTypes pEntityList, _.Library.String pFilter, _.Library.Integer pSetOp)
_.Library.Integer	GetMetaSpreadByEntityIds (_.Library.Integer pDomainId, _.Library.String pFieldName, _.Library.ListOfDataTypes pEntityIdList, _.Library.String pFilter, _.Library.Integer pSetOp)
_.Library.String	GetUniValue (_.Library.Integer pDomainId, _.Library.Integer pUniValueId)
	Returns the unique metadata value corresponding to the supplied pUniValueId.
_.Library.Integer	GetUniqueValueCount (_.Library.Integer pDomainId, _.Library.String pFieldName, _.Library.String pFilter)
_.XML.DataSet	GetUniqueValues (_.Library.Integer pDomainId, _.Library.String pFieldName, _.Library.Integer pPage, _.Library.Integer pPageSize, _.Library.String pFilter, _.Library.String pSortType)
_.XML.DataSet	GetUniqueValuesById (_.Library.Integer pDomainId, _.Library.Integer pFieldId, _.Library.Integer pPage, _.Library.Integer pPageSize, _.Library.String pFilter, _.Library.String pSortType)
_.Library.String	GetValue (_.Library.Integer domainId, _.Library.String fieldName, _.Library.String externalId)
	Returns the actual value for a given metadata field (by name) and source (by External ID).
_.Library.String	GetValueById (_.Library.Integer domainId, _.Library.Integer fieldId, _.Library.Integer srcId)
	Returns the actual value for a given metadata field (by ID) and source (by Source ID).
_.XML.DataSet	GetValues (_.Library.Integer domainId, _.Library.String externalId, _.Library.Boolean includeHidden)
_.XML.DataSet	GetValuesById (_.Library.Integer domainId, _.Library.Integer srcId, _.Library.Boolean includeHidden)
_.Library.Boolean	RemoveField (_.Library.Integer domainId, _.Library.String fieldName)
	Removes a metadata field (by name) from the domain, including all references by existing sources.
_.Library.Boolean	RemoveFieldById (_.Library.Integer domainId, _.Library.Integer fieldId)
	Removes a metadata field (by ID) from the domain, including all references by existing sources.
_.Library.Boolean	SetValue (_.Library.Integer domainId, _.Library.String fieldName, _.Library.String externalId, _.Library.String value)
_.Library.Boolean	SetValueById (_.Library.Integer domainId, _.Library.Integer fieldId, _.Library.Integer srcId, _.Library.String value)
_.Library.Boolean	UpdateField (_.Library.Integer domainId, _.Library.String fieldName, _.Library.ListOfDataTypes supportedOperators, _.Library.Integer storage, _.Library.Integer hidden, _.Library.Integer lovId, _.Library.Integer validateLov)
_.Library.Boolean	UpdateFieldById (_.Library.Integer domainId, _.Library.Integer fieldId, _.Library.ListOfDataTypes supportedOperators, _.Library.Integer storage, _.Library.Integer hidden, _.Library.Integer lovId, _.Library.Integer validateLov)

Static Public Attributes
	NAMESPACE = None

Detailed Description

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Queries.MetadataAPI</class>, exposed as WebMethod methods.

See the classdocs for <class>iKnow.Queries.MetadataAPI</class> for more information.

Member Function Documentation

AddField()

_.Library.Integer AddField ( _.Library.Integer  domainId, _.Library.String  fieldName, _.Library.ListOfDataTypes  supportedOperators, _.Library.String  dataType, _.Library.Integer  storage, _.Library.Boolean  caseSensitive, _.Library.Integer  lovId, _.Library.Boolean  validateLov, _.Library.Boolean  hidden  )

static

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 how values are stored: $$$MDSTNORMAL for cases where you would use a normal index, $$$MDSTBITMAP where you would use a 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 whether a List Of Values is available for this metadata field and whether input values should be verified against this list. See also <method>AddListOfValues</method>.
• If hidden is set to true, the field will by default not appear in metadata field and value lists.

AddListOfValues()

_.Library.Integer AddListOfValues ( _.Library.Integer  domainId, _.Library.String  lovName, _.Library.Boolean  autoExtend  )

static

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.

CreateFilter()

_.iKnow.Filters.Filter CreateFilter ( _.Library.Integer  pDomainId, _.Library.String  pFieldName, _.Library.String  pOperator, _.Library.String  pValue  )

static

Create a <class>iKnow.Filters.Filter</class> instance that filters sources according to

the given criteria, using the filter class compatible with this <class>iKnow.Queries.MetadataI</class> implementation.

For the default MetadataAPI, this is a <class>iKnow.Filters.SimpleMetadataFilter</class> instance.

GetFieldValues()

_.XML.DataSet GetFieldValues ( _.Library.Integer  domainId, _.Library.String  fieldName, _.Library.Integer  page, _.Library.Integer  pageSize  )

static

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

See also <method>GetUniqueValues</method> for a version returning the number of sources with this metadata value and sorting options.

GetFields()

_.XML.DataSet GetFields ( _.Library.Integer  domainId, _.Library.Boolean  includeHidden  )

static

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

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

GetMetaSpreadByEntities()

_.Library.Integer GetMetaSpreadByEntities ( _.Library.Integer  pDomainId, _.Library.String  pFieldName, _.Library.ListOfDataTypes  pEntityList, _.Library.String  pFilter, _.Library.Integer  pSetOp  )

static

Returns the "spread" of metadata values (number of distinct values) for field

pFieldName for the entities in pEntityList, in the sources satisfying pFilter. When specifying multiple entities, sources (and their metadata values) are included based on the value of pSetOp: if pSetOp = $$$UNION, only one entity has to be present (default), if pSetOp = $$$INTERSECT, all of them need to be present.

GetMetaSpreadByEntityIds()

_.Library.Integer GetMetaSpreadByEntityIds ( _.Library.Integer  pDomainId, _.Library.String  pFieldName, _.Library.ListOfDataTypes  pEntityIdList, _.Library.String  pFilter, _.Library.Integer  pSetOp  )

static

Returns the "spread" of metadata values (number of distinct values) for field

pFieldName for the entities in pEntityIdList, in the sources satisfying pFilter. When specifying multiple entities, sources (and their metadata values) are included based on the value of pSetOp: if pSetOp = $$$UNION, only one entity has to be present (default), if pSetOp = $$$INTERSECT, all of them need to be present.

GetUniqueValueCount()

_.Library.Integer GetUniqueValueCount ( _.Library.Integer  pDomainId, _.Library.String  pFieldName, _.Library.String  pFilter  )

static

Returns the number of unique metadata values for a given field pFieldName in

the sources satisfying the supplied filter, after normalization based on the field specifications such as case sensitivity and data type.

GetUniqueValues()

_.XML.DataSet GetUniqueValues ( _.Library.Integer  pDomainId, _.Library.String  pFieldName, _.Library.Integer  pPage, _.Library.Integer  pPageSize, _.Library.String  pFilter, _.Library.String  pSortType  )

static

Returns all the unique metadata values for field pFieldName in sources

satisfying the supplied filter, optionally sorted by value (pSortType = "VALUE") or frequency (pSortType = "FREQUENCY"). The returned frequency represents the number of sources with this metadata value (satisfying the filter).

NOTE: sorting by value is only precise up to the 150 first characters

GetUniqueValuesById()

_.XML.DataSet GetUniqueValuesById ( _.Library.Integer  pDomainId, _.Library.Integer  pFieldId, _.Library.Integer  pPage, _.Library.Integer  pPageSize, _.Library.String  pFilter, _.Library.String  pSortType  )

static

Returns all the unique metadata values for field pFieldId in sources

satisfying the supplied filter, optionally sorted by value (pSortType = "VALUE") or frequency (pSortType = "FREQUENCY"). The returned frequency represents the number of sources with this metadata value (satisfying the filter).

NOTE: sorting by value is only precise up to the 150 first characters

GetValues()

_.XML.DataSet GetValues ( _.Library.Integer  domainId, _.Library.String  externalId, _.Library.Boolean  includeHidden  )

static

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.

GetValuesById()

_.XML.DataSet GetValuesById ( _.Library.Integer  domainId, _.Library.Integer  srcId, _.Library.Boolean  includeHidden  )

static

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.

SetValue()

_.Library.Boolean SetValue ( _.Library.Integer  domainId, _.Library.String  fieldName, _.Library.String  externalId, _.Library.String  value  )

static

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.

SetValueById()

_.Library.Boolean SetValueById ( _.Library.Integer  domainId, _.Library.Integer  fieldId, _.Library.Integer  srcId, _.Library.String  value  )

static

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.

UpdateField()

_.Library.Boolean UpdateField ( _.Library.Integer  domainId, _.Library.String  fieldName, _.Library.ListOfDataTypes  supportedOperators, _.Library.Integer  storage, _.Library.Integer  hidden, _.Library.Integer  lovId, _.Library.Integer  validateLov  )

static

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

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

UpdateFieldById()

_.Library.Boolean UpdateFieldById ( _.Library.Integer  domainId, _.Library.Integer  fieldId, _.Library.ListOfDataTypes  supportedOperators, _.Library.Integer  storage, _.Library.Integer  hidden, _.Library.Integer  lovId, _.Library.Integer  validateLov  )

static

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

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

Member Data Documentation

NAMESPACE

NAMESPACE = None

static

This is an automatically generated class, offering a functionally equivalent set of methods and queries as <class>iKnow.Queries.MetadataAPI</class>, exposed as WebMethod methods.

See the classdocs for <class>iKnow.Queries.MetadataAPI</class> for more information.