Oracle Application Server Web Services UDDI Client API Reference
10g (9.0.4)

Part No. B10396-01

oracle.uddi.message.response
Class RelatedBusinessInfo

java.lang.Object
  |
  +--oracle.uddi.message.UddiElement
        |
        +--oracle.uddi.message.response.RelatedBusinessInfo

public class RelatedBusinessInfo
extends UddiElement

General information:

This class represents a response message defined in the UDDI API schema. Usage of this class is specific to UDDI version 2.

Element description:

It maps to relatedBusinessInfo UDDI response message.


Field Summary
static java.lang.String ELT_BUSINESSKEY
           
static java.lang.String UDDI_TAG
           

 

Constructor Summary
RelatedBusinessInfo(UddiElementFactory ueFactory)
           

 

Method Summary
 java.lang.String getBusinessKey()
           
 java.util.List getDescriptionList()
           
 java.lang.String getFirstDescription()
          Return the first description string, irrespective of the language.
 SharedRelationships getFromKeySharedRelationships()
           
 java.util.List getNameList()
           
 java.lang.String getTagName()
          Returns the local name of the tag of the UDDI Element.
 SharedRelationships getToKeySharedRelationships()
           
 void init()
          This method is not intended for use by clients of the API.
 void setBusinessKey(java.lang.String businessKey)
           
 void setDefaultDescription(java.lang.String defaultDesc)
          Set the default description, i.e., the description without any language qualifier.
 void setDescriptionList(java.util.List listDescription)
           
 void setFromKeySharedRelationships(SharedRelationships fromKeySharedRelationships)
           
 void setNameList(java.util.List listName)
           
 void setToKeySharedRelationships(SharedRelationships toKeySharedRelationships)
           

 

Methods inherited from class oracle.uddi.message.UddiElement
getElementName, getElementPrefix, getGeneric, getNamespaceUri, getUddiElementFactory, getVersion, hasEmptyContent, isV1Compatible, isV2Compatible, marshall, unmarshall

 

Methods inherited from class java.lang.Object
equals, 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

ELT_BUSINESSKEY

public static final java.lang.String ELT_BUSINESSKEY
See Also:
Constant Field Values
Constructor Detail

RelatedBusinessInfo

public RelatedBusinessInfo(UddiElementFactory ueFactory)
Method Detail

init

public void init()
Description copied from class: UddiElement

This method is not intended for use by clients of the API.

Initalizes the element. If the element has been initalized, it re-initalizes the element so that it is as if it is a new object. This method enables object reuse.

Note on re-initalization: Reinitalization is done such that the object will be in the state as if it is a new object. It implies that all sub-elements will be discarded. If the caller wants to re-use sub-elements, it is caller's responsibility to get the sub-elements prior to re-initalization and reassign the optional sub-elements after re-initalization.

For example, A tModel contains an optional sub-element identifierBag. Hence identifierBag will be discarded. If the caller wishes to re-use the identifierBag, the caller has to get the identifierBag, re-initalize it and assign it back as the tModel's identifierBag :

   ...
   IdentifierBag identifierBag = tModel.getIdentifierBag();
   tModel.init();
   identifierBag.init();
   tModel.setIdentifierBag(identifierBag);
   ...


Access to UddiElement and its sub-structure is not guaranteed to be thread-safe.

Every subclass of UddiElement MUST overwrite init(). In the implementation, it should always invoke super.init() and intialize/reinitialize subclass-specific members. The pattern is exactly the same as a Java constructor.

Overrides:
init in class UddiElement

getTagName

public java.lang.String getTagName()
Description copied from class: UddiElement
Returns the local name of the tag of the UDDI Element.
Specified by:
getTagName in class UddiElement

getBusinessKey

public java.lang.String getBusinessKey()

setBusinessKey

public void setBusinessKey(java.lang.String businessKey)

getNameList

public java.util.List getNameList()

setNameList

public void setNameList(java.util.List listName)

setDefaultDescription

public void setDefaultDescription(java.lang.String defaultDesc)
Set the default description, i.e., the description without any language qualifier. Existing default description, if present, will be replaced.
Parameters:
defaultDesc - the default description

getFirstDescription

public java.lang.String getFirstDescription()
Return the first description string, irrespective of the language.

getDescriptionList

public java.util.List getDescriptionList()

setDescriptionList

public void setDescriptionList(java.util.List listDescription)

getFromKeySharedRelationships

public SharedRelationships getFromKeySharedRelationships()

setFromKeySharedRelationships

public void setFromKeySharedRelationships(SharedRelationships fromKeySharedRelationships)

getToKeySharedRelationships

public SharedRelationships getToKeySharedRelationships()

setToKeySharedRelationships

public void setToKeySharedRelationships(SharedRelationships toKeySharedRelationships)

Oracle Application Server Web Services UDDI Client API Reference
10g (9.0.4)

Part No. B10396-01

Copyright © 2001, 2003, Oracle. All rights reserved.