inspireit.uddi
Class BusinessEntity

java.lang.Object
  |
  +--inspireit.uddi.BusinessEntity

All Implemented Interfaces:

java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

public class BusinessEntity

extends java.lang.Object

implements java.io.Serializable, inspireit.uddi.util.visitors.UDDIElement

BusinessEntity represents all known information about a business. From an XML standpoint, the BusinessEntity is the top-level data structure that accomodates holding descriptive information about a business or entity. Service descriptions and technical information are expressed within a BusinessEntity by a containment relationship.

Author:

Bertrand Fontaine, INSPIRE IT $Revision: 1.2 $

See Also:

Serialized Form

Field Summary

protected AuthorizedName	authorizedName Recorded name of the individual that published the BusinessEntity data.
protected BusinessKey	businessKey BusinessEntity unique identifier.
protected BusinessServices	businessServices BusinessServices available from this BusinessEntity.
protected CategoryBag	categoryBag BusinessEntity taxonomy information used to facilitate searching.
protected Contacts	contacts Optional list of contact information.
protected Descriptions	descriptions Short business descriptions (one description allowed per national language code supplied).
protected DiscoveryURLs	discoveryURLs URLs providing file based access to BusinessEntity information.
protected IdentifierBag	identifierBag BusinessEntity identification numbers used to facilitate searching.
protected Names	names BusinessEntity names.
protected Operator	operator Certified name of the UDDI registry site operator that manages the master copy of the BusinessEntity data.

Constructor Summary

BusinessEntity(BusinessKey businessKey, Name name)
BusinessEntity constructor.

BusinessEntity(BusinessKey businessKey, Names names)
BusinessEntity constructor.

BusinessEntity(Name name)
BusinessEntity constructor.

BusinessEntity(Names names)
BusinessEntity constructor.

Method Summary

void	addBusinessService(BusinessService businessService) Adds a BusinessService.
void	addContact(Contact contact) Adds some Contact information.
void	addDescription(Description description) Adds a Description.
void	addDiscoveryURL(DiscoveryURL discoveryURL) Adds a DiscoveryURL representing a web addressable (via HTTP-GET) discovery document.
void	addName(Name name) Adds a name.
boolean	equals(java.lang.Object o) Checks whether an object is equal to this BusinessEntity.
AuthorizedName	getAuthorizedName() Deprecated. as of UDDI V3.0
BusinessKey	getBusinessKey() Gets the unique BusinessEntity identifier.
BusinessServices	getBusinessServices() Gets all BusinessServices.
CategoryBag	getCategoryBag() Gets the CategoryBag used to tag BusinessEntity with specific taxonomy information (e.g. industry, product, ...) that can be used during search via find_business.
Contacts	getContacts() Gets all Contact information.
Descriptions	getDescriptions() Gets all Descriptions.
DiscoveryURLs	getDiscoveryURLs() Gets the list of URL that point to alternate, file based service discovery mechanisms.
IdentifierBag	getIdentifierBag() Gets the IdentifierBag used to record identification numbers for a BusinessEntity that can be used during search via find_business.
Names	getNames() Gets the names recorded for the businessEntity.
Operator	getOperator() Deprecated. as of UDDI V3.0
void	removeBusinessService(BusinessService businessService) Removes a BusinessService.
void	removeContact(Contact contact) Removes some Contact information.
void	removeDescription(Description description) Removes a Description.
void	removeDiscoveryURL(DiscoveryURL discoveryURL) Removes a DiscoveryURL from the list of DiscoveryURLs representing a web addressable (via HTTP-GET) discovery document.
void	removeName(Name name) Removes a name.
void	setAuthorizedName(AuthorizedName authorizedName) Deprecated. as of UDDI V3.0
void	setCategoryBag(CategoryBag categoryBag) Sets the CategoryBag used to tag BusinessEntity with specific taxonomy information (e.g. industry, product, ...) that can be used during search via find_business.
void	setIdentifierBag(IdentifierBag identifierBag) Sets the IdentifierBag used to record identification numbers for a BusinessEntity that can be used during search via find_business.
void	setOperator(Operator operator) Deprecated. as of UDDI V3.0
java.lang.Object	visit(inspireit.uddi.util.visitors.UDDIVisitor visitor)

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

businessKey

protected BusinessKey businessKey

BusinessEntity unique identifier.

authorizedName

protected AuthorizedName authorizedName

Recorded name of the individual that published the BusinessEntity data.

operator

protected Operator operator

Certified name of the UDDI registry site operator that manages the master copy of the BusinessEntity data.

discoveryURLs

protected DiscoveryURLs discoveryURLs

URLs providing file based access to BusinessEntity information.

names

protected Names names

BusinessEntity names.

descriptions

protected Descriptions descriptions

Short business descriptions (one description allowed per national language code supplied).

contacts

protected Contacts contacts

Optional list of contact information.

businessServices

protected BusinessServices businessServices

BusinessServices available from this BusinessEntity.

identifierBag

protected IdentifierBag identifierBag

BusinessEntity identification numbers used to facilitate searching.

categoryBag

protected CategoryBag categoryBag

BusinessEntity taxonomy information used to facilitate searching.

Constructor Detail

BusinessEntity

public BusinessEntity(BusinessKey businessKey,
                      Name name)

BusinessEntity constructor.

Parameters:

businessKey - BusinessEntity unique identifier.

name - BusinessEntity name (may not be blank).

BusinessEntity

public BusinessEntity(Name name)

BusinessEntity constructor.

Parameters:

name - BusinessEntity name (may not be blank).

Since:

UDDI V3.0

BusinessEntity

public BusinessEntity(BusinessKey businessKey,
                      Names names)

BusinessEntity constructor.

Parameters:

businessKey - BusinessEntity unique identifier.

names - BusinessEntity names (at least one that may not be blank).

BusinessEntity

public BusinessEntity(Names names)

BusinessEntity constructor.

Parameters:

names - BusinessEntity names (at least one that may not be blank).

Since:

UDDI V3.0

Method Detail

getBusinessKey

public BusinessKey getBusinessKey()

Gets the unique BusinessEntity identifier.

Returns:

the unique BusinessEntity identifier

getAuthorizedName

public AuthorizedName getAuthorizedName()

Deprecated. as of UDDI V3.0

Gets the recorded name of the individual that published the BusinessEntity data. This data is calculated by the controlling operator and should not be supplied within save_business operations.

Returns:

the recorded name of the individual that published the BusinessEntity data

setAuthorizedName

public void setAuthorizedName(AuthorizedName authorizedName)

Deprecated. as of UDDI V3.0

Sets the recorded name of the individual that published the BusinessEntity data. This data is calculated by the controlling operator and should not be supplied within save_business operations.

Parameters:

authorizedName - the recorded name of the individual that published the BusinessEntity data

getOperator

public Operator getOperator()

Deprecated. as of UDDI V3.0

Gets the certified name of the UDDI registry site operator that manages the master copy of the BusinessEntity data. The controlling operator records this data at the time data is saved. This data is calculated and should not be supplied with save_business operations.

Returns:

the certified name of the UDDI registry site operator that manages the master copy of the BusinessEntity data

setOperator

public void setOperator(Operator operator)

Deprecated. as of UDDI V3.0

Sets the certified name of the UDDI registry site operator that manages the master copy of the BusinessEntity data. The controlling operator records this data at the time data is saved. This data is calculated and should not be supplied with save_business operations.

Returns:

the certified name of the UDDI registry site operator that manages the master copy of the BusinessEntity data

addName

public void addName(Name name)

Adds a name.

Parameters:

name - The Name to add.

removeName

public void removeName(Name name)

Removes a name.

Parameters:

name - The Name to remove.

addDiscoveryURL

public void addDiscoveryURL(DiscoveryURL discoveryURL)

Adds a DiscoveryURL representing a web addressable (via HTTP-GET) discovery document.

Parameters:

discoveryURL - The DiscoveryURL to add.

removeDiscoveryURL

public void removeDiscoveryURL(DiscoveryURL discoveryURL)

Removes a DiscoveryURL from the list of DiscoveryURLs representing a web addressable (via HTTP-GET) discovery document.

Parameters:

discoveryURL - The DiscoveryURL to remove.

getDiscoveryURLs

public DiscoveryURLs getDiscoveryURLs()

Gets the list of URL that point to alternate, file based service discovery mechanisms. Each recorded BusinessEntity structure is automatically assigned a URL that returns the individual BusinessEntity structure. URL search is provided via find_business call.

Returns:

the list of URL that point to alternate, file based service discovery mechanisms

getNames

public Names getNames()

Gets the names recorded for the businessEntity. Name search is provided via find_business call. Names may not be blank.

Returns:

the recorded Names for the businessEntity

addDescription

public void addDescription(Description description)

Adds a Description. One Description is allowed per national language code supplied.

Parameters:

description - The Description to add.

removeDescription

public void removeDescription(Description description)

Removes a Description.

Parameters:

description - The Description to remove.

getDescriptions

public Descriptions getDescriptions()

Gets all Descriptions.

Returns:

all Descriptions

addContact

public void addContact(Contact contact)

Adds some Contact information.

Parameters:

contact - The Contact information to add.

removeContact

public void removeContact(Contact contact)

Removes some Contact information.

Parameters:

contact - The Contact information to remove.

getContacts

public Contacts getContacts()

Gets all Contact information.

Returns:

all Contact information

addBusinessService

public void addBusinessService(BusinessService businessService)

Adds a BusinessService. If no services are registered with a BusinessEntity for a period of X days, BusinessEntity data will be subject to clean-up operation.

Parameters:

businessService - The BusinessService to add.

removeBusinessService

public void removeBusinessService(BusinessService businessService)

Removes a BusinessService. If no services are registered with a BusinessEntity for a period of X days, BusinessEntity data will be subject to clean-up operation.

Parameters:

businessService - The BusinessService to remove.

getBusinessServices

public BusinessServices getBusinessServices()

Gets all BusinessServices.

Returns:

all BusinessServices

getCategoryBag

public CategoryBag getCategoryBag()

Gets the CategoryBag used to tag BusinessEntity with specific taxonomy information (e.g. industry, product, ...) that can be used during search via find_business.

Returns:

the CategoryBag information

setCategoryBag

public void setCategoryBag(CategoryBag categoryBag)

Sets the CategoryBag used to tag BusinessEntity with specific taxonomy information (e.g. industry, product, ...) that can be used during search via find_business.

Parameters:

categoryBag - The CategoryBag information.

getIdentifierBag

public IdentifierBag getIdentifierBag()

Gets the IdentifierBag used to record identification numbers for a BusinessEntity that can be used during search via find_business.

Returns:

the IdentifierBag information

setIdentifierBag

public void setIdentifierBag(IdentifierBag identifierBag)

Sets the IdentifierBag used to record identification numbers for a BusinessEntity that can be used during search via find_business.

Parameters:

identifierBag - The IdentifierBag information.

visit

public java.lang.Object visit(inspireit.uddi.util.visitors.UDDIVisitor visitor)

Specified by:

visit in interface inspireit.uddi.util.visitors.UDDIElement

equals

public boolean equals(java.lang.Object o)

Checks whether an object is equal to this BusinessEntity.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to test for equality.

Returns:

true if the object is equal to this BusinessEntity; false otherwise