|
Organization |
javax.xml.registry.infomodel |
JAXR 1.0; JWSDP 1.0, J2EE 1.4 |
|
public interface Organization extends RegistryObject {
// Property Accessor Methods (by property name)
public abstract int getChildOrganizationCount( )
throws javax.xml.registry.JAXRException; //L1
public abstract Collection getChildOrganizations( )
throws javax.xml.registry.JAXRException; //L1
public abstract Collection getDescendantOrganizations( )
throws javax.xml.registry.JAXRException; //L1
public abstract Organization getParentOrganization( )
throws javax.xml.registry.JAXRException; //L1
public abstract PostalAddress getPostalAddress( )
throws javax.xml.registry.JAXRException; //L1
public abstract void setPostalAddress(PostalAddress address)
throws javax.xml.registry.JAXRException; //L1
public abstract User getPrimaryContact( )
throws javax.xml.registry.JAXRException; //L0
public abstract void setPrimaryContact(User primaryContact)
throws javax.xml.registry.JAXRException; //L0
public abstract Organization getRootOrganization( )
throws javax.xml.registry.JAXRException; //L1
public abstract Collection getServices( )
throws javax.xml.registry.JAXRException; //L0
public abstract Collection getUsers( )
throws javax.xml.registry.JAXRException; //L0
// Public Instance Methods
public abstract void addChildOrganization(Organization organization)
throws javax.xml.registry.JAXRException; //L1
public abstract void addChildOrganizations(Collection organizations)
throws javax.xml.registry.JAXRException; //L1
public abstract void addService(javax.xml.registry.infomodel.Service service)
throws javax.xml.registry.JAXRException; //L0
public abstract void addServices(Collection services)
throws javax.xml.registry.JAXRException; //L0
public abstract void addUser(User user)
throws javax.xml.registry.JAXRException; //L0
public abstract void addUsers(Collection users)
throws javax.xml.registry.JAXRException; //L0
public abstract Collection getTelephoneNumbers(String phoneType)
throws javax.xml.registry.JAXRException; //L0
public abstract void removeChildOrganization(Organization organization)
throws javax.xml.registry.JAXRException; //L1
public abstract void removeChildOrganizations(Collection organizations)
throws javax.xml.registry.JAXRException; //L1
public abstract void removeService(javax.xml.registry.infomodel.Service service)
throws javax.xml.registry.JAXRException; //L0
public abstract void removeServices(Collection services)
throws javax.xml.registry.JAXRException; //L0
public abstract void removeUser(User user)
throws javax.xml.registry.JAXRException; //L0
public abstract void removeUsers(Collection users)
throws javax.xml.registry.JAXRException; //L0
public abstract void setTelephoneNumbers(Collection phoneNumbers)
throws javax.xml.registry.JAXRException; //L0
}
The Organization interface represents a company or
another type of provider that wants to publish details about itself
and its services in the registry. The Organization
object, an instance of which can be created by calling the
createOrganization( ) method of
LifeCycleManager, is the root from which all other
information regarding the organization can be found. Like all
RegistryObjects, it has an associated name and
description, and can have associated
Classifications that should be chosen to allow
potential clients to locate it based on searches that use criteria
that relate to its activities, along with links to external
specifications and so on. The following information can be accessed
directly from the Organization object:
- Services
-
The Service objects representing the services that
the organization wishes to publish. The getServices(
) method returns a Collection containing
all of the services, whereas addService( ),
addServices( ), removeService(
), and removeServices( ) can be used to
add to or remove from this set.
- Primary Contact
-
A User object that represents the person
responsible for maintaining the information published by the
Organization in the registry. Use the
getPrimaryContact( ) method to access this
attribute and the setPrimaryContact( ) method to
change it.
- Users
-
An additional set of Users associated with the
Organization. This set should always contain at
least the user designated as the primary contact. When the primary
contact is set, her entry is automatically included in this list.
Note that the JAXR reference implementation does not prevent
duplicate entries from appearing in this list, which can be modified
using the addUser( ), addUsers(
), removeUser( ), and
removeUsers( ) methods.
- Telephone Numbers
-
A collection of TelephoneNumbers for the
organization, manipulated as a group using the
getTelephoneNumbers( ) and
setTelephoneNumbers( ) methods.
- Postal Address
-
A postal address for the organization, set using
setPostalAddress( ) and read using
getPostalAddress( ), which are both level 1
methods. The principal address for an organization in a level 0
registry is that of the primary contact.
Level 1 registry providers allow hierarchies of
Organizations to be constructed that mirror the
business or ownership relationships between parent and subsidiary
organizations, or other business structures that should be visible to
the outside world. The addChildOrganization( ) and
addChildOrganizations( ) methods let you add
subsidiary organization nodes below their parent, while
getParentOrganization( ),
getChildOrganizations( ), and
getDescendentOrganizations( ) allow you to
traverse the hierarchy from any node or from the root, which can be
obtained by calling getRootOrganization( ) on any
of its nodes. To remove nodes, use the
removeChildOrganization( ) or
removeChildOrganizations( ) method.
Passed To
Organization.{addChildOrganization( ),
removeChildOrganization( )},
javax.xml.registry.infomodel.Service.setProvidingOrganization(
)
Returned By
javax.xml.registry.LifeCycleManager.createOrganization(
), Organization.{getParentOrganization(
), getRootOrganization( )},
RegistryObject.getSubmittingOrganization( ),
javax.xml.registry.infomodel.Service.getProvidingOrganization(
), User.getOrganization( )