org.uddi4j.response
Class RelatedBusinessInfos

java.lang.Object
  extended byorg.uddi4j.UDDIElement
      extended byorg.uddi4j.response.RelatedBusinessInfos
All Implemented Interfaces:
java.io.Serializable

public class RelatedBusinessInfos
extends UDDIElement

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

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

Element description:

This is a response message that contains a set of one or more RelatedBusinessInfo structures.

Author:
Ravi Trivedi (ravi_trivedi@hp.com), Vivek Chopra (vivek@soaprpc.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
RelatedBusinessInfos()
          Default constructor.
RelatedBusinessInfos(org.w3c.dom.Element base)
          Construct the object from a DOM tree.
RelatedBusinessInfos(java.util.Vector relatedBusinessInfo)
          Construct the object with required fields.
 
Method Summary
 void add(RelatedBusinessInfo r)
          Add a RelatedBusinessInfo object to the collection
 RelatedBusinessInfo get(int index)
          Retrieve the RelatedBusinessInfo at the specified index within the collection.
 java.util.Vector getRelatedBusinessInfoVector()
           
 boolean remove(RelatedBusinessInfo r)
          Remove a RelatedBusinessInfo object from the collection
 void saveToXML(org.w3c.dom.Element parent)
          Save an object to the DOM tree.
 void setRelatedBusinessInfoVector(java.util.Vector relatedBusinessInfo)
           
 int size()
          Return current size of the collection.
 
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

RelatedBusinessInfos

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


RelatedBusinessInfos

public RelatedBusinessInfos(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.

RelatedBusinessInfos

public RelatedBusinessInfos(java.util.Vector relatedBusinessInfo)
Construct the object with required fields.

Parameters:
relatedBusinessInfo - Vector
Method Detail

getRelatedBusinessInfoVector

public java.util.Vector getRelatedBusinessInfoVector()

setRelatedBusinessInfoVector

public void setRelatedBusinessInfoVector(java.util.Vector relatedBusinessInfo)

add

public void add(RelatedBusinessInfo r)
Add a RelatedBusinessInfo object to the collection

Parameters:
r - RelatedBusinessInfo to be added

remove

public boolean remove(RelatedBusinessInfo r)
Remove a RelatedBusinessInfo object from the collection

Parameters:
r - RelatedBusinessInfo to be removed
Returns:
True if object was removed, false if it was not found in the collection.

get

public RelatedBusinessInfo get(int index)
Retrieve the RelatedBusinessInfo at the specified index within the collection.

Parameters:
index - Index to retrieve from.
Returns:
RelatedBusinessInfo at that index

size

public int size()
Return current size of the collection.

Returns:
Number of RelatedBusinessInfos in the collection

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.


Copyright © 2001 International Business Machines Corporation, Hewlett-Packard Company. All Rights Reserved.