javax.xml.registry
Interface BusinessQueryManager

All Superinterfaces:

QueryManager

public interface BusinessQueryManager

extends QueryManager

This is the interface exposed by the Registry Service that implements the business style query interface. It is also referred to as the focused query interface.

Many of the methods in this interface take similar arguments. These arguments are defined here in details once and subsequently referred to in the method documentation:

findQualifiers - Is a Collection of find qualifiers as defined by the FindQualifier interface. It specifies qualifiers that effect string matching, sorting, and boolean predicate logic etc.

namePatterns - Is a Collection of Strings. Each String is a partial or full name pattern with wildcard searching as specified by the SQL-92 LIKE specification. Unless otherwise specified in findQualifiers, this is a Logical OR and a match on any name qualifies as a match for this criteria.

classifications - Is a Collection of Classifications that classify the object. This is analogous to catgegoryBag in UDDI. Unless otherwise specified in findQualifiers, this is a Logical AND and match on ALL specified Classifications qualifies as a match for this criteria.

specifications - Is a Collection of RegistryObjects that represent (proxy) a tecnical specification. This is analogous to tModelBag in UDDI. Unless otherwise specified in findQualifiers, this is a Logical AND and match on ALL specified Specifications qualifies as a match for this criteria.

externalIdentifiers - Is a Collection of ExternalIdentifiers that provide an external identifier for the object using an identification scheme such as DUNS. This is analogous to identifierBag in UDDI. Unless otherwise specified in findQualifiers, this is a Logical AND and match on ALL specified Classifications qualifies as a match for this criteria.

externalLinks - Is a Collection of ExternalLinks that link the object to content outside the registry. This is analogous to overviewDoc in UDDI. Unless otherwise specified in findQualifiers, this is a Logical AND and match on ALL specified ExternalLinks qualifies as a match for this criteria.

BulkResponse - Contains Collection of objects returned by the find method.

See Also:

DeclarativeQueryManager, FindQualifier, BulkResponse

Method Summary

BulkResponse	findAssociations(java.util.Collection findQualifiers, java.util.Collection associationTypes, boolean sourceObjectConfirmed, boolean targetObjectConfirmed) Finds all Associations that match ALL of the criteria specified by the parameters of this call.
ClassificationScheme	findClassificationSchemeByName(java.lang.String namePattern) Find a ClassificationScheme by name based on the specified name pattern.
BulkResponse	findClassificationSchemes(java.util.Collection findQualifiers, java.util.Collection namePatterns, java.util.Collection classifications, java.util.Collection externalLinks) Finds all ClassificationSchemes that match ALL of the criteria specified by the parameters of this call.
Concept	findConceptByPath(java.lang.String path) Find a Concept based on the path specified.
BulkResponse	findConcepts(java.util.Collection findQualifiers, java.util.Collection namePatterns, java.util.Collection classifications, java.util.Collection externalIdentifiers, java.util.Collection externalLinks) Finds all Concepts that match ALL of the criteria specified by the parameters of this call.
BulkResponse	findOrganizations(java.util.Collection findQualifiers, java.util.Collection namePatterns, java.util.Collection classifications, java.util.Collection specifications, java.util.Collection externalIdentifiers, java.util.Collection externalLinks) Finds all Organizations that match ALL of the criteria specified by the parameters of this call.
BulkResponse	findRegistryPackages(java.util.Collection findQualifiers, java.util.Collection namePatterns, java.util.Collection classifications, java.util.Collection externalLinks) Finds all RegistryPackages that match ALL of the criteria specified by the parameters of this call.
BulkResponse	findServiceBindings(Key serviceKey, java.util.Collection findQualifiers, java.util.Collection classifications, java.util.Collection specifications) Finds all ServiceBindings that match ALL of the criteria specified by the parameters of this call.
BulkResponse	findServices(Key orgKey, java.util.Collection findQualifiers, java.util.Collection namePatterns, java.util.Collection classifications, java.util.Collection specifications) Finds all Services that match ALL of the criteria specified by the parameters of this call.

Methods inherited from interface javax.xml.registry.QueryManager

getCataloguedObject, getCataloguedObjects, getRegistryObject, getRegistryObjects, getRegistryObjects, getRegistryObjects

Method Detail

findAssociations

public BulkResponse findAssociations(java.util.Collection findQualifiers,
                                     java.util.Collection associationTypes,
                                     boolean sourceObjectConfirmed,
                                     boolean targetObjectConfirmed)
                              throws JAXRException

Finds all Associations that match ALL of the criteria specified by the parameters of this call. This is a Logical AND operation between all non-null parameters.

