*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.information.metadata
Interface PersonInterface

All Superinterfaces:

IdentityInterface, MetadataInterface,

All Known Implementing Classes:

AllUsersIdentity, AuthenticatedIdentity, DavPerson, LdapPerson, OMRPerson, PropertyIdentity, ReferenceIdentity, SelfIdentity, UnauthenticatedIdentity

public interface PersonInterface

extends IdentityInterface

This is a generic interface for interacting with a repository entry that represents a person.

Since:

1.0

Fields inherited from interface com.sas.services.information.metadata.MetadataInterface

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

void	addEmailAddress(String address) Add a new email address to a user's email address list.
List	getEmailAddresses() Get the user email addresses.
List	getGroups() Get a list of the groups the person is a member of.
List	getIdentityGroups() Get a List of the IdentityGroups the user is a member of.
List	getSubscribers() Get a List of the subscriber identities owned by this Person.
void	removeEmailAddress(String address) Remove an address from a user's list of email addresses.
void	setName(String name) Set the name of the user.

Methods inherited from interface com.sas.services.information.metadata.IdentityInterface

getLogins

Methods inherited from interface com.sas.services.information.metadata.MetadataInterface

add, addAccessControl, addAttribute, addAttributes, addExtension, addKeyword, addPermissions, addRemark, addTransactionListener, checkin, checkout, commit, copyTo, delete, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getDescription, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getKeywords, getModifyDate, getName, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getRemarksList, getReposId, getRepository, getRepositoryEntity, getReposKey, getTrackingId, getType, getVersion, isAuthorized, isLoggingEnabled, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setDescription, setGUID, setKeywords, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Method Detail

setName

public void setName(String name)
             throws RemoteException

Set the name of the user.

Specified by:

setName in interface MetadataInterface

Parameters:

name - The new name of the user.

Throws:

RemoteException - in the event of remote object failure.

getEmailAddresses

public List getEmailAddresses()
                       throws RemoteException

Get the user email addresses.

Returns:

A List of strings representing the user's email addresses.

Throws:

RemoteException - in the event of remote object failure.

addEmailAddress

public void addEmailAddress(String address)
                     throws RemoteException

Add a new email address to a user's email address list.

Parameters:

address - The new address to add.

Throws:

RemoteException - in the event of remote object failure.

removeEmailAddress

public void removeEmailAddress(String address)
                        throws RemoteException

Remove an address from a user's list of email addresses.

Parameters:

address - The address to remove from the user's email list.

Throws:

RemoteException - in the event of remote object failure.

getGroups

public List getGroups()
               throws RemoteException

Get a list of the groups the person is a member of.

Returns:

A List of GroupInterface objects that represent the groups this person is a member of.

Throws:

RemoteException - in the event of remote object failure.

getIdentityGroups

public List getIdentityGroups()
                       throws ServiceException,
                              RemoteException

Get a List of the IdentityGroups the user is a member of. The difference between a Group and an IdentityGroup is that Groups are just associations of any object types. IdentityGroups are groups of Identities that can be used for access control purposes.

Returns:

a List of IdentityGroupInterface objects.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

getSubscribers

public List getSubscribers()
                    throws ServiceException,
                           RemoteException

Get a List of the subscriber identities owned by this Person.

Returns:

a List of SubscriberInterface objects.

Throws:

ServiceException - if a repository error occurs.

RemoteException - in the event of remote object failure.

*** This API provides Binary Compatibility only, not Source Compatibility ***