Package com.sas.metadata.remote

Interface Email

All Superinterfaces:
CMetadata, ContentLocation, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface Email extends ContentLocation
An e-mail address.

Attributes of Email are:

Associations of Email are:

Usage

To create an instance of this Email, use the factory create methods.
Example: create a Email with name "Email_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();
 Email myObject = (Email) factory.createComplexMetadataObject(objectStore, "Email_Object", MetadataObjects.EMAIL, "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_ADDRESS_NAME

      static final String ATTRIBUTE_ADDRESS_NAME
      Constant used for the name of the Address attribute.

      Address: The e-mail address

      See Also:

    • ATTRIBUTE_EMAILTYPE_NAME

      static final String ATTRIBUTE_EMAILTYPE_NAME
      Constant used for the name of the EmailType attribute.

      EmailType: The type of e-mail address: such as Home, Work.

      See Also:

    • ASSOCIATION_EMAILSUBSCRIBER_NAME

      static final String ASSOCIATION_EMAILSUBSCRIBER_NAME
      Constant used for the name of the EmailSubscriber association.

      EmailSubscriber: Subscriber profile that uses this email address to deliver content. 

      See Also:

    • ASSOCIATION_PERSONS_NAME

      static final String ASSOCIATION_PERSONS_NAME
      Constant used for the name of the Persons association.

      Persons: *Unknown* 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface ContentLocation
      Specified by:
      initializeRequiredObjects in interface DeployedDataPackage
      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:
      Specified by:
      initializePredObjects in interface ContentLocation
      Specified by:
      initializePredObjects in interface DeployedDataPackage
      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.

    • getAddress

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

    • getAddressState

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

    • getAddressMaxLength

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

    • getEmailType

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

    • getEmailTypeState

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

    • getEmailTypeMaxLength

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

    • getEmailSubscriber

      AssociationList getEmailSubscriber() throws RemoteException, MdException
      Gets the Association list of EmailSubscriber
      Returns:
      The AssociationList of EmailSubscriber 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.

    • getPersons

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

    • getEmailSubscriber

      AssociationList getEmailSubscriber(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of EmailSubscriber
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the EmailSubscriber 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.

    • getPersons

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

    • setAddress

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

    • setAddress

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

    • setAddressState

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

    • setEmailType

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

    • setEmailType

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

    • setEmailTypeState

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

    • setEmailSubscriber

      void setEmailSubscriber(AssociationList list) throws RemoteException
      Sets the EmailSubscriber 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.

    • setEmailSubscriber

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

    • setPersons

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

    • setPersons

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