Package com.sas.metadata.remote

Interface ITSubscriber

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
All Known Subinterfaces:
ITContentSubscriber, ITEventSubscriber
public interface ITSubscriber extends PrimaryType
A subscriber profile is used to control how published content is delivered to a user. Typical delivery mechanisms are mail, message queue or none. None is used by Portal users who will check the channel for new archived packages and view them on demand, rather than having them delivered at publication time.

Attributes of ITSubscriber are:

Associations of ITSubscriber are:

Usage

To create an instance of this ITSubscriber, use the factory create methods.
Example: create a ITSubscriber with name "ITSubscriber_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();
 ITSubscriber myObject = (ITSubscriber) factory.createComplexMetadataObject(objectStore, "ITSubscriber_Object", MetadataObjects.ITSUBSCRIBER, "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_QUEUENAME_NAME

      static final String ATTRIBUTE_QUEUENAME_NAME
      Constant used for the name of the QueueName attribute.

      QueueName: Message queue name for content delivery to this subscriber.

      See Also:

    • ATTRIBUTE_DELIVERYTRANSPORT_NAME

      static final String ATTRIBUTE_DELIVERYTRANSPORT_NAME
      Constant used for the name of the DeliveryTransport attribute.

      DeliveryTransport: String containing 'email', 'queue', or 'none'. Instructs the publishing system that delivery mechanism to use to deliver content to the user.

      See Also:

    • ATTRIBUTE_URL_NAME

      static final String ATTRIBUTE_URL_NAME
      Constant used for the name of the URL attribute.

      URL: A relative URL for a DAV collection to put content for this subscriber.

      See Also:

    • ASSOCIATION_CONTENTDESTINATION_NAME

      static final String ASSOCIATION_CONTENTDESTINATION_NAME
      Constant used for the name of the ContentDestination association.

      ContentDestination: The directorywhere content is published for this subscriber.  

      See Also:

    • ASSOCIATION_PROFILEOWNER_NAME

      static final String ASSOCIATION_PROFILEOWNER_NAME
      Constant used for the name of the ProfileOwner association.

      ProfileOwner: The person for whom this subscriber profile has been defined.  

      See Also:

    • ASSOCIATION_SUBSCRIBEDCHANNELS_NAME

      static final String ASSOCIATION_SUBSCRIBEDCHANNELS_NAME
      Constant used for the name of the SubscribedChannels association.

      SubscribedChannels: The channels for this subscription profile.  

      See Also:

    • ASSOCIATION_SUBSCRIBEREMAIL_NAME

      static final String ASSOCIATION_SUBSCRIBEREMAIL_NAME
      Constant used for the name of the SubscriberEmail association.

      SubscriberEmail: Email address for a content subscriber.  

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      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:
      ContentDestination
      ProfileOwner
      SubscribedChannels
      SubscriberEmail
      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.

    • getQueueName

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

    • getQueueNameState

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

    • getQueueNameMaxLength

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

    • getDeliveryTransport

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

    • getDeliveryTransportState

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

    • getDeliveryTransportMaxLength

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

    • getURL

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

    • getURLState

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

    • getURLMaxLength

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

    • getContentDestinations

      AssociationList getContentDestinations() throws RemoteException, MdException
      Gets the AssociationList of ContentDestinations
      Returns:
      Returns the AssociationList of ContentDestinations which can be of type:
      Directory
      AnalyticContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getContentDestination

      Directory getContentDestination() throws RemoteException, MdException
      Gets the Directory for ContentDestination
      Returns:
      The Directory ( null if not set) of ContentDestinationwhich can be of type:
      Directory
      AnalyticContext
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getProfileOwners

      AssociationList getProfileOwners() throws RemoteException, MdException
      Gets the AssociationList of ProfileOwners
      Returns:
      Returns the AssociationList of ProfileOwners which can be of type:
      Person
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getProfileOwner

      Person getProfileOwner() throws RemoteException, MdException
      Gets the Person for ProfileOwner
      Returns:
      The Person ( null if not set) of ProfileOwnerwhich can be of type:
      Person
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getSubscribedChannels

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

    • getSubscriberEmails

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

    • getSubscriberEmail

      Email getSubscriberEmail() throws RemoteException, MdException
      Gets the Email for SubscriberEmail
      Returns:
      The Email ( null if not set) of SubscriberEmailwhich can be of type:
      Email
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getContentDestinations

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

    • getProfileOwners

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

    • getSubscribedChannels

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

    • getSubscriberEmails

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

    • setQueueName

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

    • setQueueName

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

    • setQueueNameState

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

    • setDeliveryTransport

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

    • setDeliveryTransport

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

    • setDeliveryTransportState

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

    • setURL

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

    • setURL

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

    • setURLState

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

    • setContentDestinations

      void setContentDestinations(AssociationList list) throws RemoteException
      Sets the ContentDestinations list to be list. Object of which can be of type:
      Directory
      AnalyticContext
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setContentDestinations

      void setContentDestinations(AssociationList list, int state) throws RemoteException
      Sets the ContentDestinations list to be list. Object of which can be of type:
      Directory
      AnalyticContext
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setContentDestination

      void setContentDestination(Directory inObject) throws RemoteException
      Sets the ContentDestinations list 0th element to be inObject.
      Parameters:
      inObject - Directory
      Throws:
      RemoteException - If error communicating with remote object.

    • setProfileOwners

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

    • setProfileOwners

      void setProfileOwners(AssociationList list, int state) throws RemoteException
      Sets the ProfileOwners list to be list. Object of which can be of type:
      Person
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setProfileOwner

      void setProfileOwner(Person inObject) throws RemoteException
      Sets the ProfileOwners list 0th element to be inObject.
      Parameters:
      inObject - Person
      Throws:
      RemoteException - If error communicating with remote object.

    • setSubscribedChannels

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

    • setSubscribedChannels

      void setSubscribedChannels(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.

    • setSubscriberEmails

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

    • setSubscriberEmails

      void setSubscriberEmails(AssociationList list, int state) throws RemoteException
      Sets the SubscriberEmails list to be list. Object of which can be of type:
      Email
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setSubscriberEmail

      void setSubscriberEmail(Email inObject) throws RemoteException
      Sets the SubscriberEmails list 0th element to be inObject.
      Parameters:
      inObject - Email
      Throws:
      RemoteException - If error communicating with remote object.