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

com.sas.services.information.metadata
Interface PersonInterface

All Superinterfaces:

IdentityInterface, MetadataInterface, PublicObjectInterface, java.rmi.Remote

All Known Implementing Classes:

AllUsersIdentity, AuthenticatedIdentity, DavPerson, 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

Field Summary

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

METADATA_STATE_DELETED, METADATA_STATE_DESTROYED, METADATA_STATE_NEW, METADATA_STATE_NORMAL, PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

void	addEmail(EmailInterface email) Add a new email to a user's list of email instances.
void	addEmailAddress(java.lang.String address) Deprecated. Use addEmail( EmailInterface email ) instead
void	addLocation(LocationInterface location) Add a location to the user's list of locations.
void	addPhoneNumber(PhoneNumberInterface phone) Add a phone number to the user's list.
void	deleteInternalAccount() Delete Internal Account
java.util.List<MetadataInterface>	getCreatedObjects() Returns the list of objects this person has created.
java.util.List	getEmailAddresses() Deprecated. Use getEmails() instead
java.util.List<EmailInterface>	getEmails() Get the user's email instances
java.util.List	getGroups() Get a list of the groups the person is a member of.
InternalLoginUserInfo	getInternalAccountOptions() Return Internal Account (InternalLoginUserInfo) Options for this Person
java.util.List	getLocations() Return the list of locations for the user.
java.util.List<MetadataInterface>	getModifiedObjects() Returns the list of objects this person has modified.
java.util.List	getPhoneNumbers() Get the list of phone numbers for the user.
java.util.List	getSubscribers() Get a List of the subscriber identities owned by this Person.
java.lang.String	getTitle() Get the Title attribute.
void	removeEmail(EmailInterface email) Remove an email from a user's list of email instances.
void	removeEmailAddress(java.lang.String address) Deprecated. Use removeEmail( EmailInterface email ) instead
void	removeLocation(LocationInterface location) Remove a location from the user's list of lcoations.
void	removePhoneNumber(PhoneNumberInterface phone) Remove a phone number from the user's list.
void	setInternalAccountOptions(InternalLoginUserInfo intrlLgnUsrInfo) Set Internal Account (InternalLoginUserInfo) Options for this Person
void	setInternalAccountPassword(java.lang.String password) Set Internal Account Password
void	setTitle(java.lang.String title) Set the Person's Title.

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

addLogin, getDisplayName, getEffectiveDispayName, getEffectiveDisplayName, getIdentityGroups, getIdentityMembershipLevels, getIdentityType, getLogins, getUserIds, removeLogin, setDisplayName

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

add, addAccessControl, addAttribute, addAttributes, addDocument, addExtension, addGroup, addImplementor, addKeyword, addNoteTextStore, addNoteTextStore, addObjectProperty, addObjectProperty, addPermissions, addPrompt, addPropertySet, addRemark, addResponsibleParty, addTransactionListener, addUsedByPrototype, checkin, checkout, commit, copyTo, countAssociatedObjects, delete, deleteAttribute, deleteAttributes, destroy, getAccessControls, getAttribute, getAttributes, getAuthorizationUtil, getCreateDate, getCreatedBy, getDescription, getDocuments, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getImplementors, getKeywords, getLockedBy, getModifiedBy, getModifyDate, getNoteTextStore, getNoteTextStores, getNoteTextStoresByRole, getObjectProperties, getParent, getParentPath, getParents, getPath, getPaths, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getPrimaryPropertyGroup, getPrompt, getPrompts, getPropertyBag, getPropertySets, getRemarksList, getReposId, getRepository, getRepositoryEntity, getRepositoryName, getReposKey, getResponsibleParties, getState, getTrackingId, getType, getUsageVersion, getUsedByPrototypes, getUsingPrototype, getVersion, isAuthorized, isCompatible, isDeleted, isDestroyed, isLoggingEnabled, isObjectAlive, isReadCompatible, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeDocument, removeExtension, removeGroup, removeImplementor, removeKeyword, removeNoteTextStore, removeObjectProperty, removePermissions, removePrompt, removePropertySet, removeResponsibleParty, removeResponsiblePartyByIdentity, removeUsedByPrototype, rollback, setAttribute, setAttributes, setDeleted, setDescription, setDocuments, setExtensions, setGroups, setGUID, setKeywords, setName, setNoteTextStores, setObjectProperties, setPermission, setPrimaryPropertyGroup, setPrompt, setPrompts, setRemarksList, setRepository, setUsingPrototype, startTransaction, toByteArray, transactionEvent, uncheckout, update, updateFromBag, version

Methods inherited from interface com.sas.services.information.publicobject.PublicObjectInterface

addProcessorInterface, getContainer, getIdentifier, getName, getObjectURI, getPathUrl, getProcessorInterface, getTypeDescriptor

Method Detail

getTitle

java.lang.String getTitle()
                          throws ServiceException,
                                 java.rmi.RemoteException

Get the Title attribute.

Returns:

The value of the Title attribute, or null if unset.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setTitle

void setTitle(java.lang.String title)
              throws ServiceException,
                     java.rmi.RemoteException

Set the Person's Title.

Parameters:

title - The new Title for the person.

Throws:

ServiceException - If a repository error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getEmailAddresses

@Deprecated
java.util.List getEmailAddresses()
                                 throws ServiceException,
                                        java.rmi.RemoteException

Deprecated. Use getEmails() instead

Get the user email addresses.

Returns:

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

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - in the event of remote object failure.

addEmailAddress

