com.centrasite.uddiv3.client.util
Interface FindQualifier


public interface FindQualifier

Constants for the predefined findQualifiers


Field Summary
static java.lang.String AND_ALL_KEYS
          This changes the behavior for identifierBag to AND keys rather than OR them.
static java.lang.String APPROXIMATE_MATCH
          Signifies that wildcard search behavior is desired.
static java.lang.String BINARY_SORT
          This qualifier allows for greater speed in sorting.
static java.lang.String BINDING_SUBSET
          This is used in the find_business API or the find_service API and is used only in conjunction with a categoryBag argument.
static java.lang.String CASE_INSENSITIVE_MATCH
          Signifies that the matching behavior for name, keyValue and keyName (where applicable) should be performed without regard to case.
static java.lang.String CASE_INSENSITIVE_SORT
          Signifies that the result set should be sorted without regard to case.
static java.lang.String CASE_SENSITIVE_MATCH
          Signifies that the matching behavior for name, keyValue and keyName (where applicable) should be performed with regard to case.
static java.lang.String CASE_SENSITIVE_SORT
          Signifies that the result set should be sorted with regard to case.
static java.lang.String COMBINE_CATEGORY_BAGS
          This may only be used in the find_business and find_service calls.
static java.lang.String DIACRITIC_INSENSITIVE_MATCH
          Signifies that matching behavior for name, keyValue and keyName (where applicable) should be performed without regard to diacritics.
static java.lang.String DIACRITIC_SENSITIVE_MATCH
          Signifies that the matching behavior for name, keyValue and keyName (where applicable) should be performed with regard to diacritics.
static java.lang.String EXACT_MATCH
          Signifies that only entries with names, keyValues and keyNames (where applicable) that exactly match the name argument passed in, after normalization, will be returned.
static java.lang.String OR_ALL_KEYS
          This changes the behavior for tModelBag and categoryBag to OR the keys within a bag, rather than to AND them.
static java.lang.String OR_LIKE_KEYS
          When a bag container (i.e. categoryBag or identifierBag) contains multiple keyedReference elements, any keyedReference filters that come from the same namespace (e.g. have the same tModelKey value) are OR'd together rather than AND'd.
static java.lang.String SERVICE_SUBSET
          This is used only with the find_business API and is used only in conjunction with a categoryBag argument.
static java.lang.String SIGNATURE_PRESENT
          This is used with any find_xx API to restrict the result set to entities which either contain an XML Digital Signature element, or are contained in an entity which contains one.
static java.lang.String SORT_BY_DATE_ASC
          Causes the result set returned by a find_xx or get_xx inquiry call to be sorted based on the most recent date when each entity, or any entities they contain, were last updated, in ascending chronological order (oldest are returned first).