Capability Level: 0

Parameters:

associationTypes - Is a Collection of associationsType. This is a logical OR operation across the collection. This parameter is ignored if specified as null.

sourceObjectConfirmed - If true, provider must include Associations owned by caller that have their sourceObject confirmed. If false, provider must include Associations owned by caller that have their sourceObject not confirmed.

targetObjectConfirmed - If true, provider must include Associations owned by caller that have their targetObject confirmed. If false, provider must include Associations owned by caller that have their targetObject not confirmed.

Returns:

BulkResponse containing Collection of Associations

findOrganizations

public BulkResponse findOrganizations(java.util.Collection findQualifiers,
                                      java.util.Collection namePatterns,
                                      java.util.Collection classifications,
                                      java.util.Collection specifications,
                                      java.util.Collection externalIdentifiers,
                                      java.util.Collection externalLinks)
                               throws JAXRException

Finds all Organizations that match ALL of the criteria specified by the parameters of this call. This is a Logical AND operation between all non-null parameters.

Capability Level: 0

Returns:

BulkResponse containing Collection of Organizations

findServices

public BulkResponse findServices(Key orgKey,
                                 java.util.Collection findQualifiers,
                                 java.util.Collection namePatterns,
                                 java.util.Collection classifications,
                                 java.util.Collection specifications)
                          throws JAXRException

Finds all Services that match ALL of the criteria specified by the parameters of this call. This is a Logical AND operation between all non-null parameters.

Capability Level: 0

Parameters:

orgKey - Key identifying an Organization. Required for UDDI providers.

findServiceBindings

public BulkResponse findServiceBindings(Key serviceKey,
                                        java.util.Collection findQualifiers,
                                        java.util.Collection classifications,
                                        java.util.Collection specifications)
                                 throws JAXRException

Finds all ServiceBindings that match ALL of the criteria specified by the parameters of this call. This is a Logical AND operation between all non-null parameters.

Capability Level: 0

Parameters:

serviceKey - Key identifying a Service. Required for UDDI providers.

Returns:

BulkResponse containing Collection of ServiceBindings

findClassificationSchemes

public BulkResponse findClassificationSchemes(java.util.Collection findQualifiers,
                                              java.util.Collection namePatterns,
                                              java.util.Collection classifications,
                                              java.util.Collection externalLinks)
                                       throws JAXRException

Finds all ClassificationSchemes that match ALL of the criteria specified by the parameters of this call. This is a Logical AND operation between all non-null parameters.

Capability Level: 0

Returns:

BulkResponse containing Collection of ClassificationSchemes

findClassificationSchemeByName

public ClassificationScheme findClassificationSchemeByName(java.lang.String namePattern)
                                                    throws JAXRException

Find a ClassificationScheme by name based on the specified name pattern.

Capability Level: 0

Parameters:

namePattern - Is a String that is a partial or full name pattern with wildcard searching as specified by the SQL-92 LIKE specification.

Returns:

The ClassificationScheme matching the namePattern. If none match return null. If multiple match then throw an InvalidRequestException.

findConcepts

public BulkResponse findConcepts(java.util.Collection findQualifiers,
                                 java.util.Collection namePatterns,
                                 java.util.Collection classifications,
                                 java.util.Collection externalIdentifiers,
                                 java.util.Collection externalLinks)
                          throws JAXRException

Finds all Concepts that match ALL of the criteria specified by the parameters of this call. This is a Logical AND operation between all non-null parameters.

Capability Level: 0

Parameters:

findQualifier - specifies qualifiers that effect string matching, sorting etc.

Returns:

BulkResponse containing Collection of Concepts

findConceptByPath

public Concept findConceptByPath(java.lang.String path)
                          throws JAXRException

Find a Concept based on the path specified. If specified path matches more than one ClassificationScheme then the one that is most general (higher in the concept hierarchy) is returned.

Capability Level: 0

Parameters:

path - Is an XPATH expression that identifies the Concept.

findRegistryPackages

public BulkResponse findRegistryPackages(java.util.Collection findQualifiers,
                                         java.util.Collection namePatterns,
                                         java.util.Collection classifications,
                                         java.util.Collection externalLinks)
                                  throws JAXRException

Finds all RegistryPackages that match ALL of the criteria specified by the parameters of this call. This is a Logical AND operation between all non-null parameters.

Capability Level: 1

Parameters:

findQualifier - specifies qualifiers that effect string matching, sorting etc.

Returns:

BulkResponse containing Collection of RegistryPackages