org.uddi4j.response
Class RelatedBusinessesList

java.lang.Object
  org.uddi4j.UDDIElement
      org.uddi4j.response.RelatedBusinessesList

All Implemented Interfaces:

java.io.Serializable

public class RelatedBusinessesList

extends UDDIElement

Represents the relatedBusinessesList element within the UDDI version 2.0 schema. This class contains the following types of methods:

• A constructor that passes the required fields.
• A Constructor that will instantiate the object from an appropriate XML DOM element.
• Get/set methods for each attribute that this element can contain.
• A get/setVector method is provided for sets of attributes.
• A SaveToXML method that serializes this class within a passed in element.

Typically, this class is used to construct parameters for, or interpret responses from, methods in the UDDIProxy class.

Element description:

This structure reports the business relationships that are complete between the businessEntity, specified in the find_relatedBusinesses message, and other businessEntity registrations. Business relationships are considered complete, between two businessEntity registrations, when the publishers controlling each of the businessEntity structures set assertions affirming the relationship.

Author:

Ravi Trivedi (ravi_trivedi@hp.com), Ozzy (ozzy@hursley.ibm.com)

See Also:

Serialized Form

Field Summary

protected org.w3c.dom.Element	base
static java.lang.String	UDDI_TAG

Fields inherited from class org.uddi4j.UDDIElement

GENERIC, SOAPNS, XMLNS

Constructor Summary

RelatedBusinessesList()
Default constructor.

RelatedBusinessesList(org.w3c.dom.Element base)
Construct the object from a DOM tree.

RelatedBusinessesList(java.lang.String operator, java.lang.String businessKey, RelatedBusinessInfos bi)
Construct the object with required fields.

Method Summary

java.lang.String	getBusinessKey()
java.lang.String	getOperator()
RelatedBusinessInfos	getRelatedBusinessInfos()
java.lang.String	getTruncated()
boolean	getTruncatedBoolean()
void	saveToXML(org.w3c.dom.Element parent) Save an object to the DOM tree.
void	setBusinessKey(java.lang.String businessKey)
void	setOperator(java.lang.String s)
void	setRelatedBusinessInfos(RelatedBusinessInfos r)
void	setTruncated(boolean s)
void	setTruncated(java.lang.String s)

Methods inherited from class org.uddi4j.UDDIElement

getChildElementsByTagName, getText

Methods inherited from class java.lang.Object

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

Field Detail

UDDI_TAG

public static final java.lang.String UDDI_TAG

See Also:

Constant Field Values

base

protected org.w3c.dom.Element base

Constructor Detail

RelatedBusinessesList

public RelatedBusinessesList()

Default constructor. Avoid using the default constructor for validation. It does not validate required fields. Instead, use the required fields constructor to perform validation.

RelatedBusinessesList

public RelatedBusinessesList(org.w3c.dom.Element base)
                      throws UDDIException

Construct the object from a DOM tree. Used by UDDIProxy to construct an object from a received UDDI message.

Parameters:

base - Element with the name appropriate for this class.

Throws:

UDDIException - Thrown if DOM tree contains a SOAP fault or a disposition report indicating a UDDI error.

RelatedBusinessesList

public RelatedBusinessesList(java.lang.String operator,
                             java.lang.String businessKey,
                             RelatedBusinessInfos bi)

Construct the object with required fields.

Parameters:

operator - String

businessKey - String

bi - RelatedBusinessInfos

Method Detail

getOperator

public java.lang.String getOperator()

setOperator

public void setOperator(java.lang.String s)

getTruncatedBoolean

public boolean getTruncatedBoolean()

setTruncated

public void setTruncated(boolean s)

getTruncated

public java.lang.String getTruncated()

setTruncated

public void setTruncated(java.lang.String s)

getBusinessKey

public java.lang.String getBusinessKey()

setBusinessKey

public void setBusinessKey(java.lang.String businessKey)

getRelatedBusinessInfos

public RelatedBusinessInfos getRelatedBusinessInfos()

setRelatedBusinessInfos

public void setRelatedBusinessInfos(RelatedBusinessInfos r)

saveToXML

public void saveToXML(org.w3c.dom.Element parent)

Save an object to the DOM tree. Used to serialize an object to a DOM tree, usually to send a UDDI message.
Used by UDDIProxy.

Specified by:

saveToXML in class UDDIElement

Parameters:

parent - Object will serialize as a child element under the passed in parent element.