inspireit.uddi.request.inquiry
Class FindRelatedBusinesses

java.lang.Object
  |
  +--inspireit.uddi.request.inquiry.FindRelatedBusinesses

All Implemented Interfaces:

java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

public class FindRelatedBusinesses

extends java.lang.Object

implements java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

FindRelatedBusinesses represents a find_relatedBusinesses UDDI query. find_relatedBusinesses is used to get information about BusinessEntity data that are related to a particular BusinessEntity in a particular way. Only those relationships whose assertion status is complete are reported.

Since:

UDDI V2.0

Author:

Bertrand Fontaine, INSPIRE IT $Revision: 1.2 $

See Also:

Serialized Form

Field Summary

protected AuthInfo	authInfo Authentication information.
protected BusinessKey	businessKey BusinessKey specifying a BusinessEntity to use as the focal point of the search.
protected FindQualifiers	findQualifiers FindQualifier elements altering the default search behavior.
protected FromKey	fromKey
protected java.lang.String	generic The UDDI version in use.
protected KeyedReference	keyedReference KeyedReference specifying the relationship between the focal point and the results.
protected int	listHead The index of the item that must be returned as the first resultant set element.
protected int	maxRows Limit to the number of rows returned.
protected ToKey	toKey

Constructor Summary

FindRelatedBusinesses(AuthInfo authInfo, BusinessKey businessKey, KeyedReference keyedReference, FindQualifiers findQualifiers, int listHead, int maxRows)
FindRelatedBusinesses constructor.

FindRelatedBusinesses(AuthInfo authInfo, FromKey fromKey, KeyedReference keyedReference, FindQualifiers findQualifiers, int listHead, int maxRows)
FindRelatedBusinesses constructor.

FindRelatedBusinesses(AuthInfo authInfo, ToKey toKey, KeyedReference keyedReference, FindQualifiers findQualifiers, int listHead, int maxRows)
FindRelatedBusinesses constructor.

FindRelatedBusinesses(java.lang.String generic, BusinessKey businessKey, KeyedReference keyedReference, FindQualifiers findQualifiers, int maxRows)
Deprecated. as of UDDI V3.0

Method Summary

AuthInfo	getAuthInfo() Gets the authentication information.
BusinessKey	getBusinessKey() Gets the BusinessKey specifying a BusinessEntity to use as the focal point of the search.
FindQualifiers	getFindQualifiers() Gets the FindQualifier elements altering the default search behavior.
FromKey	getFromKey()
java.lang.String	getGeneric() Deprecated. as of UDDI V3.0
KeyedReference	getKeyedReference() Gets the KeyedReference specifying the relationship between the focal point and the results.
int	getListHead()
int	getMaxRows() Gets the limit to the number of rows returned (Integer.MAX_VALUE = no limit).
ToKey	getToKey()
java.lang.Object	visit(inspireit.uddi.util.visitors.UDDIVisitor visitor) Visits this UDDI element.

Methods inherited from class java.lang.Object

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

Field Detail

generic

protected java.lang.String generic

The UDDI version in use.

businessKey

protected BusinessKey businessKey

BusinessKey specifying a BusinessEntity to use as the focal point of the search.

findQualifiers

protected FindQualifiers findQualifiers

FindQualifier elements altering the default search behavior.

keyedReference

protected KeyedReference keyedReference

KeyedReference specifying the relationship between the focal point and the results.

maxRows

protected int maxRows

Limit to the number of rows returned.

listHead

protected int listHead

The index of the item that must be returned as the first resultant set element.

authInfo

protected AuthInfo authInfo

Authentication information.

fromKey

protected FromKey fromKey

toKey

protected ToKey toKey

Constructor Detail

FindRelatedBusinesses

public FindRelatedBusinesses(java.lang.String generic,
                             BusinessKey businessKey,
                             KeyedReference keyedReference,
                             FindQualifiers findQualifiers,
                             int maxRows)

Deprecated. as of UDDI V3.0

FindRelatedBusinesses constructor.

Parameters:

