FindBusiness (jUDDI_v3 Parent 3.3.10 API)

java.lang.Object
- org.uddi.api_v3.FindBusiness

All Implemented Interfaces:

Serializable
```
public class FindBusiness
extends Object
implements Serializable
```
· authInfo: This optional argument is an element that contains an authentication token. Registries that wish to restrict who can perform an inquiry in them typically require authInfo for this call.

· categoryBag: This is a list of category references in the form of keyedReference elements and keyedReferenceGroup structures. The returned businessList contains businessInfo elements matching all of the categories passed (logical AND by default). Specifying the appropriate findQualifiers can override this behavior. Matching rules for each can be found in Section 5.1.7 Matching Rules for keyedReferences and keyedReferenceGroups.

· discoveryURLs: This is a list of discoveryURL structures to be matched against the discoveryURL data associated with registered businessEntity information. To search for URL without regard to useType attribute values, omit the useType attribute or pass it as an empty attribute. If useType values are included, the match occurs only on registered information that matches both the useType and URL value. The returned businessList contains businessInfo structures matching any of the URL's passed (logical OR).

· identifierBag: This is a list of business identifier references in the form of keyedReference elements. The returned businessList contains businessInfo structures matching any of the identifiers passed (logical OR by default). Specifying the appropriate findQualifiers can override this behavior. Matching rules can be found in Section 5.1.7 Matching Rules for keyedReferences and keyedReferenceGroups.

· findQualifiers: This collection of findQualifier elements can be used to alter the default behavior of search functionality. See the Section 5.1.4 Find Qualifiers, for more information.

· find_relatedBusinesses: This argument is an embedded inquiry and limits the search results to those businesses that are related to a specified business in a specified way. The result is comprised of an intersection of the businesses located with this embedded inquiry and the businesses discovered using the remaining inquiry criteria. The standard syntax and arguments for find_relatedBusinesses apply here. Note that the authInfo argument to this embedded find_relatedBusinesses argument is always ignored. Large result set behavior involving the return of a listDescription does not apply within an embedded argument. If the intermediate result set produced is too large, then the overall query will return E_resultSetTooLarge with an indication that the embedded query returned too many results. If an E_unsupported error occurs as part of processing this embedded argument, it is propagated up to the containing (calling) API. See Section 5.1.11 find_relatedBusinesses, for further information.

· find_tModel: This argument provides an alternative or additional way of specifying tModelKeys that are used to find businesses which have service bindings with specific technical fingerprints as described above for the tModelBag element. When specified, the find_tModel argument is treated as an embedded inquiry that is performed prior to searching for businesses. The tModelKeys found are those whose tModels match the criteria contained within the find_tModel element. The tModelKeys found are added to the (possibly empty) collection specified by the tModelBag prior to finding qualified businesses. Note that the authInfo argument to this embedded find_tModel argument is always ignored. Large result set behavior involving the return of a listDescription does not apply within an embedded argument. If the intermediate result set produced is too large, then the overall query will return E_resultSetTooLarge with an indication that the embedded query returned too many results. If an E_unsupported error occurs as part of processing this embedded argument, it is propagated up to the containing (calling) API.

· listHead: This optional integer value is used to indicate which item SHOULD be returned as the head of the list. The client may request a subset of the matching data by indicating which item in the resultant set constitutes the beginning of the returned data. The use of the listDescription element is mutually exclusive to the use of the truncated attribute that simply indicates a truncated result list in the Inquiry APIs. See Section 5.1.5 Use of listDescription, for a detailed description of the listHead argument.

· maxRows: This optional integer value allows the requesting program to limit the number of results returned. This argument can be used in conjunction with the listHead argument.

· name: This optional collection of string values represents one or more names potentially qualified with xml:lang attributes. Since "exactMatch" is the default behavior, the value supplied for the name argument must be an exact match. If the "approximateMatch" findQualifier is used together with an appropriate wildcard character in the name, then any businessEntity matching this name with wildcards and the other criteria will be referenced in the results. For more on wildcard matching, see Section 5.1.6 About Wildcards. The businessList returned contains businessInfo structures for businesses whose name matches the value(s) passed (lexical-order match – i.e., leftmost in left-to-right languages). If multiple name values are passed, the match occurs on a logical OR basis. Each name MAY be marked with an xml:lang adornment. If a language markup is specified, the search results report a match only on those entries that match both the name value and language criteria. The match on language is a leftmost case-insensitive comparison of the characters supplied. This allows one to find all businesses whose name begins with an "A" and are expressed in any dialect of French, for example. Values which can be passed in the language criteria adornment MUST obey the rules governing the xml:lang data type as defined in Section 3.3.2.3 name.

