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

Package com.sas.services.information.metadata

Interface PersonInterface

All Superinterfaces:
IdentityInterface, MetadataInterface, PublicObjectInterface, Remote
All Known Implementing Classes:
AllUsersIdentity, AuthenticatedIdentity, DavPerson, PropertyIdentity, ReferenceIdentity, SelfIdentity, UnauthenticatedIdentity
@SASScope("ALL") @BinaryCompatibilityOnly public interface PersonInterface extends IdentityInterface
This is a generic interface for interacting with a repository entry that represents a person.

Since:
1.0

  • Method Details

    • getTitle

      String getTitle() throws ServiceException, RemoteException
      Get the Title attribute.
      Returns:
      The value of the Title attribute, or null if unset.
      Throws:
      ServiceException - If a repository error occurs.
      RemoteException - In the event of remote object failure.

    • setTitle

      void setTitle(String title) throws ServiceException, RemoteException
      Set the Person's Title.
      Parameters:
      title - The new Title for the person.
      Throws:
      ServiceException - If a repository error occurs.
      RemoteException - In the event of remote object failure.

    • getEmailAddresses

      @Deprecated List getEmailAddresses() throws ServiceException, 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.
      RemoteException - in the event of remote object failure.

    • addEmailAddress

      @Deprecated void addEmailAddress(String address) throws ServiceException, 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.
      RemoteException - in the event of remote object failure.

    • removeEmailAddress

      @Deprecated void removeEmailAddress(String address) throws ServiceException, 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.
      RemoteException - in the event of remote object failure.

    • getEmails

      List<EmailInterface> getEmails() throws ServiceException, RemoteException
      Get the user's email instances

      Returns:
      A List containing the user's email instances.
      Throws:
      ServiceException - If a service level error occurs.
      RemoteException - in the event of remote object failure.

    • addEmail

      void addEmail(EmailInterface email) throws ServiceException, 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.
      RemoteException - in the event of remote object failure.

    • removeEmail

      void removeEmail(EmailInterface email) throws ServiceException, 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.
      RemoteException - in the event of remote object failure.

    • getGroups

      List getGroups() throws ServiceException, 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.
      RemoteException - in the event of remote object failure.

    • getSubscribers

      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.

    • getLocations

      List getLocations() throws ServiceException, 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.
      RemoteException - In the event of remote object failure.

    • addLocation

      void addLocation(LocationInterface location) throws ServiceException, 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.
      RemoteException - In the event of remote object failure.

    • removeLocation

      void removeLocation(LocationInterface location) throws ServiceException, RemoteException
      Remove a location from the user's list of lcoations.
      Parameters:
      location - The location to remove.
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • getPhoneNumbers

      List getPhoneNumbers() throws ServiceException, 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.
      RemoteException - In the event of remote object failure.

    • addPhoneNumber

      void addPhoneNumber(PhoneNumberInterface phone) throws ServiceException, 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.
      RemoteException - In the event of remote object failure.

    • removePhoneNumber

      void removePhoneNumber(PhoneNumberInterface phone) throws ServiceException, RemoteException
      Remove a phone number from the user's list.
      Parameters:
      phone - The phone number to remove.
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • setInternalAccountPassword

      void setInternalAccountPassword(String password) throws ServiceException, 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.
      RemoteException - In the event of remote object failure.

    • deleteInternalAccount

      void deleteInternalAccount() throws ServiceException, RemoteException
      Delete Internal Account
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • getInternalAccountOptions

      InternalLoginUserInfo getInternalAccountOptions() throws ServiceException, RemoteException
      Return Internal Account (InternalLoginUserInfo) Options for this Person
      Throws:
      ServiceException - If a metadata error occurs.
      RemoteException - In the event of remote object failure.

    • setInternalAccountOptions

      void setInternalAccountOptions(InternalLoginUserInfo intrlLgnUsrInfo) throws ServiceException, 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.
      RemoteException - In the event of remote object failure.

    • getCreatedObjects

      List<MetadataInterface> getCreatedObjects() throws ServiceException, 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.
      RemoteException - in the event of remote object failure.

    • getModifiedObjects

      List<MetadataInterface> getModifiedObjects() throws ServiceException, 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.
      RemoteException - in the event of remote object failure.