Class RelatedBusinessInfo

java.lang.Object
org.uddi4j.UDDIElement
org.uddi4j.response.RelatedBusinessInfo
All Implemented Interfaces:
Serializable

public class RelatedBusinessInfo extends UDDIElement
Represents the relatedBusinessInfo 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 contains information about one or more relationships between two businessEntitys. The information can be a businessKey, name and optional description data, and a collection element named sharedRelationships. The sharedRelationships element can contain zero or more keyedReference elements. The information in the keyedReference and businessKey elements, for a specific businessEntity, represent complete relationships when they match publisher assertions made by the publisher for each businessEntity.

Author:
Ravi Trivedi (ravi_trivedi@hp.com), Ozzy (ozzy@hursley.ibm.com)
See Also:
  • Field Details

  • Constructor Details

    • RelatedBusinessInfo

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

      public RelatedBusinessInfo(BusinessKey businessKey, Vector names, Vector sharedRelationships)
      Required fields constructor. This constructor initialises the object with the fields required by the uddi specification.
      Parameters:
      businessKey - BusinessKey
      names - Vector of Name objects
      sharedRelationShips - Vector of SharedRelationship objects
    • RelatedBusinessInfo

      public RelatedBusinessInfo(String businessKey, Vector names, Vector sharedRelationships)
      Required fields constructor. This constructor initialises the object with the fields required by the uddi specification.
      Parameters:
      businessKey - String
      names - Vector of Name objects
      sharedRelationships - Vector of SharedRelationship objects
    • RelatedBusinessInfo

      public RelatedBusinessInfo(String businessKey, String name, Vector sharedRelationships)
      Required fields constructor. This constructor initialises the object with the fields required by the uddi specification.
      Parameters:
      businessKey - String
      name - String The default name for this RelatedBusinessInfo
      sharedRelationships - Vector of SharedRelationship objects
    • RelatedBusinessInfo

      public RelatedBusinessInfo(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.
  • Method Details

    • setSharedRelationships

      public void setSharedRelationships(SharedRelationships s)
      Deprecated.
    • setDefaultSharedRelationships

      public void setDefaultSharedRelationships(SharedRelationships s)
      This method stores this name as the Default SharedRelationship (i.e., places it in the first location in the Vector).
    • setSharedRelationshipsVector

      public void setSharedRelationshipsVector(Vector s)
      Parameters:
      s - Vector of SharedRelationships objects
    • setName

      public void setName(Name s)
      Deprecated.
      This method has been deprecated. Use setNameVector(Vector) or setDefaultName(Name) instead
    • setName

      public void setName(String s)
      Deprecated.
      This method has been deprecated. Use setNameVector(Vector) or setDefaultNameString(String, String) instead
    • setDefaultName

      public void setDefaultName(Name name)
      This method stores this name as the Default Name (i.e., places it in the first location in the Vector).
    • setDefaultNameString

      public void setDefaultNameString(String value, String lang)
      This method stores this String, in the given language as the Default Name (i.e., places it in the first location in the Vector).
    • setNameVector

      public void setNameVector(Vector s)
      Parameters:
      s - Vector of Name objects
    • setDescription

      public void setDescription(Description s)
      Deprecated.
      This method has been deprecated. Use setDescriptionVector(Vector) or setDefaultDescription(Description) instead
    • setDescriptionString

      public void setDescriptionString(String s)
      Deprecated.
      This method has been deprecated. Use setDescriptionVector(Vector) or setDefaultDescriptionString(String, String) instead
    • setDefaultDescription

      public void setDefaultDescription(Description s)
      This method stores this Description as the Default Description (i.e., places it in the first location in the Vector).
      Parameters:
      s - Description
    • setDefaultDescriptionString

      public void setDefaultDescriptionString(String s, String lang)
      This method stores this String as the Default Description (i.e., places it in the first location in the Vector).
      Parameters:
      s - String
    • setDescriptionVector

      public void setDescriptionVector(Vector s)
      Set description vector.
      Parameters:
      s - Vector of Description objects.
    • setBusinessKey

      public void setBusinessKey(String s)
    • getSharedRelationships

      public SharedRelationships getSharedRelationships()
      Deprecated.
      This method has been deprecated. Use getSharedRelationshipsVector() or getDefaultSharedRelationships() instead
    • getDefaultSharedRelationships

      public SharedRelationships getDefaultSharedRelationships()
      Get the default SharedRelationships. (i.e., the one in the first position in the vector)
      Returns:
      SharedRelationships
    • getSharedRelationshipsVector

      public Vector getSharedRelationshipsVector()
      Get all SharedRelationships.
      Returns:
      Vector of SharedRelationships objects.
    • getName

      public Name getName()
      Deprecated.
      This method has been deprecated. Use getNameVector() or getDefaultName() instead
    • getNameString

      public String getNameString()
      Deprecated.
      This method has been deprecated. Use getNameVector() or getDefaultNameString() instead
    • getDefaultName

      public Name getDefaultName()
      Get the default name. (i.e., the one in the first position in the vector)
      Returns:
      Name
    • getDefaultNameString

      public String getDefaultNameString()
      Get default name string. (i.e., the one in the first position in the vector)
      Returns:
      String
    • getNameVector

      public Vector getNameVector()
      Get all names.
      Returns:
      Vector of Name objects.
    • getDescription

      public Description getDescription()
      Deprecated.
      This method has been deprecated. Use getDescriptionVector() or getDefaultDescription() instead
    • getDescriptionString

      public String getDescriptionString()
      Deprecated.
      This method has been deprecated. Use getDescriptionVector() or getDefaultDescriptionString() instead
    • getDefaultDescription

      public Description getDefaultDescription()
      Get the default Description. (i.e., the one in the first position in the vector)
      Returns:
      Description
    • getDefaultDescriptionString

      public String getDefaultDescriptionString()
      Get the default Description as a String. (i.e., the first string representing the first Description in the vector)
      Returns:
      String
    • getDescriptionVector

      public Vector getDescriptionVector()
      Get all deascriptions.
      Returns:
      Vector of Description objects.
    • getBusinessKey

      public String getBusinessKey()
    • saveToXML

      public void saveToXML(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.