Top Description Methods
javax.xml.registry.infomodel

public Interface Organization

extends RegistryObject
Imports
javax.xml.registry.*, java.util.*
Organization instances provide information on organizations such as a Submitting Organization. Each Organization instance may have a reference to a parent Organization. In addition it may have a contact attribute defining the primary contact within the organization. An Organization also has an address attribute.
Author
Farrukh S. Najmi
See Also
Service

Method Summary

Modifier and TypeMethod and Description
public void
addChildOrganization(Organization
the child Organization being added
organization)

Adds a child Organization.

public void
addChildOrganizations(Collection<E>
the Collection of child Organizations being added
organizations)

Adds a Collection of Organization children.

public void
addService(Service
the Service being added to this object
service)

Adds a child Service.

public void
addServices(Collection<E>
the Collection of Services being added to this object
services)

Adds a Collection of Service children.

public void
addUser(User
the User being added to this object
user)

Adds a User.

public void
addUsers(Collection<E>
the Collection of Users being added to this object
users)

Adds a Collection of Users.

public int

Returns:

the number of children Organizations
getChildOrganizationCount()

Gets number of children.

public Collection<E>

Returns:

Collection of Organization instances. The Collection may be empty but not null.
getChildOrganizations()

Gets all immediate children Organizations.

public Collection<E>

Returns:

Collection of Organization instances. The Collection may be empty but not null.
getDescendantOrganizations()

Gets all descendant Organizations.

public Organization

Returns:

the parent Organization or null if object has no parent Organization
getParentOrganization()

Gets the parent (container) organization.

public PostalAddress

Returns:

the PostalAddress for this Organization
getPostalAddress()

Gets the Address for this Organization.

public User

Returns:

the User that is the primary Contact for this Organization. Must not be null
getPrimaryContact()

Gets the primary Contact for this Organization.

public Organization

Returns:

the root Organization or null if object has no parent Organization
getRootOrganization()

Gets the root organization.

public Collection<E>

Returns:

Collection of Service instances. The Collection may be empty but not null.
getServices()

Gets all children Services.

public Collection<E>

Returns:

Collection of TelephoneNumber instances. The Collection may be empty but not null.
getTelephoneNumbers(String
a String that specifies the type of phone numbers desired
phoneType)

Gets the telephone numbers for this User that match the specified telephone number type.

public Collection<E>

Returns:

Collection of User instances. The Collection may be empty but not null.
getUsers()

Gets the Collection of Users affiliated with this Organization.

public void
removeChildOrganization(Organization
the child Organization being removed
organization)

Removes a child Organization.

public void
removeChildOrganizations(Collection<E>
the Collection of child Organizations being removed
organizations)

Removes a Collection of children Organizations.

public void
removeService(Service
the Service being removed from this object
service)

Removes a Service from this object.

public void
removeServices(Collection<E>
the Collection of Services being removed from this object
services)

Removes a Collection of children Services from this object.

public void
removeUser(User
the User being removed from this object
user)

Removes a User.

public void
removeUsers(Collection<E>
the Collection of Users being removed from this object
users)

Removes a Collection of Users.

public void
setPostalAddress(PostalAddress
the PostalAddress for this Organization
address)

Sets the address for this Organization.

public void
setPrimaryContact(User
the User that is the primary Contact for this Organization
primaryContact)

Sets the primary contact for this Organization.

public void
setTelephoneNumbers(Collection<E>
the TelephoneNumbers being set for this object
phoneNumbers)

Sets the various telephone numbers for this user.

Inherited from javax.xml.registry.infomodel.RegistryObject:
addAssociationaddAssociationsaddClassificationaddClassificationsaddExternalIdentifieraddExternalIdentifiersaddExternalLinkaddExternalLinksgetAssociatedObjectsgetAssociationsgetAuditTrailgetClassificationsgetDescriptiongetExternalIdentifiersgetExternalLinksgetKeygetLifeCycleManagergetNamegetObjectTypegetRegistryPackagesgetSubmittingOrganizationremoveAssociationremoveAssociationsremoveClassificationremoveClassificationsremoveExternalIdentifierremoveExternalIdentifiersremoveExternalLinkremoveExternalLinkssetAssociationssetClassificationssetDescriptionsetExternalIdentifierssetExternalLinkssetKeysetNametoXML

Method Detail

addChildOrganizationback to summary
public void addChildOrganization(Organization organization) throws JAXRException

Adds a child Organization.

Capability Level: 1
Parameters
organization:Organization

the child Organization being added

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addChildOrganizationsback to summary
public void addChildOrganizations(Collection<E> organizations) throws JAXRException

Adds a Collection of Organization children.

Capability Level: 1
Parameters
organizations:Collection<E>

the Collection of child Organizations being added

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addServiceback to summary
public void addService(Service service) throws JAXRException

Adds a child Service.

Capability Level: 0
Parameters
service:Service

the Service being added to this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addServicesback to summary
public void addServices(Collection<E> services) throws JAXRException

Adds a Collection of Service children.

Capability Level: 0
Parameters
services:Collection<E>

