cgl.fthpis.datatype.request
Class FindService

java.lang.Object
  cgl.fthpis.datatype.request.FindService

All Implemented Interfaces:

Inquiry, org.apache.juddi.datatype.RegistryObject, java.io.Serializable

public class FindService

extends java.lang.Object

implements org.apache.juddi.datatype.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:

Mehmet S. Aktas (maktas@indiana.edu)

See Also:

Serialized Form

Field Summary

(package private) AuthInfo	authInfo
(package private) java.lang.String	businessKey
(package private) org.apache.juddi.datatype.CategoryBag	categoryBag
(package private) AttributeBag	dynamicContextBag
(package private) org.apache.juddi.datatype.request.FindQualifiers	findQualifiers
(package private) java.lang.String	generic
(package private) Lease	lease
(package private) int	maxRows
(package private) java.util.Vector	nameVector
(package private) java.util.Vector	sessionKeyVector
(package private) AttributeBag	staticContextBag
(package private) org.apache.juddi.datatype.TModelBag	tModelBag

Constructor Summary

FindService()
Constructs a new empty find_service request.

FindService(java.lang.String businessKey)
Construct a new find_service request.

Method Summary

void	addAttribute(Attribute attribute) Adds a category reference to the categoryBag argument of this search.
void	addCategory(org.apache.juddi.datatype.KeyedReference ref) Adds a category reference to the categoryBag argument of this search.
void	addDynamicContext(Attribute dynamicContext) Adds a category reference to the categoryBag argument of this search.
void	addFindQualifier(org.apache.juddi.datatype.request.FindQualifier findQualifier)
void	addName(org.apache.juddi.datatype.Name nameValue) Sets the name argument of the search to the given name.
void	addSessionKey(SessionKey sessionKey) 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.
AttributeBag	getAttributeBag() Returns the CategoryBag value
AuthInfo	getAuthInfo()
java.lang.String	getBusinessKey() Returns the businesskey of this find_service request.
org.apache.juddi.datatype.CategoryBag	getCategoryBag() Returns the CategoryBag value
AttributeBag	getDynamicContextBag() Returns the CategoryBag value
org.apache.juddi.datatype.request.FindQualifiers	getFindQualifiers()
java.lang.String	getGeneric()
Lease	getLease() Returns the CategoryBag value
int	getMaxRows()
java.util.Vector	getNameVector() Returns the name argument of the search.
java.util.Vector	getSessionKeyVector() Returns the name argument of the search.
org.apache.juddi.datatype.TModelBag	getTModelBag() Returns the list of tModel references as an enumeration.
void	setAttributeBag(AttributeBag bag) Sets the CategoryBag value
void	setAuthInfo(AuthInfo authInfo)
void	setBusinessKey(java.lang.String key) Sets the businesskey of this find_service request to the given key.
void	setCategoryBag(org.apache.juddi.datatype.CategoryBag bag) Sets the CategoryBag value
void	setDynamicContextBag(AttributeBag bag) Sets the CategoryBag value
void	setFindQualifiers(org.apache.juddi.datatype.request.FindQualifiers findQualifiers)
void	setGeneric(java.lang.String genericValue)
void	setLease(Lease lease_) Sets the CategoryBag value
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	setSessionKeyVector(java.util.Vector vec) Sets the name argument of the search to the given name.
void	setTModelBag(org.apache.juddi.datatype.TModelBag bag) Sets the TModelBag value.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

authInfo

AuthInfo authInfo

generic

java.lang.String generic

businessKey

java.lang.String businessKey

nameVector

java.util.Vector nameVector

categoryBag

org.apache.juddi.datatype.CategoryBag categoryBag

staticContextBag

AttributeBag staticContextBag

lease

Lease lease

tModelBag

org.apache.juddi.datatype.TModelBag tModelBag

sessionKeyVector

java.util.Vector sessionKeyVector

dynamicContextBag

AttributeBag dynamicContextBag

findQualifiers

org.apache.juddi.datatype.request.FindQualifiers findQualifiers

maxRows

int maxRows

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.

addSessionKey

public void addSessionKey(SessionKey sessionKey)

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).

getSessionKeyVector

public java.util.Vector getSessionKeyVector()

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.

setSessionKeyVector

public void setSessionKeyVector(java.util.Vector vec)

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).

addName

public void addName(org.apache.juddi.datatype.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(org.apache.juddi.datatype.KeyedReference ref)

Adds a category reference to the categoryBag argument of this search.

Parameters:

ref - The category reference to add.

setCategoryBag

public void setCategoryBag(org.apache.juddi.datatype.CategoryBag bag)

Sets the CategoryBag value

Parameters:

bag - The new CategoryBag

getCategoryBag

public org.apache.juddi.datatype.CategoryBag getCategoryBag()

Returns the CategoryBag value

Returns:

The CategoryBag value

setLease

public void setLease(Lease lease_)

Sets the CategoryBag value

getLease

public Lease getLease()

Returns the CategoryBag value

Returns:

The CategoryBag value

addAttribute

public void addAttribute(Attribute attribute)

Adds a category reference to the categoryBag argument of this search.

setAttributeBag

public void setAttributeBag(AttributeBag bag)

Sets the CategoryBag value

Parameters:

bag - The new CategoryBag

getAttributeBag

public AttributeBag getAttributeBag()

Returns the CategoryBag value

Returns:

The CategoryBag value

addDynamicContext

public void addDynamicContext(Attribute dynamicContext)

Adds a category reference to the categoryBag argument of this search.

setDynamicContextBag

public void setDynamicContextBag(AttributeBag bag)

Sets the CategoryBag value

Parameters:

bag - The new CategoryBag

getDynamicContextBag

public AttributeBag getDynamicContextBag()

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(org.apache.juddi.datatype.TModelBag bag)

Sets the TModelBag value.

Parameters:

bag - the new TModelBag.

getTModelBag

public org.apache.juddi.datatype.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(org.apache.juddi.datatype.request.FindQualifier findQualifier)

setFindQualifiers

public void setFindQualifiers(org.apache.juddi.datatype.request.FindQualifiers findQualifiers)

getFindQualifiers

public org.apache.juddi.datatype.request.FindQualifiers getFindQualifiers()

setAuthInfo

public void setAuthInfo(AuthInfo authInfo)

getAuthInfo

public AuthInfo getAuthInfo()