Package com.microstrategy.webapi

Interface EnumDSSXMLSearchFlags

  • public interface EnumDSSXMLSearchFlags
    This interface defines the enumeration constants used to specify the miscellaneous flags used to control nature of a search for DSS Objects.
    Since:
    MicroStrategy Web 7.3.1 or earlier

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int DssXmlSearchAbbreviationWildCard
      Specifies a search flag that instructs the object server for a wildcard search on AbbreviationPattern.
      static int DssXmlSearchDereferenceShortcut
      Specifies a search flag that will dereference Shortcut during the search.
      static int DssXmlSearchDescriptionWildCard
      Specifies a search flag that instructs the object server for a wildcard search on DescriptionPattern.
      static int DssXmlSearchFolderBrowseStyle
      Specifies a search flag that instructs the object server to add the folders under the search root folder to the results regardless of other conditions, if a search root folder is set, and the search is not RootRecursive.
      static int DssXmlSearchModificationTime
      Specifies a search flag that instructs the object server to use ModificationTime, rather CreationTime, as time restriction on the search.
      static int DssXmlSearchNameWildCard
      Specifies a search flag that instructs the object server for a wildcard search on NamePattern.
      static int DssXmlSearchRootRecursive
      Specifies a search flag that instructs the object server to search subfolders of the given folders as well.
      static int DssXmlSearchUsedByOneOf
      Specifies a search flag that instructs the object server to return objects that are used by any one of the objects in the Uses collection, instead of all of the objects in the collection.
      static int DssXmlSearchUsedByRecursive
      Specifies a search flag that instructs the object server to also find objects that are used by the given objects indirectly.
      static int DssXmlSearchUsesOneOf
      Specifies a search flag that instructs the object server to return objects that use any one of the objects in the Uses collection, instead of all of the objects in the collection.
      static int DssXmlSearchUsesRecursive
      Specifies a search flag that instructs the object server to also find objects that use the given objects indirectly.
      static int DssXmlSearchVisibleOnly
      Specifies a search flag that instructs the object server to only search for objects whose Hidden property is false.

    • Field Detail

      • DssXmlSearchNameWildCard

        static final int DssXmlSearchNameWildCard
        Specifies a search flag that instructs the object server for a wildcard search on NamePattern.
        See Also:
        Constant Field Values

      • DssXmlSearchAbbreviationWildCard

        static final int DssXmlSearchAbbreviationWildCard
        Specifies a search flag that instructs the object server for a wildcard search on AbbreviationPattern.
        See Also:
        Constant Field Values

      • DssXmlSearchDescriptionWildCard

        static final int DssXmlSearchDescriptionWildCard
        Specifies a search flag that instructs the object server for a wildcard search on DescriptionPattern.
        See Also:
        Constant Field Values

      • DssXmlSearchVisibleOnly

        static final int DssXmlSearchVisibleOnly
        Specifies a search flag that instructs the object server to only search for objects whose Hidden property is false.
        See Also:
        Constant Field Values

      • DssXmlSearchUsesOneOf

        static final int DssXmlSearchUsesOneOf
        Specifies a search flag that instructs the object server to return objects that use any one of the objects in the Uses collection, instead of all of the objects in the collection.
        See Also:
        Constant Field Values

      • DssXmlSearchUsesRecursive

        static final int DssXmlSearchUsesRecursive
        Specifies a search flag that instructs the object server to also find objects that use the given objects indirectly.
        See Also:
        Constant Field Values

      • DssXmlSearchUsedByOneOf

        static final int DssXmlSearchUsedByOneOf
        Specifies a search flag that instructs the object server to return objects that are used by any one of the objects in the Uses collection, instead of all of the objects in the collection.
        See Also:
        Constant Field Values

      • DssXmlSearchUsedByRecursive

        static final int DssXmlSearchUsedByRecursive
        Specifies a search flag that instructs the object server to also find objects that are used by the given objects indirectly.
        See Also:
        Constant Field Values

      • DssXmlSearchRootRecursive

        static final int DssXmlSearchRootRecursive
        Specifies a search flag that instructs the object server to search subfolders of the given folders as well.
        See Also:
        Constant Field Values

      • DssXmlSearchModificationTime

        static final int DssXmlSearchModificationTime
        Specifies a search flag that instructs the object server to use ModificationTime, rather CreationTime, as time restriction on the search.
        See Also:
        Constant Field Values

      • DssXmlSearchFolderBrowseStyle

        static final int DssXmlSearchFolderBrowseStyle
        Specifies a search flag that instructs the object server to add the folders under the search root folder to the results regardless of other conditions, if a search root folder is set, and the search is not RootRecursive.
        See Also:
        Constant Field Values

      • DssXmlSearchDereferenceShortcut

        static final int DssXmlSearchDereferenceShortcut
        Specifies a search flag that will dereference Shortcut during the search. When this flag is set and recursive flag is set, search will dereference shortcut object, if the referenced target is folder, search will perform recursive searching into the referenced folder.
        Since:
        MicroStrategy Web 8.0.0
        See Also:
        Constant Field Values