oracle.uddi.message.datatype.business
Class BusinessEntity

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

public class BusinessEntity

extends UddiElement

General information:

This class represents an UDDI base data structure tModel, which holds descriptions of a logical entity that provides a set of web services. Depending on the business needs and context, a logical entity could be a company, a set of companies, a divison of a company, etc..

Element description:

It maps to businessEntity element, which is one of the basic UDDI data structures.

Field Summary

static java.lang.String	ATTR_AUTHORIZEDNAME
static java.lang.String	ATTR_BUSINESSKEY
static java.lang.String	ATTR_OPERATOR
static java.lang.String	ELT_NAME
static java.lang.String	UDDI_TAG

Constructor Summary

BusinessEntity(UddiElementFactory ueFactory)

Method Summary

java.lang.String	getAuthorizedName()
java.lang.String	getBusinessKey()
BusinessServices	getBusinessServices()
CategoryBag	getCategoryBag()
Contacts	getContacts()
java.util.List	getDescriptionList()
DiscoveryURLs	getDiscoveryURLs()
java.lang.String	getFirstDescription() Deprecated.
Description	getFirstDescriptionAsDescription() A convenient helper when only one description is needed.
Name	getFirstNameAsName() A convenient helper when only one name is needed.
IdentifierBag	getIdentifierBag()
java.lang.String	getName() Deprecated. retained for UDDIv1 compatibility.
java.util.List	getNameList() Returns a List of Name objects.
java.lang.String	getOperator()
java.lang.String	getTagName() Returns the local name of the tag of the UDDI Element.
void	init() This method is not intended for use by clients of the API.
void	setAuthorizedName(java.lang.String authorizedName)
void	setBusinessKey(java.lang.String businessKey)
void	setBusinessServices(BusinessServices businessServices)
void	setCategoryBag(CategoryBag categoryBag)
void	setContacts(Contacts contacts)
void	setDefaultDescription(java.lang.String defaultDesc) Deprecated. reatined for UDDIv1 compatibility
void	setDescription(java.lang.String description, java.lang.String lang) A convenient helper when only one description is needed.
void	setDescriptionList(java.util.List listDescription)
void	setDiscoveryURLs(DiscoveryURLs discoveryURLs)
void	setIdentifierBag(IdentifierBag identifierBag)
void	setName(java.lang.String name) Deprecated. retained for UDDIv1 compatibility.
void	setName(java.lang.String name, java.lang.String lang) A convenient helper when only one name is needed.
void	setNameList(java.util.List listName) Sets a List of Name objects.
void	setOperator(java.lang.String operator)

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_BUSINESSKEY

public static final java.lang.String ATTR_BUSINESSKEY

See Also:

Constant Field Values

ATTR_OPERATOR

public static final java.lang.String ATTR_OPERATOR

See Also:

Constant Field Values

ATTR_AUTHORIZEDNAME

public static final java.lang.String ATTR_AUTHORIZEDNAME

See Also:

Constant Field Values

ELT_NAME

public static final java.lang.String ELT_NAME

See Also:

Constant Field Values

Constructor Detail

BusinessEntity

public BusinessEntity(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)

getOperator

public java.lang.String getOperator()

setOperator

public void setOperator(java.lang.String operator)

getAuthorizedName

public java.lang.String getAuthorizedName()

setAuthorizedName

public void setAuthorizedName(java.lang.String authorizedName)

getDiscoveryURLs

public DiscoveryURLs getDiscoveryURLs()

setDiscoveryURLs

public void setDiscoveryURLs(DiscoveryURLs discoveryURLs)

getName

public java.lang.String getName()

Deprecated. retained for UDDIv1 compatibility.

getFirstNameAsName

public Name getFirstNameAsName()

A convenient helper when only one name is needed.

setName

public void setName(java.lang.String name)

Deprecated. retained for UDDIv1 compatibility.

setName

public void setName(java.lang.String name,
                    java.lang.String lang)

A convenient helper when only one name is needed.

getNameList

public java.util.List getNameList()

Returns a List of Name objects.

setNameList

public void setNameList(java.util.List listName)

Sets a List of Name objects.

setDefaultDescription

public void setDefaultDescription(java.lang.String defaultDesc)

Deprecated. reatined for UDDIv1 compatibility

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()

Deprecated.

Return the first description string, irrespective of the language.

getFirstDescriptionAsDescription

public Description getFirstDescriptionAsDescription()

A convenient helper when only one description is needed.

getDescriptionList

public java.util.List getDescriptionList()

setDescription

public void setDescription(java.lang.String description,
                           java.lang.String lang)

A convenient helper when only one description is needed.

setDescriptionList

public void setDescriptionList(java.util.List listDescription)

getContacts

public Contacts getContacts()

setContacts

public void setContacts(Contacts contacts)

getBusinessServices

public BusinessServices getBusinessServices()

setBusinessServices

public void setBusinessServices(BusinessServices businessServices)

getIdentifierBag

public IdentifierBag getIdentifierBag()

setIdentifierBag

public void setIdentifierBag(IdentifierBag identifierBag)

getCategoryBag

public CategoryBag getCategoryBag()

setCategoryBag

public void setCategoryBag(CategoryBag categoryBag)