· tModelBag: Every Web service instance exposed by a registered businessEntity is represented in UDDI by a bindingTemplate contained within the businessEntity. Each bindingTemplate contains a collection of tModel references called its "technical fingerprint" that specifies its type. The tModelBag argument is a collection of tModelKey elements specifying that the search results are to be limited to businesses that expose Web services with technical fingerprints that match.

If a find_tModel argument is specified (see above), it is treated as an embedded inquiry. The tModelKeys returned as a result of this embedded find_tModel argument are used as if they had been supplied in a tModelBag argument. Changing the order of the keys in the collection or specifying the same tModelKey more than once does not change the behavior of the find. * By default, only bindingTemplates that contain all of the tModelKeys in the technical fingerprint match (logical AND). Specifying appropriate findQualifiers can override this behavior so that bindingTemplates containing any of the specified tModelKeys match (logical OR).

Java class for find_business complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="find_business">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element ref="{urn:uddi-org:api_v3}authInfo" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}findQualifiers" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}name" maxOccurs="unbounded" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}identifierBag" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}categoryBag" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}tModelBag" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}find_tModel" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}discoveryURLs" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}find_relatedBusinesses" minOccurs="0"/>
       </sequence>
       <attribute name="maxRows" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="listHead" type="{http://www.w3.org/2001/XMLSchema}int" />
     </restriction>
   </complexContent>
 </complexType>
 
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`authInfo`
`protected CategoryBag`	`categoryBag`
`protected DiscoveryURLs`	`discoveryURLs`
`protected FindQualifiers`	`findQualifiers`
`protected FindRelatedBusinesses`	`findRelatedBusinesses`
`protected FindTModel`	`findTModel`
`protected IdentifierBag`	`identifierBag`
`protected Integer`	`listHead`
`protected Integer`	`maxRows`
`protected List<Name>`	`name`
`protected TModelBag`	`tModelBag`

Constructor Summary

Constructors
Constructor and Description

FindBusiness()

Constructors
Constructor and Description
`FindBusiness()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAuthInfo()` Gets the value of the authInfo property.
`CategoryBag`	`getCategoryBag()` Gets the value of the categoryBag property.
`DiscoveryURLs`	`getDiscoveryURLs()` Gets the value of the discoveryURLs property.
`FindQualifiers`	`getFindQualifiers()` Gets the value of the findQualifiers property.
`FindRelatedBusinesses`	`getFindRelatedBusinesses()` Gets the value of the findRelatedBusinesses property.
`FindTModel`	`getFindTModel()` Gets the value of the findTModel property.
`IdentifierBag`	`getIdentifierBag()` Gets the value of the identifierBag property.
`Integer`	`getListHead()` Gets the value of the listHead property.
`Integer`	`getMaxRows()` Gets the value of the maxRows property.
`List<Name>`	`getName()` Gets the value of the name property.
`TModelBag`	`getTModelBag()` Gets the value of the tModelBag property.
`void`	`setAuthInfo(String value)` Sets the value of the authInfo property.
`void`	`setCategoryBag(CategoryBag value)` Sets the value of the categoryBag property.
`void`	`setDiscoveryURLs(DiscoveryURLs value)` Sets the value of the discoveryURLs property.
`void`	`setFindQualifiers(FindQualifiers value)` Sets the value of the findQualifiers property.
`void`	`setFindRelatedBusinesses(FindRelatedBusinesses value)` Sets the value of the findRelatedBusinesses property.
`void`	`setFindTModel(FindTModel value)` Sets the value of the findTModel property.
`void`	`setIdentifierBag(IdentifierBag value)` Sets the value of the identifierBag property.
`void`	`setListHead(Integer value)` Sets the value of the listHead property.
`void`	`setMaxRows(Integer value)` Sets the value of the maxRows property.
`void`	`setTModelBag(TModelBag value)` Sets the value of the tModelBag property.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - authInfo
```
protected String authInfo
```
  - findQualifiers
```
protected FindQualifiers findQualifiers
```
  - name
```
protected List<Name> name
```
  - identifierBag
```
protected IdentifierBag identifierBag
```
  - categoryBag
```
protected CategoryBag categoryBag
```
  - tModelBag
```
protected TModelBag tModelBag
```
  - findTModel
```
protected FindTModel findTModel
```
  - discoveryURLs
```
protected DiscoveryURLs discoveryURLs
```
  - findRelatedBusinesses
```
protected FindRelatedBusinesses findRelatedBusinesses
```
  - maxRows
```
protected Integer maxRows
```
  - listHead
