Package com.sas.metadata.remote

Interface ITChannel

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface ITChannel extends PrimaryType
A content distribution center. A channel is sort of like a mailing list. A list of subscriber entries is maintined, and new content can be published to that list. It's also a content access point that aggregates published content with a common subject or intended for a common audience.

Attributes of ITChannel are:

Associations of ITChannel are:

Usage

To create an instance of this ITChannel, use the factory create methods.
Example: create a ITChannel with name "ITChannel_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();
 ITChannel myObject = (ITChannel) factory.createComplexMetadataObject(objectStore, "ITChannel_Object", MetadataObjects.ITCHANNEL, "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_SUBJECT_NAME

      static final String ATTRIBUTE_SUBJECT_NAME
      Constant used for the name of the Subject attribute.

      Subject: Subject description for the intended content of this channel.

      See Also:

    • ATTRIBUTE_PRESENTATIONLANGUAGE_NAME

      static final String ATTRIBUTE_PRESENTATIONLANGUAGE_NAME
      Constant used for the name of the PresentationLanguage attribute.

      PresentationLanguage: Content language for this channel.

      See Also:

    • ATTRIBUTE_DELIVERYTRANSPORT_NAME

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

      DeliveryTransport: Preferred delivery mechanism for content published on this channel.

      See Also:

    • ATTRIBUTE_FREQUENCY_NAME

      static final String ATTRIBUTE_FREQUENCY_NAME
      Constant used for the name of the Frequency attribute.

      Frequency: Approximately how often content is published to this channel.

      See Also:

    • ATTRIBUTE_URL_NAME

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

      URL: URL

      See Also:

    • ATTRIBUTE_DEFAULTTRANSPORT_NAME

      static final String ATTRIBUTE_DEFAULTTRANSPORT_NAME
      Constant used for the name of the DefaultTransport attribute.

      DefaultTransport: DefaultTransport

      See Also:

    • ASSOCIATION_ARCHIVEPATHS_NAME

      static final String ASSOCIATION_ARCHIVEPATHS_NAME
      Constant used for the name of the ArchivePaths association.

      ArchivePaths: Preferred archive directory for this channel.  

      See Also:

    • ASSOCIATION_ARCHIVES_NAME

      static final String ASSOCIATION_ARCHIVES_NAME
      Constant used for the name of the Archives association.

      Archives: The archives published to by this channel.  

      See Also:

    • ASSOCIATION_CONTENTDESTINATION_NAME

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

      ContentDestination: The directory that is either a physical path or is associated to the http or ftp server where the archive should be published.  

      See Also:

    • ASSOCIATION_SUBSCRIBERGROUPS_NAME

      static final String ASSOCIATION_SUBSCRIBERGROUPS_NAME
      Constant used for the name of the SubscriberGroups association.

      SubscriberGroups: The subscriber groups for this channel.  

      See Also:

    • ASSOCIATION_CHANNELSUBSCRIPTIONS_NAME

      static final String ASSOCIATION_CHANNELSUBSCRIPTIONS_NAME
      Constant used for the name of the ChannelSubscriptions association.

      ChannelSubscriptions: The subscribers for this channel. 

      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:
      ArchivePaths
      Archives
      ContentDestination
      SubscriberGroups
      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.

    • getSubject

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

    • getSubjectState

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

    • getSubjectMaxLength

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

    • getPresentationLanguage

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

    • getPresentationLanguageState

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

    • getPresentationLanguageMaxLength

      int getPresentationLanguageMaxLength() throws RemoteException
      Gets the maximum length of PresentationLanguage
      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.

    • getFrequency

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

    • getFrequencyState

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

    • getFrequencyMaxLength

      int getFrequencyMaxLength() throws RemoteException
      Gets the maximum length of Frequency
      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.

    • getDefaultTransport

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

    • getDefaultTransportState

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

    • getDefaultTransportMaxLength

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

    • getArchivePaths

      AssociationList getArchivePaths() throws RemoteException, MdException
      Gets the AssociationList of ArchivePaths
      Returns:
      Returns the AssociationList of ArchivePaths 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.

    • getArchives

      AssociationList getArchives() throws RemoteException, MdException
      Gets the AssociationList of Archives
      Returns:
      Returns the AssociationList of Archives which can be of type:
      ArchiveFile
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the 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.

    • getSubscriberGroups

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

    • getChannelSubscriptions

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

    • getArchivePaths

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

    • getArchives

      AssociationList getArchives(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of Archives
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of Archives which can be of type:
      ArchiveFile
      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.

    • getSubscriberGroups

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

    • getChannelSubscriptions

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

    • setSubject

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

    • setSubject

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

    • setSubjectState

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

    • setPresentationLanguage

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

    • setPresentationLanguage

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

    • setPresentationLanguageState

      void setPresentationLanguageState(int state) throws RemoteException
      Sets the Metadata State of PresentationLanguage.
      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.

    • setFrequency

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

    • setFrequency

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

    • setFrequencyState

      void setFrequencyState(int state) throws RemoteException
      Sets the Metadata State of Frequency.
      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.

    • setDefaultTransport

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

    • setDefaultTransport

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

    • setDefaultTransportState

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

    • setArchivePaths

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

    • setArchivePaths

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

    • setArchives

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

    • setArchives

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

    • 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.

    • setSubscriberGroups

      void setSubscriberGroups(AssociationList list) throws RemoteException
      Sets the SubscriberGroups list to be list. Objects of which can be of type:
      Group
      SXLEMap
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setSubscriberGroups

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

    • setChannelSubscriptions

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

    • setChannelSubscriptions

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