@Deprecated
void addEmailAddress(java.lang.String address)
                     throws ServiceException,
                            java.rmi.RemoteException

Deprecated. Use addEmail( EmailInterface email ) instead

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

Parameters:

address - The new address to add.

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - in the event of remote object failure.

removeEmailAddress

@Deprecated
void removeEmailAddress(java.lang.String address)
                        throws ServiceException,
                               java.rmi.RemoteException

Deprecated. Use removeEmail( EmailInterface email ) instead

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

Parameters:

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

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - in the event of remote object failure.

getEmails

java.util.List<EmailInterface> getEmails()
                                         throws ServiceException,
                                                java.rmi.RemoteException

Get the user's email instances

Returns:

A List containing the user's email instances.

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - in the event of remote object failure.

addEmail

void addEmail(EmailInterface email)
              throws ServiceException,
                     java.rmi.RemoteException

Add a new email to a user's list of email instances.

Parameters:

address - The new EmailInterface instance to add.

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - in the event of remote object failure.

removeEmail

void removeEmail(EmailInterface email)
                 throws ServiceException,
                        java.rmi.RemoteException

Remove an email from a user's list of email instances.

Parameters:

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

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - in the event of remote object failure.

getGroups

java.util.List getGroups()
                         throws ServiceException,
                                java.rmi.RemoteException

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

Specified by:

getGroups in interface MetadataInterface

Returns:

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

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - in the event of remote object failure.

getSubscribers

java.util.List getSubscribers()
                              throws ServiceException,
                                     java.rmi.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.

java.rmi.RemoteException - in the event of remote object failure.

getLocations

java.util.List getLocations()
                            throws ServiceException,
                                   java.rmi.RemoteException

Return the list of locations for the user. These may be valid addresses, but the description of Location in the metadata doesn't say that, so it could be just a country, etc.

Returns:

The List of locations defined for the user.

Throws:

ServiceException - If a metadata error occurs.

java.rmi.RemoteException - In the event of remote object failure.

addLocation

void addLocation(LocationInterface location)
                 throws ServiceException,
                        java.rmi.RemoteException

Add a location to the user's list of locations.

Parameters:

location - The new location to add.

Throws:

ServiceException - If a metadata error occurs.

java.rmi.RemoteException - In the event of remote object failure.

removeLocation

void removeLocation(LocationInterface location)
                    throws ServiceException,
                           java.rmi.RemoteException

Remove a location from the user's list of lcoations.

Parameters:

location - The location to remove.

Throws:

ServiceException - If a metadata error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getPhoneNumbers

java.util.List getPhoneNumbers()
                               throws ServiceException,
                                      java.rmi.RemoteException

Get the list of phone numbers for the user.

Returns:

The List of phone numbers defined for the user.

Throws:

ServiceException - If a metadata error occurs.

java.rmi.RemoteException - In the event of remote object failure.

addPhoneNumber

void addPhoneNumber(PhoneNumberInterface phone)
                    throws ServiceException,
                           java.rmi.RemoteException

Add a phone number to the user's list.

Parameters:

phone - The new phone number to add.

Throws:

ServiceException - If a metadata error occurs.

java.rmi.RemoteException - In the event of remote object failure.

removePhoneNumber

void removePhoneNumber(PhoneNumberInterface phone)
                       throws ServiceException,
                              java.rmi.RemoteException

Remove a phone number from the user's list.

Parameters:

phone - The phone number to remove.

Throws:

ServiceException - If a metadata error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setInternalAccountPassword

void setInternalAccountPassword(java.lang.String password)
                                throws ServiceException,
                                       java.rmi.RemoteException

Set Internal Account Password

Parameters:

password - The password (clear text or encoded) to be set for this Person

Throws:

ServiceException - If a metadata error occurs.

java.rmi.RemoteException - In the event of remote object failure.

deleteInternalAccount

void deleteInternalAccount()
                           throws ServiceException,
                                  java.rmi.RemoteException

Delete Internal Account

Throws:

ServiceException - If a metadata error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getInternalAccountOptions

InternalLoginUserInfo getInternalAccountOptions()
                                                throws ServiceException,
                                                       java.rmi.RemoteException

Return Internal Account (InternalLoginUserInfo) Options for this Person

Throws:

ServiceException - If a metadata error occurs.

java.rmi.RemoteException - In the event of remote object failure.

setInternalAccountOptions

void setInternalAccountOptions(InternalLoginUserInfo intrlLgnUsrInfo)
                               throws ServiceException,
                                      java.rmi.RemoteException

Set Internal Account (InternalLoginUserInfo) Options for this Person

Parameters:

phone - The InternalLoginUserInfo object containing the options to set for this InternalAccount

Throws:

ServiceException - If a metadata error occurs.

java.rmi.RemoteException - In the event of remote object failure.

getCreatedObjects

java.util.List<MetadataInterface> getCreatedObjects()
                                                    throws ServiceException,
                                                           java.rmi.RemoteException

Returns the list of objects this person has created.

Note, this can potentially be a fairly expensive request depending on how many objects the user has created.

Returns:

list of created objects

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - in the event of remote object failure.

getModifiedObjects

java.util.List<MetadataInterface> getModifiedObjects()
                                                     throws ServiceException,
                                                            java.rmi.RemoteException

Returns the list of objects this person has modified.

Note, this can potentially be a fairly expensive request depending on how many objects the user has modified.

Returns:

list of modified objects

Throws:

ServiceException - If a service level error occurs.

java.rmi.RemoteException - in the event of remote object failure.

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