EnumMWSSearchRestriction
extends Object| java.lang.Object | |
| ↳ | com.microstrategy.webservices.EnumMWSSearchRestriction |
Class Overview
Defines search criteria that are applied to client requested browses. This enum is used to define the associated string value that accompanies it in the MWSRestriction object. This class was auto-generated from WSDL by the Apache Axis WSDL2Java emitter.
Summary
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| String | _MWSAbbreviationPattern | Instructs the web service to interpret the accompanying string as a search pattern that is to be used to restrict returned objects by their abbreviation. | |||||||||
| String | _MWSAccessRights | Instructs the web service to interpret the accompanying string as an integer value of type EnumMWSAccessRights. | |||||||||
| String | _MWSBeginTime | Instructs the web service to interpret the accompanying string as a time value that is used to define the start of time range in which objects must have been created in order to satisfy the search criteria. | |||||||||
| String | _MWSDescriptionPattern | Instructs the web service to interpret the accompanying string as a search pattern that is to be used to restrict returned objects by their description. | |||||||||
| String | _MWSEndTime | Instructs the web service to interpret the accompanying string as a time value that is used to define the end of time range in which objects must have been created in order to satisfy the search criteria. | |||||||||
| String | _MWSFolderID | Instructs the web service to interpret the accompanying string as a folder ID to be used as the root folder of an object browse. | |||||||||
| String | _MWSFolderPath | Instructs the web service to interpret the accompanying string as a folder path to be used as the root of an object browse. | |||||||||
| String | _MWSMaxResultObjects | Instructs the web service to interpret the accompanyin string as a numeric maximum limit on the number of objects that will be returned in an object browse. | |||||||||
| String | _MWSMaxWait | Instructs the web service to interpret the accompanying string as a numeric maximum limit on the number of milliseconds to wait for a synchronous browse request before returning. | |||||||||
| String | _MWSNamePattern | Instructs the web service to interpret the accompanying string as a search pattern that is to be used to restrict returned objects by their name. | |||||||||
| String | _MWSObjectOwnerID | Instructs the web service to interpret the accompanying string as an object owner's ID (DSSID) that is used to restrict returned objects by owner. | |||||||||
| String | _MWSObjectOwnerName | Instructs the web service to interpret the accompanying string as an object owner user name that is used to restrict returned objects. | |||||||||
| String | _MWSPollFrequency | Instructs the web service to interpret the accompanying string as a numeric value in milliseconds that the Web API will use to space out poll requests to the iServer, while waiting for browse results. | |||||||||
| String | _MWSUsedByObjectID | Instructs the web service to interpret the accompanying string as an object DSSID that will become part of the used by collection on the current object browse. | |||||||||
| String | _MWSUsesObjectID | Instructs the web service to interpret the accompanying string as an object DSSID that will become part of the uses collection on the current object browse. | |||||||||
| Fields | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| public static final EnumMWSSearchRestriction | MWSAbbreviationPattern | ||||||||||
| public static final EnumMWSSearchRestriction | MWSAccessRights | ||||||||||
| public static final EnumMWSSearchRestriction | MWSBeginTime | ||||||||||
| public static final EnumMWSSearchRestriction | MWSDescriptionPattern | ||||||||||
| public static final EnumMWSSearchRestriction | MWSEndTime | ||||||||||
| public static final EnumMWSSearchRestriction | MWSFolderID | ||||||||||
| public static final EnumMWSSearchRestriction | MWSFolderPath | ||||||||||
| public static final EnumMWSSearchRestriction | MWSMaxResultObjects | ||||||||||
| public static final EnumMWSSearchRestriction | MWSMaxWait | ||||||||||
| public static final EnumMWSSearchRestriction | MWSNamePattern | ||||||||||
| public static final EnumMWSSearchRestriction | MWSObjectOwnerID | ||||||||||
| public static final EnumMWSSearchRestriction | MWSObjectOwnerName | ||||||||||
| public static final EnumMWSSearchRestriction | MWSPollFrequency | ||||||||||
| public static final EnumMWSSearchRestriction | MWSUsedByObjectID | ||||||||||
| public static final EnumMWSSearchRestriction | MWSUsesObjectID | ||||||||||
| Protected Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| EnumMWSSearchRestriction(String value) | |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| boolean | equals(Object obj) | ||||||||||
| static EnumMWSSearchRestriction | fromString(String value) | ||||||||||
| static EnumMWSSearchRestriction | fromValue(String value) | ||||||||||
| String | getValue() | ||||||||||
| int | hashCode() | ||||||||||
| Object | readResolve() | ||||||||||
| String | toString() | ||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
Constants
public static final String _MWSAbbreviationPattern
Instructs the web service to interpret the accompanying string as a search pattern that is to be used to restrict returned objects by their abbreviation.
public static final String _MWSAccessRights
Instructs the web service to interpret the accompanying string as an integer value of type EnumMWSAccessRights. This value is used to restrict returned objects by access rights.
public static final String _MWSBeginTime
Instructs the web service to interpret the accompanying string as a time value that is used to define the start of time range in which objects must have been created in order to satisfy the search criteria. This restriction must be accompanied by an _MWSEndTime restriction. Object modification time is used if the associated EnumMWSSearchFlags enum has the _MWSModificationTime bit set.
public static final String _MWSDescriptionPattern
Instructs the web service to interpret the accompanying string as a search pattern that is to be used to restrict returned objects by their description.
public static final String _MWSEndTime
Instructs the web service to interpret the accompanying string as a time value that is used to define the end of time range in which objects must have been created in order to satisfy the search criteria. This restriction must be accompanied by an _MWSBeginTime restriction. Object modification time is used if the associated EnumMWSSearchFlags enum has the _MWSModificationTime bit set.
public static final String _MWSFolderID
Instructs the web service to interpret the accompanying string as a folder ID to be used as the root folder of an object browse.
public static final String _MWSFolderPath
Instructs the web service to interpret the accompanying string as a folder path to be used as the root of an object browse.
public static final String _MWSMaxResultObjects
Instructs the web service to interpret the accompanyin string as a numeric maximum limit on the number of objects that will be returned in an object browse. This limit is passed on to the iServer.
public static final String _MWSMaxWait
Instructs the web service to interpret the accompanying string as a numeric maximum limit on the number of milliseconds to wait for a synchronous browse request before returning.
public static final String _MWSNamePattern
Instructs the web service to interpret the accompanying string as a search pattern that is to be used to restrict returned objects by their name.
public static final String _MWSObjectOwnerID
Instructs the web service to interpret the accompanying string as an object owner's ID (DSSID) that is used to restrict returned objects by owner. This takes precedence over MWSObjectOwnerName.
public static final String _MWSObjectOwnerName
Instructs the web service to interpret the accompanying string as an object owner user name that is used to restrict returned objects.
public static final String _MWSPollFrequency
Instructs the web service to interpret the accompanying string as a numeric value in milliseconds that the Web API will use to space out poll requests to the iServer, while waiting for browse results.
public static final String _MWSUsedByObjectID
Instructs the web service to interpret the accompanying string as an object DSSID that will become part of the used by collection on the current object browse. Objects will be returned only if they are used by objects (defined by their DSSID) in this collection.
public static final String _MWSUsesObjectID
Instructs the web service to interpret the accompanying string as an object DSSID that will become part of the uses collection on the current object browse. Objects will be returned only if they use objects (defined by their DSSID) in this collection.
Fields
Protected Constructors
protected EnumMWSSearchRestriction (String value)
Public Methods
public boolean equals (Object obj)
public String getValue ()
public int hashCode ()
public Object readResolve ()
Throws
| ObjectStreamException |
|---|