org.apache.juddi.datatype.business
Class BusinessEntity

java.lang.Object
  org.apache.juddi.datatype.business.BusinessEntity

All Implemented Interfaces:

java.io.Serializable, RegistryObject

public class BusinessEntity
extends java.lang.Object
implements RegistryObject

"Top-level information manager for all of the information about a particular set of information related to a business unit" - technical whitepaper "Information about the party who publishes information about a service" - XML Structure Reference

Author:

Steve Viens (sviens@apache.org)

See Also:

Serialized Form

Constructor Summary

BusinessEntity()
Constructs a new BusinessEntity instance.

Method Summary

void	addBusinessService(BusinessService service) Add a business service to this business entity.
void	addCategory(KeyedReference keyref) Add a category to the categorybag of this business entity.
void	addContact(Contact contact) Add a contact to this business entity.
void	addDescription(Description descr) Adds the given description.
void	addDiscoveryURL(DiscoveryURL url) Adds a new discoveryURL to this business enitity's set of discoverURLs.
void	addIdentifier(KeyedReference keyref) Add an identifier to the identifierbag of this business entity.
void	addName(Name name) Add a name to this business entity.
java.lang.String	getAuthorizedName() Returns the authorized name of this business entity.
java.lang.String	getBusinessKey() Returns the business key of this business entity.
BusinessServices	getBusinessServices() Returns the business services of this business entity.
CategoryBag	getCategoryBag() Returns the categorybag of this business entity.
Contacts	getContacts() Returns the contacts of this business entity.
java.util.Vector	getDescriptionVector() Returns the descriptions.
DiscoveryURLs	getDiscoveryURLs() Returns the set of discoveryURLs used for finding this business entity.
IdentifierBag	getIdentifierBag() Returns the identifierbag of this business entity.
java.util.Vector	getNameVector() Returns the names of this business entity.
java.lang.String	getOperator() Returns the operator of this business entity.
void	setAuthorizedName(java.lang.String name) Sets the authorized name of this business entity to the given name.
void	setBusinessKey(java.lang.String key) Sets the business key of this business entity to the given key.
void	setBusinessServices(BusinessServices services) Sets business services to this business services list.
void	setCategoryBag(CategoryBag bag) Set the categorybag of this business entity to the given one.
void	setContacts(Contacts contacts) Set the set of contacts of this business entity to the given set.
void	setDescriptionVector(java.util.Vector descr) Sets the description list to the current one.
void	setDiscoveryURLs(DiscoveryURLs urls) Sets the collection of discoveryURLs to this business entity.
void	setIdentifierBag(IdentifierBag bag) Set the identifierbag of this business entity to the given one.
void	setNameVector(java.util.Vector names) Set the set of names of this business entity to the given set.
void	setOperator(java.lang.String operator) Sets the operator of this business entity to the given operator.

Methods inherited from class java.lang.Object

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

Constructor Detail

BusinessEntity

public BusinessEntity()

Constructs a new BusinessEntity instance.

Method Detail

setBusinessKey

public void setBusinessKey(java.lang.String key)

Sets the business key of this business entity to the given key.

Parameters:

key - The new key of this business entity.

getBusinessKey

public java.lang.String getBusinessKey()

Returns the business key of this business entity.

Returns:

The business key of this business entity.

setAuthorizedName

public void setAuthorizedName(java.lang.String name)

Sets the authorized name of this business entity to the given name.

Parameters:

name - The new authorized name of this business entity.

getAuthorizedName

public java.lang.String getAuthorizedName()

Returns the authorized name of this business entity.

Returns:

The authorized name of this business entity, or null if this business entity doesn't have an authorized name.

setOperator

public void setOperator(java.lang.String operator)

Sets the operator of this business entity to the given operator.

Parameters:

operator - The new operator of this business entity.

getOperator

public java.lang.String getOperator()

Returns the operator of this business entity.

Returns:

The operator of this business entity, or null if this business entity doesn't have an operator.

addDiscoveryURL

public void addDiscoveryURL(DiscoveryURL url)

Adds a new discoveryURL to this business enitity's set of discoverURLs. The discoveryURL is added to the end of the set. When a businessEntity is saved a new discoveryURL is generated automatically, eg, http://www.some-operator.com?businessKey=BE3D2F08-CEB3-11D3-849F-0050DA1803C0 Each time the businessEntity is saved this set is augmented with a newly generated discoveryURL.

Parameters:

url - The discoveryURL to add.

setDiscoveryURLs

public void setDiscoveryURLs(DiscoveryURLs urls)

Sets the collection of discoveryURLs to this business entity.

Parameters:

urls - The set of discoveryURLs to add.

getDiscoveryURLs

public DiscoveryURLs getDiscoveryURLs()

Returns the set of discoveryURLs used for finding this business entity.

Returns:

The set of discoveryURLs. If this business entity doesn't have a any discoveryURL, an empty enumeration is returned.

addDescription

public void addDescription(Description descr)

Adds the given description.

Parameters:

descr - The description to add.

setDescriptionVector

public void setDescriptionVector(java.util.Vector descr)

Sets the description list to the current one. Ignores any object in the collection that is not an "instanceof" the Description class.

Parameters:

descr - Collection of Description objects to set

getDescriptionVector

public java.util.Vector getDescriptionVector()

Returns the descriptions.

Returns:

the descriptions. If the aren't any descriptions, an empty enumeration is returned.

addContact

public void addContact(Contact contact)

Add a contact to this business entity.

Parameters:

contact - The contact to add.

setContacts

public void setContacts(Contacts contacts)

Set the set of contacts of this business entity to the given set.

Parameters:

contacts - The new set of contacts.

getContacts

public Contacts getContacts()

Returns the contacts of this business entity.

Returns:

The contacts of thes business entity. If this business entity doesn't have any contacts, an empty set is returned.

addName

public void addName(Name name)

Add a name to this business entity.

Parameters:

name - The Name to add.

setNameVector

public void setNameVector(java.util.Vector names)

Set the set of names of this business entity to the given set.

Parameters:

names - The new set of contacts.

getNameVector

public java.util.Vector getNameVector()

Returns the names of this business entity.

Returns:

The names of thes business entity. If this business entity doesn't have any names, an empty set is returned.

addBusinessService

public void addBusinessService(BusinessService service)

Add a business service to this business entity.

Parameters:

service - The service to add.

setBusinessServices

public void setBusinessServices(BusinessServices services)

Sets business services to this business services list.

Parameters:

services - The set of business services to add.

getBusinessServices

public BusinessServices getBusinessServices()

Returns the business services of this business entity.

Returns:

The business services of this business entity. If this business entity doesn't have any services, an empty enumeration is returned.

addIdentifier

public void addIdentifier(KeyedReference keyref)

Add an identifier to the identifierbag of this business entity.

Parameters:

keyref - The identifier to add.

setIdentifierBag

public void setIdentifierBag(IdentifierBag bag)

Set the identifierbag of this business entity to the given one.

Parameters:

bag - The new identifierbag.

getIdentifierBag

public IdentifierBag getIdentifierBag()

Returns the identifierbag of this business entity.

Returns:

The identifierbag of this business entity. If this business entity doesn't contain any identifiers, an empty bag is returned.

addCategory

public void addCategory(KeyedReference keyref)

Add a category to the categorybag of this business entity.

Parameters:

keyref - The category to add.

setCategoryBag

public void setCategoryBag(CategoryBag bag)

Set the categorybag of this business entity to the given one.

Parameters:

bag - The new categorybag.

getCategoryBag

public CategoryBag getCategoryBag()

Returns the categorybag of this business entity.

Returns:

The categorybag of this business entity. If this business entity doesn't contain any categories, an empty bag is returned.