static java.lang.String SORT_BY_DATE_DESC
          Causes the result set returned by a find_xx or get_xx inquiry call to be sorted based on the most recent date when each entity, or any entities they contain, were last updated, in descending chronological order (most recently changed are returned first.
static java.lang.String SORT_BY_NAME_ASC
          Causes the result set returned by a find_xx or get_xx inquiry APIs to be sorted on the name field in ascending order.
static java.lang.String SORT_BY_NAME_DESC
          Causes the result set returned by a find_xx or get_xx inquiry call to be sorted on the name field in descending order.
static java.lang.String SUPPRESS_PROJECTED_SERVICE
          Signifies that service projections MUST NOT be returned by the find_service or find_business APIs with which this findQualifier is associated.
static java.lang.String UTS10
          This is used to cause sorting of results based on the Unicode Collation Algorithm on elements normalized according to Unicode Normalization Form C.
 

Field Detail

AND_ALL_KEYS

static final java.lang.String AND_ALL_KEYS
This changes the behavior for identifierBag to AND keys rather than OR them. This is already the default for categoryBag and tModelBag.

See Also:
Constant Field Values

APPROXIMATE_MATCH

static final java.lang.String APPROXIMATE_MATCH
Signifies that wildcard search behavior is desired. This behavior is defined by the uddi-org:approximatematch:SQL99 tModel and means approximate matching as defined for the character like predicate in ISO/IEC9075-2:1999(E) where the percent sign (%) indicates any number of characters and an underscore (_) indicates any single character. The backslash character (\) is used as an escape character for the percent sign, underscore and backslash characters. This find qualifier adjusts the matching behavior for name, keyValue and keyName (where applicable).

See Also:
Constant Field Values

BINARY_SORT

static final java.lang.String BINARY_SORT
This qualifier allows for greater speed in sorting. It causes a binary sort by name, as represented in Unicode codepoints.

See Also:
Constant Field Values

BINDING_SUBSET

static final java.lang.String BINDING_SUBSET
This is used in the find_business API or the find_service API and is used only in conjunction with a categoryBag argument. It causes the component of the search that involves categorization to use only the categoryBag elements from contained bindingTemplate elements within the registered data and ignores any entries found in the categoryBag which are not direct descendent elements of registered businessEntity elements or businessService elements. The resulting businessList or serviceList return those businesses or services that matched based on this modified behavior, in conjunction with any other search arguments provided. Additionally, in the case of the returned businessList from a find_business, the contained serviceInfos elements will only reflect summary data (in a serviceInfo element) for those services (contained or referenced) that contained a binding that matched on one of the supplied categoryBag arguments.

See Also:
Constant Field Values

CASE_INSENSITIVE_MATCH

static final java.lang.String CASE_INSENSITIVE_MATCH
Signifies that the matching behavior for name, keyValue and keyName (where applicable) should be performed without regard to case.

See Also:
Constant Field Values

CASE_INSENSITIVE_SORT

static final java.lang.String CASE_INSENSITIVE_SORT
Signifies that the result set should be sorted without regard to case. This overrides the default case sensitive sorting behavior.

See Also:
Constant Field Values

CASE_SENSITIVE_MATCH

static final java.lang.String CASE_SENSITIVE_MATCH
Signifies that the matching behavior for name, keyValue and keyName (where applicable) should be performed with regard to case. This is the default behavior.

See Also:
Constant Field Values

CASE_SENSITIVE_SORT

static final java.lang.String CASE_SENSITIVE_SORT
Signifies that the result set should be sorted with regard to case. This is the default behavior.

See Also:
Constant Field Values

COMBINE_CATEGORY_BAGS

static final java.lang.String COMBINE_CATEGORY_BAGS
This may only be used in the find_business and find_service calls. In the case of find_business, this qualifier makes the categoryBag entries for the full businessEntity element behave as though all categoryBag elements found at the businessEntity level and in all contained or referenced businessService elements and bindingTemplate elements were combined. Searching for a category will yield a positive match on a registered business if any of the categoryBag elements contained within the full businessEntity element (including the categoryBag elements within contained or referenced businessService elements or bindingTemplate elements) contains the filter criteria. In the case of find_service, this qualifier makes the categoryBag entries for the full businessService element behave as though all categoryBag elements found at the businessService level and in all contained or referenced elements in the bindingTemplate elements were combined. Searching for a category will yield a positive match on a registered service if any of the categoryBag elements contained within the full businessService element (including the categoryBag elements within contained or referenced bindingTemplate elements) contains the filter criteria. This find qualifier does not cause the keyedReferences in categoryBags to be combined with the keyedReferences in keyedReferenceGroups in categoryBags when performing the comparison. The keyedReferences are combined with each other, and the keyedReferenceGroups are combined with each other.

See Also:
Constant Field Values

DIACRITIC_INSENSITIVE_MATCH

static final java.lang.String DIACRITIC_INSENSITIVE_MATCH
Signifies that matching behavior for name, keyValue and keyName (where applicable) should be performed without regard to diacritics. Support for this findQualifier by nodes is OPTIONAL. CentraSite does not support this findQualifier

See Also:
Constant Field Values

DIACRITIC_SENSITIVE_MATCH

static final java.lang.String DIACRITIC_SENSITIVE_MATCH
Signifies that the matching behavior for name, keyValue and keyName (where applicable) should be performed with regard to diacritics. This is the default behavior. CentraSite does not support this findQualifier

See Also:
Constant Field Values

EXACT_MATCH

static final java.lang.String EXACT_MATCH
Signifies that only entries with names, keyValues and keyNames (where applicable) that exactly match the name argument passed in, after normalization, will be returned. This qualifier is sensitive to case and diacritics where applicable. This qualifier represents the default behavior.

See Also:
Constant Field Values

OR_ALL_KEYS

static final java.lang.String OR_ALL_KEYS
This changes the behavior for tModelBag and categoryBag to OR the keys within a bag, rather than to AND them. Using this findQualifier with both a categoryBag and a tModelBag, will cause all of the keys in BOTH the categoryBag and the tModelBag to be OR'd together rather than AND'd. It is not possible to OR the categories and retain the default AND behavior of the tModels. The behavior of keyedReferenceGroups in a categoryBag is analogous to that of individual keyedReferences, that is, the complete categoryBag is changed to OR the keys.

See Also:
Constant Field Values

OR_LIKE_KEYS

static final java.lang.String OR_LIKE_KEYS
When a bag container (i.e. categoryBag or identifierBag) contains multiple keyedReference elements, any keyedReference filters that come from the same namespace (e.g. have the same tModelKey value) are OR'd together rather than AND'd. For example "find any of these four values from this namespace, and any of these two values from this namespace". The behavior of keyedReferenceGroups is analogous to that of keyedReferences, that is, keyedReferenceGroups that have the same tModelKey value are OR'd together rather than AND'd.

See Also:
Constant Field Values

SERVICE_SUBSET

static final java.lang.String SERVICE_SUBSET
This is used only with the find_business API and is used only in conjunction with a categoryBag argument. It causes the component of the search that involves categorization to use only the categoryBag elements from contained or referenced businessService elements within the registered data and ignores any entries found in the categoryBag which are not direct descendent elements of registered businessEntity elements. The resulting businessList structure contains those businesses that matched based on this modified behavior, in conjunction with any other search arguments provided. Additionally, the contained serviceInfos elements will only reflect summary data (in a serviceInfo element) for those services (contained or referenced) that matched on one of the supplied categoryBag arguments.

See Also:
Constant Field Values

SIGNATURE_PRESENT

static final java.lang.String SIGNATURE_PRESENT
This is used with any find_xx API to restrict the result set to entities which either contain an XML Digital Signature element, or are contained in an entity which contains one. The Signature element is retrieved using a get_xx API call and SHOULD be verified by the client. A UDDI node may or may not verify the signature and therefore use of this find qualifier, or the presence of a Signature element SHOULD only be for the refinement of the result set from the find_xx API and SHOULD not be used as a verification mechanism by UDDI clients.

See Also:
Constant Field Values

SORT_BY_NAME_ASC

static final java.lang.String SORT_BY_NAME_ASC
Causes the result set returned by a find_xx or get_xx inquiry APIs to be sorted on the name field in ascending order. This sort is applied prior to any truncation of result sets. It is only applicable to queries that return a name element in the top-most detail level of the result set and if no conflicting sort qualifier is specified, this is the default sorting direction. This findQualifier takes precedence over sortByDateAsc and sortByDateDesc qualifiers, but if a sortByDateXxx findQualifier is used without a sortByNameXxx qualifier, sorting is performed based on date with or without regard to name.

See Also:
Constant Field Values

SORT_BY_NAME_DESC

static final java.lang.String SORT_BY_NAME_DESC
Causes the result set returned by a find_xx or get_xx inquiry call to be sorted on the name field in descending order. This sort is applied prior to any truncation of result sets. It is only applicable to queries that return a name element in the top-most detail level of the result set. This is the reverse of the default sorting direction. This findQualifier takes precedence over sortByDateAsc and sortByDateDesc qualifiers but if a sortByDateXxx findQualifier is used without a sortByNameXxx qualifier, sorting is performed based on date with or without regard to name.

See Also:
Constant Field Values

SORT_BY_DATE_ASC

static final java.lang.String SORT_BY_DATE_ASC
Causes the result set returned by a find_xx or get_xx inquiry call to be sorted based on the most recent date when each entity, or any entities they contain, were last updated, in ascending chronological order (oldest are returned first). When names are included in the result set returned, this find qualifier may also be used in conjunction with either the sortByNameAsc or sortByNameDesc findQualifiers. When so combined, the date-based sort is secondary to the name-based sort (results are sorted within name by date, oldest to newest).

See Also:
Constant Field Values

SORT_BY_DATE_DESC

static final java.lang.String SORT_BY_DATE_DESC
Causes the result set returned by a find_xx or get_xx inquiry call to be sorted based on the most recent date when each entity, or any entities they contain, were last updated, in descending chronological order (most recently changed are returned first. When names are included in the result set returned, this find qualifier may also be used in conjunction with either the sortByNameAsc or sortByNameDesc find qualifiers. When so combined, the date-based sort is secondary to the name-based sort (results are sorted within name by date,newest to oldest).

See Also:
Constant Field Values

SUPPRESS_PROJECTED_SERVICE

static final java.lang.String SUPPRESS_PROJECTED_SERVICE
Signifies that service projections MUST NOT be returned by the find_service or find_business APIs with which this findQualifier is associated. This findQualifier is automatically enabled by default whenever find_service is used without a businessKey.

See Also:
Constant Field Values

UTS10

static final java.lang.String UTS10
This is used to cause sorting of results based on the Unicode Collation Algorithm on elements normalized according to Unicode Normalization Form C. When this qualifier is referenced, a sort is performed according to the Unicode Collation Element Table in conjunction with the Unicode Collation Algorithm on the name field, normalized using Unicode Normalization Form C. Support of this findQualifier by nodes is OPTIONAL. CenrtaSite does not support this findQualifier.

See Also:
Constant Field Values