oracle.uddi.message.datatype.business
Class Address

java.lang.Object
  |
  +--oracle.uddi.message.UddiElement
        |
        +--oracle.uddi.message.datatype.business.Address

public class Address

extends UddiElement

General information:

This class represents an element within the UDDI API schema

Element description:

It maps to address element, used by businessEntity to refer to free form address related to a business. Typing and sorting are both done by convention.

Field Summary

static java.lang.String	ATTR_SORTCODE
static java.lang.String	ATTR_TMODELKEY
static java.lang.String	ATTR_USETYPE
static java.lang.String	ELT_ADDRESS_LINE
static java.lang.String	UDDI_TAG

Constructor Summary

Address(UddiElementFactory ueFactory)

Method Summary

java.util.List	getAddressLineList() This method returns a List of Strings which represent the address lines for this address.
java.util.List	getAddressLines() This method returns a List of AddressLine objects which represent the address lines for this address, including keyName and keyValue metadata.
java.lang.String	getSortCode()
java.lang.String	getTagName() Returns the local name of the tag of the UDDI Element.
java.lang.String	getTModelKey()
java.lang.String	getUseType()
void	init() This method is not intended for use by clients of the API.
void	setAddressLineList(java.util.List listAddressLineStrings) This method sets a List of Strings which represent the address lines for this address.
void	setAddressLines(java.util.List listAddressLine) This method sets a List of AddressLine objects which represent the address lines for this address, including keyName and keyValue metadata.
void	setSortCode(java.lang.String sortCode)
void	setTModelKey(java.lang.String tModelKey)
void	setUseType(java.lang.String useType)

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

ATTR_USETYPE

public static final java.lang.String ATTR_USETYPE

See Also:

Constant Field Values

ATTR_SORTCODE

public static final java.lang.String ATTR_SORTCODE

See Also:

Constant Field Values

ATTR_TMODELKEY

public static final java.lang.String ATTR_TMODELKEY

See Also:

Constant Field Values

ELT_ADDRESS_LINE

public static final java.lang.String ELT_ADDRESS_LINE

See Also:

Constant Field Values

Constructor Detail

Address

public Address(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

getAddressLines

public java.util.List getAddressLines()

This method returns a List of AddressLine objects which represent the address lines for this address, including keyName and keyValue metadata. This method is UDDI version-2 specific, and will throw a VersionMismatchException if called on a UDDI version 1 element.

getAddressLineList

public java.util.List getAddressLineList()

This method returns a List of Strings which represent the address lines for this address. If this is called on a UDDI version 2 element, the version 2-specific keyName and keyValue metadata is lost while returning plain Strings. Note: This method should be used to get address line information in UDDI v1 elements. It is to be considered deprecated in UDDI v2, although it will still work (and lose metadata).

setAddressLines

public void setAddressLines(java.util.List listAddressLine)

This method sets a List of AddressLine objects which represent the address lines for this address, including keyName and keyValue metadata. This method is UDDI version-2 specific, and will throw a VersionMismatchException if called on a UDDI version 1 element.

setAddressLineList

public void setAddressLineList(java.util.List listAddressLineStrings)

This method sets a List of Strings which represent the address lines for this address. If this is called on a UDDI version 2 element, the version 2-specific keyName and keyValue metadata is not provided, and therefore is not remembered. Note: This method should be used to set address line information in UDDI v1 elements. It is to be considered deprecated in UDDI v2, although it will still work (and lose metadata).

getUseType

public java.lang.String getUseType()

setUseType

public void setUseType(java.lang.String useType)

getSortCode

public java.lang.String getSortCode()

setSortCode

public void setSortCode(java.lang.String sortCode)

getTModelKey

public java.lang.String getTModelKey()

setTModelKey

public void setTModelKey(java.lang.String tModelKey)