javax.xml.registry.infomodel.User Maven / Gradle / Ivy
The newest version!
/*
* The contents of this file are subject to the terms
* of the Common Development and Distribution License
* (the License). You may not use this file except in
* compliance with the License.
*
* You can obtain a copy of the license at
* https://glassfish.dev.java.net/public/CDDLv1.0.html or
* glassfish/bootstrap/legal/CDDLv1.0.txt.
* See the License for the specific language governing
* permissions and limitations under the License.
*
* When distributing Covered Code, include this CDDL
* Header Notice in each file and include the License file
* at glassfish/bootstrap/legal/CDDLv1.0.txt.
* If applicable, add the following below the CDDL Header,
* with the fields enclosed by brackets [] replaced by
* you own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
*
* Copyright 2007 Sun Microsystems, Inc. All rights reserved.
*/
package javax.xml.registry.infomodel;
import java.net.*;
import javax.xml.registry.*;
import 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.
*
* @see Organization
* @see AuditableEvent
* @author Farrukh S. Najmi
*/
public interface User extends RegistryObject {
/**
* Gets the Organization that this User is affiliated with.
*
*
* - Capability Level: 0
*
* @return the Organization that this User is affiliated with
* @throws JAXRException If the JAXR provider encounters an internal error
*
* @supplierCardinality 1
* @associates <{Organization}>
* @directed
* @supplierRole affiliatedWith
* @clientCardinality 1..*
*/
Organization getOrganization() throws JAXRException;
/**
* Returns the name of this User.
*
* - Capability Level: 0
*
* @return the name of this User
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public PersonName getPersonName() throws JAXRException;
/**
* Sets the name of this User.
*
* - Capability Level: 0
*
* @param personName the name of this User
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public void setPersonName(PersonName personName) throws JAXRException;
/**
* Gets the postal address for this User.
*
* - Capability Level: 0
*
* @see javax.xml.registry.infomodel.PostalAddress
* @return Collection of PostalAddress instances. The Collection may be empty but not null.
* @throws JAXRException If the JAXR provider encounters an internal error
*
*
* @supplierCardinality 1
* @associates <{PostalAddress}>
* @directed
* @supplierRole addresses
* @clientCardinality 1..*
*/
public Collection getPostalAddresses() throws JAXRException;
/**
* Sets the addresses for this User.
*
* - Capability Level: 0
*
* @param addresses Is a Collection of PostAddress instances.
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
void setPostalAddresses(Collection addresses) throws JAXRException;
/**
* Gets the URL to the web page for this User.
*
* - Capability Level: 1
*
* @return the URL for this User's home page
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public URL getUrl() throws JAXRException;
/**
* Sets the URL to the web page for this User.
*
* - Capability Level: 1
*
* @param url the URL for this User's home page
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public void setUrl(URL url) throws JAXRException;
/**
* Gets the telephone numbers for this User that match the specified telephone number type.
*
*
* - Capability Level: 0
*
* @see javax.xml.registry.infomodel.TelephoneNumber
* @return Collection of TelephoneNumber instances. The Collection may be empty but not null.
* @param phoneType specifies the type of phone numbers to be returned. If phoneType is null, return all telephoneNumbers
* @throws JAXRException If the JAXR provider encounters an internal error
*
* @supplierCardinality 1
* @associates <{TelephoneNumber}>
* @directed
* @supplierRole phones
* @clientCardinality 1..*
*/
public Collection getTelephoneNumbers(String phoneType) throws JAXRException;
/**
* Sets the various telephone numbers for this user.
*
* - Capability Level: 0
*
* @param phoneNumbers the Collection of TelephoneNumbers to be set
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public void setTelephoneNumbers(Collection phoneNumbers) throws JAXRException;
/**
* Gets the email addresses for this User.
*
* - Capability Level: 0
*
* @see javax.xml.registry.infomodel.EmailAddress
* @return Collection of EmailAddress instances. The Collection may be empty but not null.
* @throws JAXRException If the JAXR provider encounters an internal error
*
*
* @supplierCardinality 1
* @associates <{EmailAddress}>
* @directed
* @supplierRole emailAddresses
* @clientCardinality 0..*
*/
public Collection getEmailAddresses() throws JAXRException;
/**
* Sets the Collection of EmailAddress instances for this User.
*
* - Capability Level: 0
*
* @param emailAddresses the Collection of EmailAddresses to be set
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public void setEmailAddresses(Collection emailAddresses) throws JAXRException;
/**
* Gets the type for this User.
* Default is a NULL String.
*
* - Capability Level: 0
*
* @return the type for this User, which is an arbitrary String
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public String getType() throws JAXRException;
/**
* Sets the type for this User.
*
* - Capability Level: 0
*
* @param type the type for this User, which is an arbitrary String
* @throws JAXRException If the JAXR provider encounters an internal error
*
*/
public void setType(String type) throws JAXRException;
}