public class

EnumMWSSearchFlags

extends Object
java.lang.Object
   ↳ com.microstrategy.webservices.EnumMWSSearchFlags

Class Overview

Defines the various flags used to control an object browse request. This enum is used as an input parameter to ExecuteBrowse, and closely mirrors the WebObjects EnumDSSXMLSearchFlags interface. This enum is designed to hold multiple values using bit ORing.

Summary

Constants
String MWSAbbreviationWildCard
String MWSBrowseAsync
String MWSDescriptionWildCard
String MWSFolderBrowseStyle
String MWSModificationTime
String MWSNameWildCard
String MWSOwnedByCurrentUser
String MWSRootRecursive
String MWSUsedByOneOf
String MWSUsedByRecursive
String MWSUsesOneOf
String MWSUsesRecursive
String MWSVisibleOnly
int _MWSAbbreviationWildCard Instructs the web service to conduct an abbreviation wild card browse.
int _MWSBrowseAsync Instructs the web service to issue browse requests asynchonously.
int _MWSDescriptionWildCard Instructs the web service to conduct a description wild card browse.
int _MWSFolderBrowseStyle Instructs the web service to conduct a browse that returns objects that satisfy the browse criteria at the search root, plus any folders that exist at the search root.
int _MWSModificationTime Instructs the web service to use modification time instead of creation time as a browse criteria.
int _MWSNameWildCard Instructs the web service to conduct an object name based wild card browse.
int _MWSOwnedByCurrentUser Instructs the web service to only return objects owned by the current logged in user.
int _MWSRootRecursive Instructs the web service to conduct a recursive browse starting at the search root.
int _MWSUsedByOneOf Instructs the web service to return objects that are used by any one of the objects specified in a collection of objects defined by one or more MWSRestrictions of type _MWSUsedByObjectID.
int _MWSUsedByRecursive Instructs the web service to return objects that are also used indirectly by objects specified in a collection of objects defined by one or more MWSRestrictions of type _MWSUsedByObjectID.
int _MWSUsesOneOf Instructs the web service to return objects that use any one of the objects specified in a collection of objects defined by one or more MWSRestrictions of type _MWSUsesObjectID.
int _MWSUsesRecursive Instructs the web service to return objects that also indirectly use objects specified in a collection of objects defined by one or more MWSRestrictions of type _MWSUsesObjectID.
int _MWSVisibleOnly Instructs the web service to return objects who are not flagged as hidden.
Public Constructors
EnumMWSSearchFlags(int iValue)
Constructs an enum using integer input.
Public Methods
int getValue()
Return the integer equivalent of the enum.
String toString()
Returns the string equivalent of the enum in the form of: "value1, value2,...".
[Expand]
Inherited Methods
From class java.lang.Object

Constants

public static final String MWSAbbreviationWildCard

Constant Value: "MWSAbbreviationWildCard"

public static final String MWSBrowseAsync

Constant Value: "MWSBrowseAsync"

public static final String MWSDescriptionWildCard

Constant Value: "MWSDescriptionWildCard"

public static final String MWSFolderBrowseStyle

Constant Value: "MWSFolderBrowseStyle"

public static final String MWSModificationTime

Constant Value: "MWSModificationTime"

public static final String MWSNameWildCard

Constant Value: "MWSNameWildCard"

public static final String MWSOwnedByCurrentUser

Constant Value: "MWSOwnedByCurrentUser"

public static final String MWSRootRecursive

Constant Value: "MWSRootRecursive"

public static final String MWSUsedByOneOf

Constant Value: "MWSUsedByOneOf"

public static final String MWSUsedByRecursive

Constant Value: "MWSUsedByRecursive"

public static final String MWSUsesOneOf

Constant Value: "MWSUsesOneOf"

public static final String MWSUsesRecursive

Constant Value: "MWSUsesRecursive"

public static final String MWSVisibleOnly

Constant Value: "MWSVisibleOnly"

public static final int _MWSAbbreviationWildCard

Instructs the web service to conduct an abbreviation wild card browse. An MWSRestriction object that defines an abbreviation wild card pattern must be part of the restriction array passed into ExecuteBrowse.

Constant Value: 1 (0x00000001)

public static final int _MWSBrowseAsync

Instructs the web service to issue browse requests asynchonously. Not part of WebObjects EnumDSSXMLSearchFlags.

Constant Value: 2048 (0x00000800)

public static final int _MWSDescriptionWildCard

Instructs the web service to conduct a description wild card browse. An MWSRestriction object that defines a description wild card pattern must be part of the restriction array passed into ExecuteBrowse.

Constant Value: 2 (0x00000002)

public static final int _MWSFolderBrowseStyle

Instructs the web service to conduct a browse that returns objects that satisfy the browse criteria at the search root, plus any folders that exist at the search root. This type of browse is only enabled when _MWSRootRecursive is also set, and an MWSRestriction of type _MWSFolderPath exists.

Constant Value: 4 (0x00000004)

public static final int _MWSModificationTime

Instructs the web service to use modification time instead of creation time as a browse criteria. This flag is enabled during browses which use MWSRestriction types of _MWSBeginTime and _MWSEndTime.

Constant Value: 8 (0x00000008)

public static final int _MWSNameWildCard

Instructs the web service to conduct an object name based wild card browse. An MWSRestriction object that defines a name wild card pattern must be part of the restriction array passed into ExecuteBrowse.

Constant Value: 16 (0x00000010)

public static final int _MWSOwnedByCurrentUser

Instructs the web service to only return objects owned by the current logged in user. Takes precedence over any owner restriction. Not part of WebObjects EnumDSSXMLSearchFlags.

Constant Value: 4096 (0x00001000)

public static final int _MWSRootRecursive

Instructs the web service to conduct a recursive browse starting at the search root. All objects in all nested folders that satisfy the criteria are returned. The behavior is different when coupled with _MWSFolderBrowseStyle.

Constant Value: 32 (0x00000020)

public static final int _MWSUsedByOneOf

Instructs the web service to return objects that are used by any one of the objects specified in a collection of objects defined by one or more MWSRestrictions of type _MWSUsedByObjectID. If this flag is not present, objects are only returned when they are used by all of the objects in the collection.

Constant Value: 64 (0x00000040)

public static final int _MWSUsedByRecursive

Instructs the web service to return objects that are also used indirectly by objects specified in a collection of objects defined by one or more MWSRestrictions of type _MWSUsedByObjectID. When this flag is not present, only objects that are used directly are returned.

Constant Value: 128 (0x00000080)

public static final int _MWSUsesOneOf

Instructs the web service to return objects that use any one of the objects specified in a collection of objects defined by one or more MWSRestrictions of type _MWSUsesObjectID. If this flag is not present, objects are only returned when they use all of the objects in the collection.

Constant Value: 256 (0x00000100)

public static final int _MWSUsesRecursive

Instructs the web service to return objects that also indirectly use objects specified in a collection of objects defined by one or more MWSRestrictions of type _MWSUsesObjectID. When this flag is not present, only objects that directly use objects in the collection are returned.

Constant Value: 512 (0x00000200)

public static final int _MWSVisibleOnly

Instructs the web service to return objects who are not flagged as hidden.

Constant Value: 1024 (0x00000400)

Public Constructors

public EnumMWSSearchFlags (int iValue)

Constructs an enum using integer input.

Parameters
iValue Integer enum value.

Public Methods

public int getValue ()

Return the integer equivalent of the enum.

Returns
  • Integer enum value.

public String toString ()

Returns the string equivalent of the enum in the form of: "value1, value2,...".

Returns
  • String enum value.