Package com.sas.metadata.remote

Interface Person

All Superinterfaces:
CMetadata, Identity, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Person extends Identity
This type represents the information kept about a person.

Attributes of Person are:

Associations of Person are:

Usage

To create an instance of this Person, use the factory create methods.
Example: create a Person with name "Person_Object", in repository "AAAAAAAA".
 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 Person myObject = (Person) factory.createComplexMetadataObject(objectStore, "Person_Object", MetadataObjects.PERSON, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed

Behavior

  • Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
  • When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
  • If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:
9.0

  • Field Details

    • ATTRIBUTE_TITLE_NAME

      static final String ATTRIBUTE_TITLE_NAME
      Constant used for the name of the Title attribute.

      Title: This is the persons job title.

      See Also:

    • ASSOCIATION_EMAILADDRESSES_NAME

      static final String ASSOCIATION_EMAILADDRESSES_NAME
      Constant used for the name of the EmailAddresses association.

      EmailAddresses: The list of e-mail addresses for this person.  

      See Also:

    • ASSOCIATION_LOCATIONS_NAME

      static final String ASSOCIATION_LOCATIONS_NAME
      Constant used for the name of the Locations association.

      Locations: The list of locations associated with this person.  

      See Also:

    • ASSOCIATION_PHONENUMBERS_NAME

      static final String ASSOCIATION_PHONENUMBERS_NAME
      Constant used for the name of the PhoneNumbers association.

      PhoneNumbers: The list of phone numbers for a person (or persons).  

      See Also:

    • ASSOCIATION_SUBSCRIBERIDENTITIES_NAME

      static final String ASSOCIATION_SUBSCRIBERIDENTITIES_NAME
      Constant used for the name of the SubscriberIdentities association.

      SubscriberIdentities: The subscriber profiles for this person. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface Identity
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface PrimaryType
      Specified by:
      initializeRequiredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws RemoteException
      (S) Adds the Associated objects to the predObjects which are:
      EmailAddresses
      Locations
      PhoneNumbers
      Specified by:
      initializePredObjects in interface Identity
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getTitle

      String getTitle() throws RemoteException
      Gets the String value of Title
      Returns:
      The Title
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getTitleState

      int getTitleState() throws RemoteException
      Gets the Metadata State of Title
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getTitleMaxLength

      int getTitleMaxLength() throws RemoteException
      Gets the maximum length of Title
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getEmailAddresses

      AssociationList getEmailAddresses() throws RemoteException, MdException
      Gets the AssociationList of EmailAddresses
      Returns:
      Returns the AssociationList of EmailAddresses which can be of type:
      Email
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getLocations

      AssociationList getLocations() throws RemoteException, MdException
      Gets the AssociationList of Locations
      Returns:
      Returns the AssociationList of Locations which can be of type:
      Location
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getPhoneNumbers

      AssociationList getPhoneNumbers() throws RemoteException, MdException
      Gets the AssociationList of PhoneNumbers
      Returns:
      Returns the AssociationList of PhoneNumbers which can be of type:
      Phone
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getSubscriberIdentities

      AssociationList getSubscriberIdentities() throws RemoteException, MdException
      Gets the Association list of SubscriberIdentities
      Returns:
      The AssociationList of SubscriberIdentities which can be of type:
      ITSubscriber
      ITContentSubscriber
      ITEventSubscriber
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getEmailAddresses

      AssociationList getEmailAddresses(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of EmailAddresses
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of EmailAddresses which can be of type:
      Email
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getLocations

      AssociationList getLocations(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Locations
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of Locations which can be of type:
      Location
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getPhoneNumbers

      AssociationList getPhoneNumbers(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of PhoneNumbers
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of PhoneNumbers which can be of type:
      Phone
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getSubscriberIdentities

      AssociationList getSubscriberIdentities(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of SubscriberIdentities
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the SubscriberIdentities which can be of type:
      ITSubscriber
      ITContentSubscriber
      ITEventSubscriber
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setTitle

      void setTitle(String inTitle) throws RemoteException
      Sets the Title value and sets the state to MetadataState.LOCAL.
      Parameters:
      inTitle - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setTitle

      void setTitle(String inTitle, int state) throws RemoteException
      Sets the Title Metadata State.
      Parameters:
      inTitle - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setTitleState

      void setTitleState(int state) throws RemoteException
      Sets the Metadata State of Title.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setEmailAddresses

      void setEmailAddresses(AssociationList list) throws RemoteException
      Sets the EmailAddresses list to be list. Objects of which can be of type:
      Email
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setEmailAddresses

      void setEmailAddresses(AssociationList inObjects, int state) throws RemoteException
      Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocations

      void setLocations(AssociationList list) throws RemoteException
      Sets the Locations list to be list. Objects of which can be of type:
      Location
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setLocations

      void setLocations(AssociationList inObjects, int state) throws RemoteException
      Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setPhoneNumbers

      void setPhoneNumbers(AssociationList list) throws RemoteException
      Sets the PhoneNumbers list to be list. Objects of which can be of type:
      Phone
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setPhoneNumbers

      void setPhoneNumbers(AssociationList inObjects, int state) throws RemoteException
      Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setSubscriberIdentities

      void setSubscriberIdentities(AssociationList list) throws RemoteException
      Sets the SubscriberIdentities list to be list. Objects of which can be of type:
      ITSubscriber
      ITContentSubscriber
      ITEventSubscriber
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setSubscriberIdentities

      void setSubscriberIdentities(AssociationList inObjects, int state) throws RemoteException
      Sets the entire SubscriberIdentities list to match the passed in AssociationList, sets the state of the SubscriberIdentities
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.