```
protected Integer listHead
```
- Constructor Detail
  - FindBusiness
```
public FindBusiness()
```
- Method Detail
  - getAuthInfo
```
public String getAuthInfo()
```
    Gets the value of the authInfo property.
    
    Returns:
    
    possible object is String
  - setAuthInfo
```
public void setAuthInfo(String value)
```
    Sets the value of the authInfo property.
    
    Parameters:
    
    value - allowed object is String
  - getFindQualifiers
```
public FindQualifiers getFindQualifiers()
```
    Gets the value of the findQualifiers property.
    
    Returns:
    
    possible object is FindQualifiers
  - setFindQualifiers
```
public void setFindQualifiers(FindQualifiers value)
```
    Sets the value of the findQualifiers property.
    
    Parameters:
    
    value - allowed object is FindQualifiers
  - getName
```
public List<Name> getName()
```
    Gets the value of the name property.
    This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the name property.
    For example, to add a new item, do as follows:
```
    getName().add(newItem);
 
```
    Objects of the following type(s) are allowed in the list Name
  - getIdentifierBag
```
public IdentifierBag getIdentifierBag()
```
    Gets the value of the identifierBag property.
    
    Returns:
    
    possible object is IdentifierBag
  - setIdentifierBag
```
public void setIdentifierBag(IdentifierBag value)
```
    Sets the value of the identifierBag property.
    
    Parameters:
    
    value - allowed object is IdentifierBag
  - getCategoryBag
```
public CategoryBag getCategoryBag()
```
    Gets the value of the categoryBag property.
    
    Returns:
    
    possible object is CategoryBag
  - setCategoryBag
```
public void setCategoryBag(CategoryBag value)
```
    Sets the value of the categoryBag property.
    
    Parameters:
    
    value - allowed object is CategoryBag
  - getTModelBag
```
public TModelBag getTModelBag()
```
    Gets the value of the tModelBag property.
    
    Returns:
    
    possible object is TModelBag
  - setTModelBag
```
public void setTModelBag(TModelBag value)
```
    Sets the value of the tModelBag property.
    
    Parameters:
    
    value - allowed object is TModelBag
  - getFindTModel
```
public FindTModel getFindTModel()
```
    Gets the value of the findTModel property.
    
    Returns:
    
    possible object is FindTModel
  - setFindTModel
```
public void setFindTModel(FindTModel value)
```
    Sets the value of the findTModel property.
    
    Parameters:
    
    value - allowed object is FindTModel
  - getDiscoveryURLs
```
public DiscoveryURLs getDiscoveryURLs()
```
    Gets the value of the discoveryURLs property.
    
    Returns:
    
    possible object is DiscoveryURLs
  - setDiscoveryURLs
```
public void setDiscoveryURLs(DiscoveryURLs value)
```
    Sets the value of the discoveryURLs property.
    
    Parameters:
    
    value - allowed object is DiscoveryURLs
  - getFindRelatedBusinesses
```
public FindRelatedBusinesses getFindRelatedBusinesses()
```
    Gets the value of the findRelatedBusinesses property.
    
    Returns:
    
    possible object is FindRelatedBusinesses
  - setFindRelatedBusinesses
```
public void setFindRelatedBusinesses(FindRelatedBusinesses value)
```
    Sets the value of the findRelatedBusinesses property.
    
    Parameters:
    
    value - allowed object is FindRelatedBusinesses
  - getMaxRows
```
public Integer getMaxRows()
```
    Gets the value of the maxRows property.
    
    Returns:
    
    possible object is Integer
  - setMaxRows
```
public void setMaxRows(Integer value)
```
    Sets the value of the maxRows property.
    
    Parameters:
    
    value - allowed object is Integer
  - getListHead
```
public Integer getListHead()
```
    Gets the value of the listHead property.
    
    Returns:
    
    possible object is Integer
  - setListHead
```
public void setListHead(Integer value)
```
    Sets the value of the listHead property.
    
    Parameters:
    
    value - allowed object is Integer

Class FindBusiness

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

authInfo

findQualifiers

name

identifierBag

categoryBag

tModelBag

findTModel

discoveryURLs

findRelatedBusinesses

maxRows

listHead

Constructor Detail

FindBusiness

Method Detail

getAuthInfo

setAuthInfo

getFindQualifiers

setFindQualifiers

getName

getIdentifierBag

setIdentifierBag

getCategoryBag

setCategoryBag

getTModelBag

setTModelBag

getFindTModel

setFindTModel

getDiscoveryURLs

setDiscoveryURLs

getFindRelatedBusinesses

setFindRelatedBusinesses

getMaxRows

setMaxRows

getListHead

setListHead