Top Description Methods
javax.xml.registry.infomodel

public Interface User

extends RegistryObject
Imports
java.net.*, javax.xml.registry.*, java.util.*
User instances are RegistryObjects that are used to provide information about registered users within the registry. Users are affiliated with Organizations. User objects are used in the audit trail for a RegistryObject.
Author
Farrukh S. Najmi
See Also
Organization, AuditableEvent

Method Summary

Modifier and TypeMethod and Description
public Collection<E>

Returns:

Collection of EmailAddress instances. The Collection may be empty but not null.
getEmailAddresses()

Gets the email addresses for this User.

public Organization

Returns:

the Organization that this User is affiliated with
getOrganization()

Gets the Organization that this User is affiliated with.

public PersonName

Returns:

the name of this User
getPersonName()

Returns the name of this User.

public Collection<E>

Returns:

Collection of PostalAddress instances. The Collection may be empty but not null.
getPostalAddresses()

Gets the postal address for this User.

public Collection<E>

Returns:

Collection of TelephoneNumber instances. The Collection may be empty but not null.
getTelephoneNumbers(String
specifies the type of phone numbers to be returned. If phoneType is null, return all telephoneNumbers
phoneType)

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

public String

Returns:

the type for this User, which is an arbitrary String
getType()

Gets the type for this User.

public URL

Returns:

the URL for this User's home page
getUrl()

Gets the URL to the web page for this User.

public void
setEmailAddresses(Collection<E>
the Collection of EmailAddresses to be set
emailAddresses)

Sets the Collection of EmailAddress instances for this User.

public void
setPersonName(PersonName
the name of this User
personName)

Sets the name of this User.

public void
setPostalAddresses(Collection<E>
Is a Collection of PostAddress instances.
addresses)

Sets the addresses for this User.

public void
setTelephoneNumbers(Collection<E>
the Collection of TelephoneNumbers to be set
phoneNumbers)

Sets the various telephone numbers for this user.

public void
setType(String
the type for this User, which is an arbitrary String
type)

Sets the type for this User.

public void
setUrl(URL
the URL for this User's home page
url)

Sets the URL to the web page for this User.

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

Method Detail

getEmailAddressesback to summary
public Collection<E> getEmailAddresses() throws JAXRException

Gets the email addresses for this User.

Capability Level: 0
Returns:Collection<E>

Collection of EmailAddress 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.EmailAddress
getOrganizationback to summary
public Organization getOrganization() throws JAXRException

Gets the Organization that this User is affiliated with.

Capability Level: 0
Returns:Organization

the Organization that this User is affiliated with

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getPersonNameback to summary
public PersonName getPersonName() throws JAXRException

Returns the name of this User.

Capability Level: 0
Returns:PersonName

the name of this User

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

Gets the postal address for this User.

Capability Level: 0
Returns:Collection<E>

Collection of PostalAddress 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.PostalAddress
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.

Capability Level: 0
Parameters
phoneType:String

specifies the type of phone numbers to be returned. If phoneType is null, return all telephoneNumbers

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
getTypeback to summary
public String getType() throws JAXRException

Gets the type for this User. Default is a NULL String.

Capability Level: 0
Returns:String

the type for this User, which is an arbitrary String

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
getUrlback to summary
public URL getUrl() throws JAXRException

Gets the URL to the web page for this User.

Capability Level: 1
Returns:URL

the URL for this User's home page

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setEmailAddressesback to summary
public void setEmailAddresses(Collection<E> emailAddresses) throws JAXRException

Sets the Collection of EmailAddress instances for this User.

Capability Level: 0
Parameters
emailAddresses:Collection<E>

the Collection of EmailAddresses to be set

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setPersonNameback to summary
public void setPersonName(PersonName personName) throws JAXRException

Sets the name of this User.

Capability Level: 0
Parameters
personName:PersonName

the name of this User

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setPostalAddressesback to summary
public void setPostalAddresses(Collection<E> addresses) throws JAXRException

Sets the addresses for this User.

Capability Level: 0
Parameters
addresses:Collection<E>

Is a Collection of PostAddress instances.

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 Collection of TelephoneNumbers to be set

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setTypeback to summary
public void setType(String type) throws JAXRException

Sets the type for this User.

Capability Level: 0
Parameters
type:String

the type for this User, which is an arbitrary String

Exceptions
JAXRException:
If the JAXR provider encounters an internal error
setUrlback to summary
public void setUrl(URL url) throws JAXRException

Sets the URL to the web page for this User.

Capability Level: 1
Parameters
url:URL

the URL for this User's home page

Exceptions
JAXRException:
If the JAXR provider encounters an internal error