FindService (jUDDI_v3 Parent 3.3.10 API)

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

All Implemented Interfaces:

Serializable
```
public class FindService
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.

· businessKey: This optional uddi_key is used to specify a particular businessEntity instance to search. When supplied, this argument is used to specify an existing businessEntity within which services should be found. Projected services are included unless the "suppressProjectedServices" findQualifier is used. If businessKey it is either omitted or specified as empty (i.e., businessKey=""), this indicates that all businessEntities are to be searched for services that meet the other criteria supplied without regard to the business that provides them and service projections does not apply.

· categoryBag: This is a list of category references. The returned serviceList contains serviceInfo structures matching all of the categories passed (logical AND by default). Specifying the appropriate findQualifiers can override this behavior. Matching rules for the use of keyedReferences and keyedReferenceGroups are described 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 used to find services 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 services. 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 services. 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 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 businessService data contained in the specified businessEntity (or across all businesses if the businessKey is omitted or specified as empty) with matching name value will be returned. Matching occurs using wildcard matching rules. See Section 5.1.6 About Wildcards. If multiple name values are passed, the match occurs on a logical OR basis within any names supplied. 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 services 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 is represented in UDDI by a bindingTemplate contained within some businessService. A bindingTemplate contains a collection of tModel references called its "technical fingerprint" that specifies its type. The tModelBag argument is a collection of tModelKey values specifying that the search results are to be limited to businessServices containing bindingTemplates with technical fingerprints that match.

If a find_tModel argument is specified (see below), 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_service complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="find_service">
   <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}categoryBag" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}tModelBag" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}find_tModel" minOccurs="0"/>
       </sequence>
       <attribute name="maxRows" type="{http://www.w3.org/2001/XMLSchema}int" />
       <attribute name="businessKey" type="{urn:uddi-org:api_v3}businessKey" />
       <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 String`	`businessKey`
`protected CategoryBag`	`categoryBag`
`protected FindQualifiers`	`findQualifiers`
`protected FindTModel`	`findTModel`
`protected Integer`	`listHead`
`protected Integer`	`maxRows`
`protected List<Name>`	`name`
`protected TModelBag`	`tModelBag`

Constructor Summary

Constructors
Constructor and Description

FindService()

Constructors
Constructor and Description
`FindService()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAuthInfo()` Gets the value of the authInfo property.
`String`	`getBusinessKey()` Gets the value of the businessKey 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.
`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`	`setBusinessKey(String value)` Sets the value of the businessKey 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`	`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
```
  - categoryBag
```
protected CategoryBag categoryBag
```
  - tModelBag
```
protected TModelBag tModelBag
```
  - findTModel
```
protected FindTModel findTModel
```
  - maxRows
```
protected Integer maxRows
```
  - businessKey
```
protected String businessKey
```
  - listHead
```
protected Integer listHead
```
- Constructor Detail
  - FindService
```
public FindService()
```
- 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
  - 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
  - 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
  - getBusinessKey
```
public String getBusinessKey()
```
    Gets the value of the businessKey property.
    
    Returns:
    
    possible object is String
  - setBusinessKey
```
public void setBusinessKey(String value)
```
    Sets the value of the businessKey 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 FindService

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

authInfo

findQualifiers

name

categoryBag

tModelBag

findTModel

maxRows

businessKey

listHead

Constructor Detail

FindService

Method Detail

getAuthInfo

setAuthInfo

getFindQualifiers

setFindQualifiers

getName

getCategoryBag

setCategoryBag

getTModelBag

setTModelBag

getFindTModel

setFindTModel

getMaxRows

setMaxRows

getBusinessKey

setBusinessKey

getListHead

setListHead