Search Metadata XML

From VYRE

Jump to: navigation, search

Abstract

Search metadata is the XML block provided in search result XML block.

Element list

XPath Notes Presence
/search-metadata Root node Always
/search-metadata/source-page Points to the page containing search criteria (may or might not be the same page as search result) Always
/search-metadata/source-page@id Page id Always
/search-metadata/default-input Refers to the contents of "default search input" criteria If exposed & specified
/search-metadata/name Metadata name criteria If exposed & specified
/search-metadata/description Metadata description criteria If exposed & specified
/search-metadata/keywords Metadata keywords criteria If exposed & specified
/search-metadata/creation-date-from Item creation date - opening range criteria (for ranged queries only) If exposed & specified
/search-metadata/creation-date-from-pattern Item creation date - opening range criteria format (for ranged queries only). Possible values: "dd.MM.yyyy" (date only) or "dd.MM.yyyy HH:mm" (date & time) If exposed & specified
/search-metadata/creation-date-to Item creation date - closing range criteria (for ranged queries only) If exposed & specified
/search-metadata/creation-date-to-pattern Item creation date - closing range criteria format (for ranged queries only). Possible values: "dd.MM.yyyy" (date only) or "dd.MM.yyyy HH:mm" (date & time) If exposed & specified
/search-metadata/modification-date-from Item modification date - opening range criteria (for ranged queries only) If exposed & specified
/search-metadata/modification-date-from-pattern Item modification date - opening range criteria format (for ranged queries only). Possible values: "dd.MM.yyyy" (date only) or "dd.MM.yyyy HH:mm" (date & time) If exposed & specified
/search-metadata/modification-date-to Item modification date - closing range criteria (for ranged queries only) If exposed & specified
/search-metadata/modification-date-to-pattern Item modification date - closing range criteria format (for ranged queries only). Possible values: "dd.MM.yyyy" (date only) or "dd.MM.yyyy HH:mm" (date & time) If exposed & specified
/search-metadata/selected-categories Contains a list of categories the user specified as the search criteria If exposed & specified
/search-metadata/selected-categories/category For each category which has been selected to search against If exposed & specified
/search-metadata/selected-categories/category@id For each category which has been selected to search against, refers to category id If exposed & specified
/search-metadata/selected-categories/category/linked-via For each category which has been selected to search against AND was referred via linkPath (see vyre-search:taxonomy linkPath tag attribute description for more details. This element may be nested if linking is more than one level deep If exposed & specified
/search-metadata/selected-categories/category/linked-via@definition-id Refers to the link definition of the above xml element If exposed & specified
/search-metadata/preselected-categories Refers to pre-selected categories (only available in the old search results portlet). Is bound to exactly the same semantics as /search-metadata/selected-categories (including sub-elements, attributes, etc.). See above for more details. If exposed & specified
/search-metadata/locales Search locales If exposed & specified
/search-metadata/locales/locale For each search locale If exposed & specified
/search-metadata/locales/locale@id Prints locale id for each locale (format: country_lang_variant, e.g. "en", "de_DE", "GB", "en_US_WIN", "dePOSIX", "fr_MAC", etc. If exposed & specified
/search-metadata/attributes Refers to attributes used to search against If at least one attribute exposed & specified
/search-metadata/attributes/attribute For each attribute used in the search If attribute exposed & specified
/search-metadata/attributes/attribute@id Attribute id If attribute exposed & specified
/search-metadata/attributes/attribute@xml-name Attribute XML name If attribute exposed, specified and is not a default attribute (name, description, keywords, creationDate, lastModifiedDate, creator, lastModifier)
/search-metadata/attributes/attribute/[linked-via] If searching for attribute of the linked store. Can be nested If searching for attribute of the linked store
/search-metadata/attributes/attribute/[linked-via]@definition-id Link definition id of the above If searching for attribute of the linked store
/search-metadata/attributes/attribute/[linked-via]/single-query For non-ranged queries, contains the query criteria If attribute exposed & specified
/search-metadata/attributes/attribute/[linked-via]/range-query For ranged queries If attribute exposed & specified
/search-metadata/attributes/attribute/[linked-via]/range-query/from For ranged queries - left boundary (if present) If attribute exposed & specified
/search-metadata/attributes/attribute/[linked-via]/range-query For ranged queries - right boundary (if present) If attribute exposed & specified
/search-metadata/item-links If searching against linked item(s) If searching against linked item(s)
/search-metadata/item-links/item-link For each item link If searching against linked item(s)
/search-metadata/item-links/item-link@definition-id Link definition id of the above link If searching against linked item(s)
/search-metadata/item-links/item-link/item For each linked item the search is executed against If searching against linked item(s)
/search-metadata/item-links/item-link/item@id Item id of the above If searching against linked item(s)
/search-metadata/user-links If searching against linked user(s) If searching against linked user(s)
/search-metadata/user-links/user-link For each user link If searching against linked user(s)
/search-metadata/user-links/user-link@definition-id Item - user link definition id of the above link If searching against linked user(s)
/search-metadata/user-links/user-link/profile For each profile searching against If searching against linked user(s)
/search-metadata/user-links/user-link/profile@id Profile id of the above If searching against linked user(s)
Personal tools