the Collection of Services being added to this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addUserback to summary
public void addUser(User user) throws JAXRException

Adds a User.

Capability Level: 0
Parameters
user:User

the User being added to this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
addUsersback to summary
public void addUsers(Collection<E> users) throws JAXRException

Adds a Collection of Users.

Capability Level: 0
Parameters
users:Collection<E>

the Collection of Users being added to this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getChildOrganizationCountback to summary
public int getChildOrganizationCount() throws JAXRException

Gets number of children.

Capability Level: 1
Returns:int

the number of children Organizations

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getChildOrganizationsback to summary
public Collection<E> getChildOrganizations() throws JAXRException

Gets all immediate children Organizations.

Capability Level: 1
Returns:Collection<E>

Collection of Organization instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.Organization
getDescendantOrganizationsback to summary
public Collection<E> getDescendantOrganizations() throws JAXRException

Gets all descendant Organizations.

Capability Level: 1
Returns:Collection<E>

Collection of Organization instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.Organization
getParentOrganizationback to summary
public Organization getParentOrganization() throws JAXRException

Gets the parent (container) organization.

Capability Level: 1
Returns:Organization

the parent Organization or null if object has no parent Organization

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getPostalAddressback to summary
public PostalAddress getPostalAddress() throws JAXRException

Gets the Address for this Organization.

Capability Level: 1
Returns:PostalAddress

the PostalAddress for this Organization

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getPrimaryContactback to summary
public User getPrimaryContact() throws JAXRException

Gets the primary Contact for this Organization. The primary contact is one of the Users of the Organization, as returned by the getUsers call on an Organization instance.

Capability Level: 0
Returns:User

the User that is the primary Contact for this Organization. Must not be null

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getRootOrganizationback to summary
public Organization getRootOrganization() throws JAXRException

Gets the root organization.

Capability Level: 1
Returns:Organization

the root Organization or null if object has no parent Organization

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getServicesback to summary
public Collection<E> getServices() throws JAXRException

Gets all children Services.

Capability Level: 0
Returns:Collection<E>

Collection of Service instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.Service
getTelephoneNumbersback to summary
public Collection<E> getTelephoneNumbers(String phoneType) throws JAXRException

Gets the telephone numbers for this User that match the specified telephone number type. If phoneType is null return all telephoneNumbers.

Capability Level: 0
Parameters
phoneType:String

a String that specifies the type of phone numbers desired

Returns:Collection<E>

Collection of TelephoneNumber instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.TelephoneNumber
getUsersback to summary
public Collection<E> getUsers() throws JAXRException

Gets the Collection of Users affiliated with this Organization. One of these users is designated as the primary contact.

Capability Level: 0
Returns:Collection<E>

Collection of User instances. The Collection may be empty but not null.

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
See Also
javax.xml.registry.infomodel.User
removeChildOrganizationback to summary
public void removeChildOrganization(Organization organization) throws JAXRException

Removes a child Organization.

Capability Level: 1
Parameters
organization:Organization

the child Organization being removed

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeChildOrganizationsback to summary
public void removeChildOrganizations(Collection<E> organizations) throws JAXRException

Removes a Collection of children Organizations.

Capability Level: 1
Parameters
organizations:Collection<E>

the Collection of child Organizations being removed

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeServiceback to summary
public void removeService(Service service) throws JAXRException

Removes a Service from this object.

Capability Level: 0
Parameters
service:Service

the Service being removed from this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeServicesback to summary
public void removeServices(Collection<E> services) throws JAXRException

Removes a Collection of children Services from this object.

Capability Level: 0
Parameters
services:Collection<E>

the Collection of Services being removed from this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeUserback to summary
public void removeUser(User user) throws JAXRException

Removes a User.

Capability Level: 0
Parameters
user:User

the User being removed from this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
removeUsersback to summary
public void removeUsers(Collection<E> users) throws JAXRException

Removes a Collection of Users.

Capability Level: 0
Parameters
users:Collection<E>

the Collection of Users being removed from this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setPostalAddressback to summary
public void setPostalAddress(PostalAddress address) throws JAXRException

Sets the address for this Organization.

Capability Level: 1
Parameters
address:PostalAddress

the PostalAddress for this Organization

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setPrimaryContactback to summary
public void setPrimaryContact(User primaryContact) throws JAXRException

Sets the primary contact for this Organization. If the primary contact is not in the existing Collection of User instances for this object then it must be added to that Collection. If the primary contact is already in the existing Collection of User instances for this object, then it should not be added to the Users collection as a duplicate entry. In either case, the primary contact is a distinguished User instance within the Collection of User instances for this Object.

Capability Level: 0
Parameters
primaryContact:User

the User that is the primary Contact for this Organization

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setTelephoneNumbersback to summary
public void setTelephoneNumbers(Collection<E> phoneNumbers) throws JAXRException

Sets the various telephone numbers for this user.

Capability Level: 0
Parameters
phoneNumbers:Collection<E>

the TelephoneNumbers being set for this object

Exceptions
JAXRException:
If the JAXR provider encounters an internal error