org.apache.juddi.datatype.request
Class FindService

java.lang.Object
  extended by org.apache.juddi.datatype.request.FindService
All Implemented Interfaces:
java.io.Serializable, RegistryObject, Inquiry

public class FindService
extends java.lang.Object
implements RegistryObject, Inquiry

"Used to locate specific services within a registered businessEntity. Return a serviceList message." From the XML spec (API, p18) it appears that the name, categoryBag, and tModelBag arguments are mutually exclusive.

Author:
Steve Viens (sviens@apache.org)
See Also:
Serialized Form

Constructor Summary
FindService()
          Constructs a new empty find_service request.
FindService(java.lang.String businessKey)
          Construct a new find_service request.
 
Method Summary
 void addCategory(KeyedReference ref)
          Adds a category reference to the categoryBag argument of this search.
 void addFindQualifier(FindQualifier findQualifier)
           
 void addName(Name nameValue)
          Sets the name argument of the search to the given name.
 void addTModelKey(java.lang.String key)
          Adds a tModel reference to the tModelBag argument of this search.
 java.lang.String getBusinessKey()
          Returns the businesskey of this find_service request.
 CategoryBag getCategoryBag()
          Returns the CategoryBag value
 FindQualifiers getFindQualifiers()
           
 java.lang.String getGeneric()
           
 int getMaxRows()
           
 java.util.Vector getNameVector()
          Returns the name argument of the search.
 TModelBag getTModelBag()
          Returns the list of tModel references as an enumeration.
 void setBusinessKey(java.lang.String key)
          Sets the businesskey of this find_service request to the given key.
 void setCategoryBag(CategoryBag bag)
          Sets the CategoryBag value
 void setFindQualifiers(FindQualifiers findQualifiers)
           
 void setGeneric(java.lang.String genericValue)
           
 void setMaxRows(int maxRows)
           
 void setMaxRows(java.lang.String maxRows)
           
 void setNameVector(java.util.Vector names)
          Sets the name argument of the search to the given name.
 void setTModelBag(TModelBag bag)
          Sets the TModelBag value.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FindService

public FindService()
Constructs a new empty find_service request.


FindService

public FindService(java.lang.String businessKey)
Construct a new find_service request. The services searched for must be part of the businessEntity with the given businessKey.

Parameters:
businessKey - The key of the businessEntity to search in.
Throws:
java.lang.NullPointerException - If the given key is null.
Method Detail

setBusinessKey

public void setBusinessKey(java.lang.String key)
Sets the businesskey of this find_service request to the given key. Only services of the referenced businessEntity are searched.

Parameters:
key - A reference to the businessEntity.
Throws:
java.lang.NullPointerException - If the given key is null.

getBusinessKey

public java.lang.String getBusinessKey()
Returns the businesskey of this find_service request. Only services of the referenced businessEntity are searched.

Returns:
The businesskey of the referenced businessEntity.

setGeneric

public void setGeneric(java.lang.String genericValue)
Parameters:
genericValue -

getGeneric

public java.lang.String getGeneric()
Returns:
String UDDI request's generic value.

addName

public void addName(Name nameValue)
Sets the name argument of the search to the given name. This value is a partial name. The serviceList return contains ServiceInfo objects for services whose name matches the value passed (leftmost match).

Parameters:
nameValue - The name argument of the search.

getNameVector

public java.util.Vector getNameVector()
Returns the name argument of the search. Null is returned if the name argument for this search has not been specified.

Returns:
The name argument of the search, or null if the argument has not been specified.

setNameVector

public void setNameVector(java.util.Vector names)
Sets the name argument of the search to the given name. This value is a partial name. The serviceList return contains ServiceInfo objects for services whose name matches the value passed (leftmost match).

Parameters:
names - The name argument of the search.

addCategory

public void addCategory(KeyedReference ref)
Adds a category reference to the categoryBag argument of this search.

Parameters:
ref - The category reference to add.

setCategoryBag

public void setCategoryBag(CategoryBag bag)
Sets the CategoryBag value

Parameters:
bag - The new CategoryBag

getCategoryBag

public CategoryBag getCategoryBag()
Returns the CategoryBag value

Returns:
The CategoryBag value

addTModelKey

public void addTModelKey(java.lang.String key)
Adds a tModel reference to the tModelBag argument of this search. This tModelBag argument lets you search for businesses that have bindings that are compatible with a specific tModel pattern.

Parameters:
key - The key of the tModel to add to the tModelBag argument.

setTModelBag

public void setTModelBag(TModelBag bag)
Sets the TModelBag value.

Parameters:
bag - the new TModelBag.

getTModelBag

public TModelBag getTModelBag()
Returns the list of tModel references as an enumeration. If the tModelBag has not been specified, an empty list is returned.

Returns:
The list of the tModel references.

getMaxRows

public int getMaxRows()

setMaxRows

public void setMaxRows(int maxRows)

setMaxRows

public void setMaxRows(java.lang.String maxRows)

addFindQualifier

public void addFindQualifier(FindQualifier findQualifier)

setFindQualifiers

public void setFindQualifiers(FindQualifiers findQualifiers)

getFindQualifiers

public FindQualifiers getFindQualifiers()


Copyright © 2004-2007. All Rights Reserved.