Overview | Package | Class | Tree | Deprecated | Index | Help
| J2EE1.4 SDK
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## javax.xml.registry.infomodel
Interface User

All Superinterfaces:
  ExtensibleObject, RegistryObject

public interface User
extends RegistryObject

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
`java.util.Collection` | `getEmailAddresses()` Gets the email addresses for this User.
`Organization` | `getOrganization()` Gets the Organization that this User is affiliated with.
`PersonName` | `getPersonName()` Returns the name of this User.
`java.util.Collection` | `getPostalAddresses()` Gets the postal address for this User.
`java.util.Collection` | `getTelephoneNumbers(java.lang.String phoneType)` Gets the telephone numbers for this User that match the specified telephone number type.
`java.lang.String` | `getType()` Gets the type for this User.
`java.net.URL` | `getUrl()` Gets the URL to the web page for this User.
`void` | `setEmailAddresses(java.util.Collection emailAddresses)` Sets the Collection of EmailAddress instances for this User.
`void` | `setPersonName(PersonName personName)` Sets the name of this User.
`void` | `setPostalAddresses(java.util.Collection addresses)` Sets the addresses for this User.
`void` | `setTelephoneNumbers(java.util.Collection phoneNumbers)` Sets the various telephone numbers for this user.
`void` | `setType(java.lang.String type)` Sets the type for this User.
`void` | `setUrl(java.net.URL url)` Sets the URL to the web page for this User.

Methods inherited from interface javax.xml.registry.infomodel.RegistryObject
`addAssociation, addAssociations, addClassification, addClassifications, addExternalIdentifier, addExternalIdentifiers, addExternalLink, addExternalLinks, getAssociatedObjects, getAssociations, getAuditTrail, getClassifications, getDescription, getExternalIdentifiers, getExternalLinks, getKey, getLifeCycleManager, getName, getObjectType, getRegistryPackages, getSubmittingOrganization, removeAssociation, removeAssociations, removeClassification, removeClassifications, removeExternalIdentifier, removeExternalIdentifiers, removeExternalLink, removeExternalLinks, setAssociations, setClassifications, setDescription, setExternalIdentifiers, setExternalLinks, setKey, setName, toXML`

Methods inherited from interface javax.xml.registry.infomodel.ExtensibleObject
`addSlot, addSlots, getSlot, getSlots, removeSlot, removeSlots`

Method Detail

### getOrganization

    public Organization getOrganization()
                                 throws JAXRException

  Gets the Organization that this User is affiliated with.

  Capability Level: 0

  Returns:
    the Organization that this User is affiliated with
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error

### getPersonName

    public PersonName getPersonName()
                             throws JAXRException

  Returns the name of this User.

  Capability Level: 0

  Returns:
    the name of this User
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error

### setPersonName

    public void setPersonName(PersonName personName)
                       throws JAXRException

  Sets the name of this User.

  Capability Level: 0

  Parameters:
    `personName` - the name of this User
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error

### getPostalAddresses

    public java.util.Collection getPostalAddresses()
                                            throws JAXRException

  Gets the postal address for this User.

  Capability Level: 0

  Returns:
    Collection of PostalAddress instances. The Collection may be empty but not null.
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error
  See Also:
    `PostalAddress`

### setPostalAddresses

    public void setPostalAddresses(java.util.Collection addresses)
                            throws JAXRException

  Sets the addresses for this User.

  Capability Level: 0

  Parameters:
    `addresses` - Is a Collection of PostAddress instances.
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error

### getUrl

    public java.net.URL getUrl()
                        throws JAXRException

  Gets the URL to the web page for this User.

  Capability Level: 1

  Returns:
    the URL for this User's home page
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error

### setUrl

    public void setUrl(java.net.URL url)
                throws JAXRException

  Sets the URL to the web page for this User.

  Capability Level: 1

  Parameters:
    `url` - the URL for this User's home page
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error

### getTelephoneNumbers

    public java.util.Collection getTelephoneNumbers(java.lang.String phoneType)
                                             throws JAXRException

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

  Capability Level: 0

  Parameters:
    `phoneType` - specifies the type of phone numbers to be returned. If phoneType is null, return all telephoneNumbers
  Returns:
    Collection of TelephoneNumber instances. The Collection may be empty but not null.
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error
  See Also:
    `TelephoneNumber`

### setTelephoneNumbers

    public void setTelephoneNumbers(java.util.Collection phoneNumbers)
                             throws JAXRException

  Sets the various telephone numbers for this user.

  Capability Level: 0

  Parameters:
    `phoneNumbers` - the Collection of TelephoneNumbers to be set
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error

### getEmailAddresses

    public java.util.Collection getEmailAddresses()
                                           throws JAXRException

  Gets the email addresses for this User.

  Capability Level: 0

  Returns:
    Collection of EmailAddress instances. The Collection may be empty but not null.
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error
  See Also:
    `EmailAddress`

### setEmailAddresses

    public void setEmailAddresses(java.util.Collection emailAddresses)
                           throws JAXRException

  Sets the Collection of EmailAddress instances for this User.

  Capability Level: 0

  Parameters:
    `emailAddresses` - the Collection of EmailAddresses to be set
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error

### getType

    public java.lang.String getType()
                             throws JAXRException

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

  Capability Level: 0

  Returns:
    the type for this User, which is an arbitrary String
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error

### setType

    public void setType(java.lang.String type)
                 throws JAXRException

  Sets the type for this User.

  Capability Level: 0

  Parameters:
    `type` - the type for this User, which is an arbitrary String
  Throws:
    `JAXRException` - If the JAXR provider encounters an internal error

Overview | Package | Class | Tree | Deprecated | Index | Help
| J2EE1.4 SDK
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

Submit a bug or feature

Copyright 2003 Sun Microsystems, Inc. All rights reserved.