Each of the APIs (find_business, find_service, find_binding, find_tModel
and find_relatedBusinesses) accepts an optional findQualifiers argument, which
can contain multiple findQualifier values.
The following list contains the findQualifier short names, a brief
description, and the appropriate find function. The arguments available are:
- andAllKeys
- This changes the behavior for identifyerBag to AND keys rather than OR
them. This is the default for categoryBag and tModelbag. Applicable
to find_business, find_service, find_binding and find_tModel (but not for
find_relatedBusinesses).
- approximateMatch
- Signifies that wildcard search behavior is desired. This is no longer
the default behavior (see 'exactMatch'). This applies to find_business, find_service,
find_binding, find_tModel and find_relatedBusiness.
- binarySort
- Allows for greater speed in sorting. It causes a binary sort by name,
as represented in Unicode codepoints. It is applicable to find_business, find_service
and find_tModel only.
- bindingSubset
- This is used only in conjunction with a categoryBag argument in the find_business
or find_services APIs.
- caseInsensitiveMatch
- Signifies that the matching behavior for name, keyValue and keyName (where
applicable) should be performed without regard to case. It is applicable to
find_business, find_service and find_tModel.
- caseInsensitiveSort
- Signifies that the matching behavior for name, keyValue and keyName (where
applicable) should be performed without regard to case. This overrides the
default case sensitive sorting behavior.
- caseSensitiveMatch
- Signifies that the matching behavior for name, keyValue and keyName (where
applicable) should be performed with regard to case. This is the default behavior.
It is applicable to find_business, find_service, find_binding, find_tModel
and find_relatedBusinesses.
- caseSensitiveSort
- Signifies that the result set should be sorted with regard to case. this
is the default behavior. It is applicable to find_business, find_service
and find_tModel.
- combineCategoryBags
- This may only be used in the find_business and find_service calls.
- In the case of find_business, this 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.
- In the case of find_service, this 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.
- diacriticInsensitiveMatch
- Signifies that matching behavior for name, keyValue and keyName (where
applicable) should be performed without regard to diacritics. Support for
this findQualifier is optional. It applies to find_business, find_service,
find_binding, find_tModel and find_relatedBusinesses.
- diacriticSensitiveMatch
- Signifies that the matching behavior for name, keyValue and keyName (where
applicable) should be performed with regard to diacritics. This is the default behavior.
It applies to find_business, find_service, find_binding, find_tModel and find_relatedBusinesses.
- exactMatch
- Signifies that only entries with names, keyValues and keyNames (where
applicable) that exactly match the name argument passed in, after normalization,
will be returned. It is sensitive to case and diacritics where applicable
and is the default behavior. It applies to find_business, find_service,
find_binding, find_tModel and find_relatedBusinesses.
- signaturePresent
- This is used with any find 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. It applies to find_business, find_service, find_binding,
find_tModel and find_relatedBusinesses.
- orAllKeys
- This changes the behavior for tModelBag and categoryBag to OR the keys
within a bag, rather than to AND them. It is not possible to OR the categories
and retain the default AND behavior of the tModels. For the find_business
qualifier this is the default behavior for identifierBag, and it is
applicable to find_service, find_binding (for categoryBag and tModelbag) and
find_tModel where it is the default behavior for identifierBag and
applicable to categoryBag.
- orLikeKeys
- Used when a bag container (that is a categoryBag or identifierBag) contains
multiple keyedReference elements. In this situation any keyedReference filters
that come from the same namespace (have the same tModelKey value) are OR'd
together rather than AND'd. It is applicable to find_business, find_service,
find_binding and find_tModel.
- serviceSubset
- This is only used with the find_business API and used only in conjunction
with the 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.
- sortByNameAsc
- This causes the result set returned by a find or get inquiry API to be
sorted on the name field in ascending order. It is applicable to find_business,
find_service, find_tModel and find_relatedBusinesses. 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.
- sortByNameDesc
- This causes the result set returned by a find or get inquiry API to be
sorted on the name field in descending order. It is applicable to find_business,
find_service, find_tModel and find_relatedBusinesses. 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.
- sortByDateAsc
- This causes the result set returned by a find or get inquiry to be sorted
based on the most recent date when each entity, or any entities they contain,
were last updated, in ascending chronological order (the oldest is returned
first). When used in conjunction with names in the result set returned, the
date-based sort is secondary to the name-based sort (that is, the results
are sorted within name by date, oldest to newest). This is the default behavior
for find_binding and is applicable for find_business, find_service, find_tModel
and find_relatedBusinesses.
- sortByDateDesc
- This causes the result set returned by a find or get inquiry to be sorted
based on the most recent date when each entity, or any entities they contain,
were last updated, in descending chronological order (the most recently changed
are returned first). When used in conjunction with names in the result set
returned, the date-based sort is secondary to the name-based sort (that is,
the results are sorted within name by date, newest to oldest). This is applicable
for find_business, find_service, find_binding, find_tModel and find_relatedBusinesses.
- suppressProjectedServices
- 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.
For further details on the findQualifiers refer to the UDDI Version 3 Specification documentation.