generic - The UDDI version in use.

businessKey - BusinessKey specifying a BusinessEntity to use as the focal point of the search.

findQualifiers - FindQualifier elements altering the default search behavior.

keyedReference - KeyedReference specifying the relationship between the focal point and the results.

maxRows - The eventual limit set on the maximum returned values (pass Integer.MAX_VALUE to not set any limit).

FindRelatedBusinesses

public FindRelatedBusinesses(AuthInfo authInfo,
                             BusinessKey businessKey,
                             KeyedReference keyedReference,
                             FindQualifiers findQualifiers,
                             int listHead,
                             int maxRows)

FindRelatedBusinesses constructor.

Parameters:

authInfo - The authentication information.

businessKey - BusinessKey specifying a BusinessEntity to use as the focal point of the search.

findQualifiers - FindQualifier elements altering the default search behavior.

keyedReference - KeyedReference specifying the relationship between the focal point and the results.

listHead -

maxRows - The eventual limit set on the maximum returned values (pass Integer.MAX_VALUE to not set any limit).

Since:

UDDI V3.0

FindRelatedBusinesses

public FindRelatedBusinesses(AuthInfo authInfo,
                             FromKey fromKey,
                             KeyedReference keyedReference,
                             FindQualifiers findQualifiers,
                             int listHead,
                             int maxRows)

FindRelatedBusinesses constructor.

Parameters:

authInfo - The authentication information.

fromKey - focal point of the search.

findQualifiers - FindQualifier elements altering the default search behavior.

keyedReference - KeyedReference specifying the relationship between the focal point and the results.

listHead -

maxRows - The eventual limit set on the maximum returned values (pass Integer.MAX_VALUE to not set any limit).

Since:

UDDI V3.0

FindRelatedBusinesses

public FindRelatedBusinesses(AuthInfo authInfo,
                             ToKey toKey,
                             KeyedReference keyedReference,
                             FindQualifiers findQualifiers,
                             int listHead,
                             int maxRows)

FindRelatedBusinesses constructor.

Parameters:

authInfo - The authentication information.

toKey - focal point of the search.

findQualifiers - FindQualifier elements altering the default search behavior.

keyedReference - KeyedReference specifying the relationship between the focal point and the results.

listHead -

maxRows - The eventual limit set on the maximum returned values (pass Integer.MAX_VALUE to not set any limit).

Since:

UDDI V3.0

Method Detail

getGeneric

public java.lang.String getGeneric()

Deprecated. as of UDDI V3.0

Gets the UDDI version in use.

Returns:

the UDDI version in use

getBusinessKey

public BusinessKey getBusinessKey()

Gets the BusinessKey specifying a BusinessEntity to use as the focal point of the search.

Returns:

the BusinessKey specifying a BusinessEntity to use as the focal point of the search.

getFromKey

public FromKey getFromKey()

Since:

UDDI V3.0

getToKey

public ToKey getToKey()

Since:

UDDI V3.0

getFindQualifiers

public FindQualifiers getFindQualifiers()

Gets the FindQualifier elements altering the default search behavior.

Returns:

the FindQualifier elements altering the default search behavior

getKeyedReference

public KeyedReference getKeyedReference()

Gets the KeyedReference specifying the relationship between the focal point and the results.

Returns:

the KeyedReference specifying the relationship between the focal point and the results.

getListHead

public int getListHead()

Returns:

...

Since:

UDDI V3.0

getAuthInfo

public AuthInfo getAuthInfo()

Gets the authentication information.

Returns:

the authentication information

Since:

UDDI V3.0

getMaxRows

public int getMaxRows()

Gets the limit to the number of rows returned (Integer.MAX_VALUE = no limit).

Returns:

the limit to the number of rows returned (Integer.MAX_VALUE = no limit).

visit

public java.lang.Object visit(inspireit.uddi.util.visitors.UDDIVisitor visitor)

Visits this UDDI element.

Specified by:

visit in interface inspireit.uddi.util.visitors.UDDIElement

Parameters:

visitor - The visiting UDDI object.