FindBinding (UDDIv2 and v3 WS Stubs and Schema Bindings Generated from WSDL 3.3.10 API)

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

All Implemented Interfaces:

Serializable
```
public class FindBinding
extends Object
implements Serializable
```
The find_binding API is used to find UDDI bindingTemplate elements. The find_binding API call returns a bindingDetail that contains zero or more bindingTemplate structures matching the criteria specified in the argument list. *

authInfo: This optional argument is an element that contains an authentication token. Registries that wish to restrict who can perform an inquiry typically require authInfo for this call.

· categoryBag: This optional argument is a list of category references in the form of keyedReference elements and keyedReferenceGroup structures. When used, the returned bindingDetail for this API will contain 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.

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

· find_tModel: This argument provides an alternative or additional way of specifying tModelKeys that are to be used to find the bindingTemplate elements. When specified, the find_tModel argument is treated as an embedded inquiry that is performed prior to searching for bindingTemplate elements. 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 bindingTemplates. 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.

· serviceKey: This optional uddi_key is used to specify a particular instance of a businessService element in the registered data. Only bindings in the specific businessService data identified by the serviceKey passed are searched. When it is either omitted or specified as empty (i.e., serviceKey=""), this indicates that all businessServices are to be searched for bindings that meet the other criteria supplied without regard to the service that provides them, and "projected" services are suppressed.

· tModelBag: This collection of tModelKey elements represent in part or in whole the technical fingerprint of the bindingTemplate structures for which the search is being performed. At least one of either a tModelBag or a find_tModel argument SHOULD be supplied, unless a categoryBag based search is being used.

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 have a technical fingerprint containing all of the supplied tModelKeys match (logical AND). Specifying appropriate findQualifiers can override this behavior so that bindingTemplates with a technical fingerprint containing any of the specified tModelKeys are returned (logical OR).

Java class for find_binding complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="find_binding">
   <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}tModelBag" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}find_tModel" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}categoryBag" minOccurs="0"/>
       </sequence>
       <attribute name="maxRows" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="serviceKey" type="{urn:uddi-org:api_v3}serviceKey" />
       <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 FindQualifiers`	`findQualifiers`
`protected FindTModel`	`findTModel`
`protected Integer`	`listHead`
`protected Integer`	`maxRows`
`protected String`	`serviceKey`
`protected TModelBag`	`tModelBag`

Constructor Summary

Constructors
Constructor and Description

FindBinding()

Constructors
Constructor and Description
`FindBinding()`

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.
`FindQualifiers`	`getFindQualifiers()` Gets the value of the findQualifiers property.
`FindTModel`	`getFindTModel()` Gets the value of the findTModel property.
`Integer`	`getListHead()` Gets the value of the listHead property.
`Integer`	`getMaxRows()` Gets the value of the maxRows property.
`String`	`getServiceKey()` Gets the value of the serviceKey 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`	`setFindQualifiers(FindQualifiers value)` Sets the value of the findQualifiers property.
`void`	`setFindTModel(FindTModel value)` Sets the value of the findTModel property.
`void`	`setListHead(Integer value)` Sets the value of the listHead property.
`void`	`setMaxRows(Integer value)` Sets the value of the maxRows property.
`void`	`setServiceKey(String value)` Sets the value of the serviceKey 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
```
  - tModelBag
```
protected TModelBag tModelBag
```
  - findTModel
```
protected FindTModel findTModel
```
  - categoryBag
```
protected CategoryBag categoryBag
```
  - maxRows
```
protected Integer maxRows
```
  - serviceKey
```
protected String serviceKey
```
  - listHead
```
protected Integer listHead
```
- Constructor Detail
  - FindBinding
```
public FindBinding()
```
- 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
  - 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
  - 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
  - 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
  - getServiceKey
```
public String getServiceKey()
```
    Gets the value of the serviceKey property.
    
    Returns:
    
    possible object is String
  - setServiceKey
```
public void setServiceKey(String value)
```
    Sets the value of the serviceKey property.
    
    Parameters:
    
    value - allowed object is String
  - 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 FindBinding

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

authInfo

findQualifiers

tModelBag

findTModel

categoryBag

maxRows

serviceKey

listHead

Constructor Detail

FindBinding

Method Detail

getAuthInfo

setAuthInfo

getFindQualifiers

setFindQualifiers

getTModelBag

setTModelBag

getFindTModel

setFindTModel

getCategoryBag

setCategoryBag

getMaxRows

setMaxRows

getServiceKey

setServiceKey

getListHead

setListHead