FindTModel (jUDDI_v3 Parent 3.3.10 API)

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

All Implemented Interfaces:

Serializable
```
public class FindTModel
extends Object
implements Serializable
```
The find_tModel API is used to find UDDI tModel elements. The find_tModel API call returns a list of tModel entries that match a set of specific criteria. The response consists of summary information about registered tModel data returned in a tModelList structure.

· 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. The returned tModelList contains tModelInfo elements whose associated tModels match 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 collection of findQualifier elements is used to alter the default behavior of search functionality. See Section 5.1.4 Find Qualifiers for more information.

· identifierBag This is a list of identifier references in the form of keyedReference elements. The returned tModelList contains tModelInfo elements whose associated tModels match any of the identifiers passed (logical OR by default). Specifying the appropriate findQualifiers can override this behavior. Matching rules are described in Section 5.1.7 Matching Rules for keyedReferences and keyedReferenceGroups.

· 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 string value represents the name of the tModel elements to be found. Since tModel data only has a single name, only a single name may be passed. The argument must match exactly since "exactMatch" is the default behavior, but if the "approximateMatch" findQualifier is used together with the appropriate wildcard character, then matching is done according to wildcard rules. See Section 5.1.6 About Wildcards for additional information. The 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 tModels 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.

Java class for find_tModel complex type.
The following schema fragment specifies the expected content contained within this class.
```
 <complexType name="find_tModel">
   <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" minOccurs="0"/>
         <element ref="{urn:uddi-org:api_v3}identifierBag" 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="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 IdentifierBag`	`identifierBag`
`protected Integer`	`listHead`
`protected Integer`	`maxRows`
`protected Name`	`name`

Constructor Summary

Constructors
Constructor and Description

FindTModel()

Constructors
Constructor and Description
`FindTModel()`

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.
`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.
`Name`	`getName()` Gets the value of the name 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`	`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`	`setName(Name value)` Sets the value of the name 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 Name name
```
  - identifierBag
```
protected IdentifierBag identifierBag
```
  - categoryBag
```
protected CategoryBag categoryBag
```
  - maxRows
```
protected Integer maxRows
```
  - listHead
```
protected Integer listHead
```
- Constructor Detail
  - FindTModel
```
public FindTModel()
```
- 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 Name getName()
```
    Gets the value of the name property.
    
    Returns:
    
    possible object is Name
  - setName
```
public void setName(Name value)
```
    Sets the value of the name property.
    
    Parameters:
    
    value - allowed object is 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
  - 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 FindTModel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

authInfo

findQualifiers

name

identifierBag

categoryBag

maxRows

listHead

Constructor Detail

FindTModel

Method Detail

getAuthInfo

setAuthInfo

getFindQualifiers

setFindQualifiers

getName

setName

getIdentifierBag

setIdentifierBag

getCategoryBag

setCategoryBag

getMaxRows

setMaxRows

getListHead

setListHead