org.systinet.uddi.client.v3.struct
Class RelatedBusinessesList

java.lang.Object
  extended byorg.systinet.uddi.client.base.UDDIObject
      extended byorg.systinet.uddi.client.v3.struct.RelatedBusinessesList
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class RelatedBusinessesList
extends UDDIObject
implements java.lang.Cloneable, java.io.Serializable

Represents {urn:uddi-org:api_v3}relatedBusinessesList type from uddi_v3.xsd (see http://uddi.org/schema/uddi_v3.xsd).

See Also:
Serialized Form

Field Summary
protected  java.lang.String businessKey
          Represents {urn:uddi-org:api_v3}businessKey type from uddi_v3.xsd
protected  ListDescription listDescription
          Represents {urn:uddi-org:api_v3}listDescription type from uddi_v3.xsd
protected  RelatedBusinessInfoArrayList relatedBusinessInfoArrayList
          UDDI list of org.systinet.uddi.client.v3.struct.RelatedBusinessInfo objects.
protected  java.lang.Boolean truncated
          Represents truncated type from uddi_v3.xsd
 
Constructor Summary
RelatedBusinessesList()
          Creates RelatedBusinessesList object.
RelatedBusinessesList(java.lang.String businessKey)
          Creates RelatedBusinessesList object.
RelatedBusinessesList(java.lang.String businessKey, ListDescription listDescription, RelatedBusinessInfoArrayList relatedBusinessInfoArrayList, java.lang.Boolean truncated)
          Creates RelatedBusinessesList object.
 
Method Summary
 void addRelatedBusinessInfo(RelatedBusinessInfo item)
          Adds a relatedBusinessInfo to the relatedBusinessInfoArrayList
 void check()
          Checks this structure.
 java.lang.Object clone()
          Clones this structure.
 boolean equals(java.lang.Object o)
          Indicates whether another object is "equal to" this one.
static RelatedBusinessesList fromXML(org.w3c.dom.Element element)
          Creates a new instance of org.systinet.uddi.client.v3.struct.RelatedBusinessesList class from the element with XML representation of this object.
static RelatedBusinessesList fromXML(java.io.Reader reader)
          Creates a new instance of org.systinet.uddi.client.v3.struct.RelatedBusinessesList class from the reader with XML representation of this object.
static RelatedBusinessesList fromXML(java.lang.String string)
          Creates a new instance of org.systinet.uddi.client.v3.struct.RelatedBusinessesList class from the string with XML representation of this object.
static RelatedBusinessesList fromXML(org.idoox.xml.Tokenizer tokenizer)
          Creates a new instance of org.systinet.uddi.client.v3.struct.RelatedBusinessesList class from the reader with XML representation of this object.
static RelatedBusinessesList fromXML(org.idoox.xml.Tokenizer tokenizer, java.util.Map mapping)
          Creates a new instance of org.systinet.uddi.client.v3.struct.RelatedBusinessesList class from the reader with XML representation of this object.
 java.lang.String getBusinessKey()
          Returns the businessKey.
 ListDescription getListDescription()
          Returns the listDescription.
 RelatedBusinessInfoArrayList getRelatedBusinessInfoArrayList()
          Returns the relatedBusinessInfoArrayList.
 java.lang.Boolean getTruncated()
          Returns the truncated.
 int hashCode()
          Returns a hash code value for the object.
 boolean normalize()
          Normalizes this structure.
 void setBusinessKey(java.lang.String businessKey)
          Sets the businessKey.
 void setListDescription(ListDescription listDescription)
          Sets the listDescription.
 void setRelatedBusinessInfoArrayList(RelatedBusinessInfoArrayList relatedBusinessInfoArrayList)
          Sets the relatedBusinessInfoArrayList.
 void setTruncated(java.lang.Boolean truncated)
          Sets the truncated.
 java.lang.String toXML()
          Returns the XML representation of this object.
 org.w3c.dom.Element toXML(org.w3c.dom.Document document)
          Returns the XML representation of this object.
 void toXML(java.lang.StringBuffer stringBuffer)
          Returns the XML representation of this object.
 void toXML(org.idoox.xml.TokenWriter tokenWriter)
          Returns the XML representation of this object.
 void toXML(org.idoox.xml.TokenWriter tokenWriter, java.util.Map mapping)
          Returns the XML representation of this object.
 void toXML(java.io.Writer writer)
          Returns the XML representation of this object.
 
Methods inherited from class org.systinet.uddi.client.base.UDDIObject
toString
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

listDescription

protected ListDescription listDescription
Represents {urn:uddi-org:api_v3}listDescription type from uddi_v3.xsd


businessKey

protected java.lang.String businessKey
Represents {urn:uddi-org:api_v3}businessKey type from uddi_v3.xsd


relatedBusinessInfoArrayList

protected RelatedBusinessInfoArrayList relatedBusinessInfoArrayList
UDDI list of org.systinet.uddi.client.v3.struct.RelatedBusinessInfo objects.


truncated

protected java.lang.Boolean truncated
Represents truncated type from uddi_v3.xsd

Constructor Detail

RelatedBusinessesList

public RelatedBusinessesList()
Creates RelatedBusinessesList object.


RelatedBusinessesList

public RelatedBusinessesList(java.lang.String businessKey)
                      throws InvalidParameterException
Creates RelatedBusinessesList object.


RelatedBusinessesList

public RelatedBusinessesList(java.lang.String businessKey,
                             ListDescription listDescription,
                             RelatedBusinessInfoArrayList relatedBusinessInfoArrayList,
                             java.lang.Boolean truncated)
                      throws InvalidParameterException
Creates RelatedBusinessesList object.

Method Detail

getListDescription

public ListDescription getListDescription()
Returns the listDescription.

Returns:
the listDescription

setListDescription

public void setListDescription(ListDescription listDescription)
Sets the listDescription.

Parameters:
listDescription - the new listDescription

getBusinessKey

public java.lang.String getBusinessKey()
Returns the businessKey.

Returns:
the businessKey

setBusinessKey

public void setBusinessKey(java.lang.String businessKey)
                    throws InvalidParameterException
Sets the businessKey.

Parameters:
businessKey - the new businessKey
Throws:
InvalidParameterException

addRelatedBusinessInfo

public void addRelatedBusinessInfo(RelatedBusinessInfo item)
Adds a relatedBusinessInfo to the relatedBusinessInfoArrayList

Parameters:
item - the new relatedBusinessInfo.

getRelatedBusinessInfoArrayList

public RelatedBusinessInfoArrayList getRelatedBusinessInfoArrayList()
Returns the relatedBusinessInfoArrayList.

Returns:
the relatedBusinessInfoArrayList

setRelatedBusinessInfoArrayList

public void setRelatedBusinessInfoArrayList(RelatedBusinessInfoArrayList relatedBusinessInfoArrayList)
Sets the relatedBusinessInfoArrayList.

Parameters:
relatedBusinessInfoArrayList - the new relatedBusinessInfoArrayList

getTruncated

public java.lang.Boolean getTruncated()
Returns the truncated.

Returns:
the truncated

setTruncated

public void setTruncated(java.lang.Boolean truncated)
Sets the truncated.

Parameters:
truncated - the new truncated

toXML

public java.lang.String toXML()
Returns the XML representation of this object.

Overrides:
toXML in class UDDIObject
Returns:
the string with XML representation of this object

toXML

public void toXML(java.lang.StringBuffer stringBuffer)
Returns the XML representation of this object.

Overrides:
toXML in class UDDIObject
Parameters:
stringBuffer - the XML representation of this object will be added to this parameter

toXML

public org.w3c.dom.Element toXML(org.w3c.dom.Document document)
Returns the XML representation of this object.

Overrides:
toXML in class UDDIObject
Parameters:
document - base document
Returns:
the element with the XML representation of this object

toXML

public void toXML(java.io.Writer writer)
Returns the XML representation of this object.

Overrides:
toXML in class UDDIObject
Parameters:
writer - the XML representation of this object will be added to this parameter

toXML

public void toXML(org.idoox.xml.TokenWriter tokenWriter)
Returns the XML representation of this object.

Overrides:
toXML in class UDDIObject
Parameters:
tokenWriter - the XML representation of this object will be added to this parameter

toXML

public void toXML(org.idoox.xml.TokenWriter tokenWriter,
                  java.util.Map mapping)
Returns the XML representation of this object.

Overrides:
toXML in class UDDIObject
Parameters:
tokenWriter - the XML representation of this object will be added to this parameter
mapping -

fromXML

public static RelatedBusinessesList fromXML(java.lang.String string)
                                     throws InvalidParameterException,
                                            org.idoox.util.WrappedException
Creates a new instance of org.systinet.uddi.client.v3.struct.RelatedBusinessesList class from the string with XML representation of this object.

Parameters:
string - String with XML representation of this object
Throws:
InvalidParameterException
org.idoox.util.WrappedException

fromXML

public static RelatedBusinessesList fromXML(org.w3c.dom.Element element)
                                     throws InvalidParameterException,
                                            org.idoox.util.WrappedException
Creates a new instance of org.systinet.uddi.client.v3.struct.RelatedBusinessesList class from the element with XML representation of this object.

Parameters:
element - Elelemt with XML representation of this object
Throws:
InvalidParameterException
org.idoox.util.WrappedException

fromXML

public static RelatedBusinessesList fromXML(java.io.Reader reader)
                                     throws InvalidParameterException,
                                            org.idoox.util.WrappedException
Creates a new instance of org.systinet.uddi.client.v3.struct.RelatedBusinessesList class from the reader with XML representation of this object.

Parameters:
reader - Reader with XML representation of this object
Throws:
InvalidParameterException
org.idoox.util.WrappedException

fromXML

public static RelatedBusinessesList fromXML(org.idoox.xml.Tokenizer tokenizer)
                                     throws InvalidParameterException,
                                            org.idoox.util.WrappedException
Creates a new instance of org.systinet.uddi.client.v3.struct.RelatedBusinessesList class from the reader with XML representation of this object.

Parameters:
tokenizer - Tokenizer with XML representation of this object
Throws:
InvalidParameterException
org.idoox.util.WrappedException

fromXML

public static RelatedBusinessesList fromXML(org.idoox.xml.Tokenizer tokenizer,
                                            java.util.Map mapping)
                                     throws InvalidParameterException,
                                            org.idoox.util.WrappedException
Creates a new instance of org.systinet.uddi.client.v3.struct.RelatedBusinessesList class from the reader with XML representation of this object.

Parameters:
tokenizer - Tokenizer with XML representation of this object
mapping -
Throws:
InvalidParameterException
org.idoox.util.WrappedException

check

public void check()
           throws InvalidParameterException
Checks this structure.

Overrides:
check in class UDDIObject
Throws:
InvalidParameterException - if the required field is missing.

normalize

public boolean normalize()
Normalizes this structure. It removes not required empty members, arrays, and so on.

Overrides:
normalize in class UDDIObject

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Clones this structure. It returns deep copy.

Overrides:
clone in class UDDIObject
Throws:
java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object o)
Indicates whether another object is "equal to" this one.

Parameters:
o - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.

hashCode

public int hashCode()
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

Overrides:
hashCode in class UDDIObject
Returns:
a hash code value for this object.