*** This class provides Binary Compatibility only, not Source Compatibility ***

Package com.sas.services.publish.metadata

Class PackageFilter

java.lang.Object
com.sas.services.information.Filter
com.sas.services.information.metadata.KeywordFilter
com.sas.services.publish.metadata.PackageFilter
All Implemented Interfaces:
FilterInterface, Serializable
@SASScope("ALL") @BinaryCompatibilityOnly public class PackageFilter extends KeywordFilter
This class extends KeywordFilter to provide a convenient mechanism to search for package objects in multiple repository types. It allows searching on name, description, name/value pairs, the abstract, and the owning channel. Due to restrictions in the searching capabilities of the Metadata Server, only one of the abstract, channel, and name/value pairs can be searched on at once. If more than one is set, the order of preference is channel, name/value pairs and abstract. Also, exclusion on the basis of name value pairs doesn't work with the Metadata Server or a WebDAV server.
Since:
1.0
See Also:

  • Constructor Details

    • PackageFilter

      public PackageFilter()

    • PackageFilter

      public PackageFilter(String key, int relation, String value)

  • Method Details

    • includeNameValuePair

      public void includeNameValuePair(String name, String value)

    • excludeNameValuePair

      public void excludeNameValuePair(String name, String value)

    • clearNameValuePairs

      public void clearNameValuePairs()

    • getOMRType

      public String getOMRType()
      Description copied from class: Filter
      Get the OMR type. Return the type by default. subclasses may override this to return a different string. This method is mostly for use by the OMIRepository class.

      Specified by:
      getOMRType in interface FilterInterface
      Overrides:
      getOMRType in class Filter
      Returns:
      The OMR specific type to search for.

    • getLDAPType

      public String getLDAPType()

    • getDAVType

      public String getDAVType()
      Description copied from class: Filter
      Get the DAV type string. Return the type by default. Subclasses may override this to return a different string. This method is for use by the DAVRepository class.

      Specified by:
      getDAVType in interface FilterInterface
      Overrides:
      getDAVType in class Filter
      Returns:
      the DAV specific type to search for.

    • getChannel

      public ChannelInterface getChannel()

    • setChannel

      public void setChannel(ChannelInterface channel)

    • setDescription

      public void setDescription(String description, int operation)
      Add search by description.
      Parameters:
      description - The text to search for in the description.
      operation - Either FilterComponent.EQUALS or FilterComponent.CONTAINS

    • setAbstract

      public void setAbstract(String abstractString, int operation)
      Add search by abstract.
      Parameters:
      abstractString - The text to search for in the abstract.
      operation - Either FilterComponent.EQUALS or FilterComponent.CONTAINS

    • setAbstract

      public void setAbstract(List abstracts)
      Add search by abstract.
      Parameters:
      abstracts - The list of abstract strings. Each item is text to search for in the abstract. This uses the FilterComponent.CONTAINS operator since a list of Strings is used.

    • getXMLSelectString

      public String getXMLSelectString()
      Get the filter in the form of an XMLSelect statement.

      Specified by:
      getXMLSelectString in interface FilterInterface
      Overrides:
      getXMLSelectString in class KeywordFilter
      Returns:
      An XMLSelect string to pass to OMR.

    • getDAVBasicSearchString

      public String getDAVBasicSearchString()
      Description copied from class: Filter
      Get the filter in the form of a DAV basicsearch XML request. This is described in the WebDAV SEARCH proposal.

      Specified by:
      getDAVBasicSearchString in interface FilterInterface
      Overrides:
      getDAVBasicSearchString in class Filter
      Returns:
      An XML basicsearch request to pass to a DAV server.

    • getDAVSQLString

      public String getDAVSQLString()
      Description copied from class: Filter
      Get the filter in the form of a DAV SQL request. This is aimed at the Microsoft servers - Internet Information Server, SharePoint Portal Server and Exchange server.

      Specified by:
      getDAVSQLString in interface FilterInterface
      Overrides:
      getDAVSQLString in class Filter
      Returns:
      An XML DAV SQL request to pass to a DAV server.