Package com.sas.metadata.remote

Interface ITContentSubscriber

All Superinterfaces:
CMetadata, ITSubscriber, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface ITContentSubscriber extends ITSubscriber
A subscriber profile for content subscribers.

Attributes of ITContentSubscriber are:

Associations of ITContentSubscriber are:

Usage

To create an instance of this ITContentSubscriber, use the factory create methods.
Example: create a ITContentSubscriber with name "ITContentSubscriber_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();
 ITContentSubscriber myObject = (ITContentSubscriber) factory.createComplexMetadataObject(objectStore, "ITContentSubscriber_Object", MetadataObjects.ITCONTENTSUBSCRIBER, "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_ARCHIVERECEIVEBY_NAME

      static final String ATTRIBUTE_ARCHIVERECEIVEBY_NAME
      Constant used for the name of the ArchiveReceiveBy attribute.

      ArchiveReceiveBy: String containing 'value' or 'reference' instructing the publishing system to send the actual content, or just a pointer.

      See Also:

    • ATTRIBUTE_EMAILFORMAT_NAME

      static final String ATTRIBUTE_EMAILFORMAT_NAME
      Constant used for the name of the EmailFormat attribute.

      EmailFormat: String containing the value 'text' or 'html' specifying the user's preference for email formatting.

      See Also:

    • ASSOCIATION_FILTERS_NAME

      static final String ASSOCIATION_FILTERS_NAME
      Constant used for the name of the Filters association.

      Filters: The filters to apply to subscribed content. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getArchiveReceiveBy

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

    • getArchiveReceiveByState

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

    • getArchiveReceiveByMaxLength

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

    • getEmailFormat

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

    • getEmailFormatState

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

    • getEmailFormatMaxLength

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

    • getFilters

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

    • getFilters

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

    • setArchiveReceiveBy

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

    • setArchiveReceiveBy

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

    • setArchiveReceiveByState

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

    • setEmailFormat

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

    • setEmailFormat

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

    • setEmailFormatState

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

    • setFilters

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

    • setFilters

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