Package com.sas.metadata.remote

Interface ITFilter

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType
public interface ITFilter extends SecondaryType
A filter string is used to include or exclude content going to a specific subscriber. It can be used to filter entries in a package, or the entire package.

Attributes of ITFilter are:

Associations of ITFilter are:

Usage

To create an instance of this ITFilter, use the factory create methods.
Example: create a ITFilter with name "ITFilter_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();
 ITFilter myObject = (ITFilter) factory.createComplexMetadataObject(objectStore, "ITFilter_Object", MetadataObjects.ITFILTER, "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_FILTERSTRING_NAME

      static final String ATTRIBUTE_FILTERSTRING_NAME
      Constant used for the name of the FilterString attribute.

      FilterString: Filter string to control content delivered to specific subscriber identities.

      See Also:

    • ATTRIBUTE_FILTERROLE_NAME

      static final String ATTRIBUTE_FILTERROLE_NAME
      Constant used for the name of the FilterRole attribute.

      FilterRole: The role this filter plays in the subscriber definition. Valid values are: NameValueInclusionFilter NameValueExclusionFilter EntryInclusionFilter EntryExclusionFilter FileMIMETypeInclusionFilter FileMIMETypeExclusionFilter

      See Also:

    • ASSOCIATION_FILTERSUBSCRIBER_NAME

      static final String ASSOCIATION_FILTERSUBSCRIBER_NAME
      Constant used for the name of the FilterSubscriber association.

      FilterSubscriber: The subscriber that uses this content filter.  

      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 Root
      Specified by:
      initializeRequiredObjects in interface SecondaryType
      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:
      FilterSubscriber
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface SecondaryType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getFilterString

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

    • getFilterStringState

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

    • getFilterStringMaxLength

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

    • getFilterRole

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

    • getFilterRoleState

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

    • getFilterRoleMaxLength

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

    • getFilterSubscribers

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

    • getFilterSubscriber

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

    • getFilterSubscribers

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

    • setFilterString

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

    • setFilterString

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

    • setFilterStringState

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

    • setFilterRole

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

    • setFilterRole

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

    • setFilterRoleState

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

    • setFilterSubscribers

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

    • setFilterSubscribers

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

    • setFilterSubscriber

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