public interface

EnumDSSXMLSearchScope

com.microstrategy.webapi.EnumDSSXMLSearchScope

Class Overview

This interface defines the enumeration constants used to specify the search scope. This enumeration is used to specify how non-rooted searches behave with respect to managed objects.

Summary

Constants
int DssXmlSearchScopeManagedObjects Specifies that the search scope is limited to managed objects.
int DssXmlSearchScopeReserved Reserved for future use.
int DssXmlSearchScopeRootedObjects Specifies that the search scope is limited to rooted objects.
int DssXmlSearchScopeScopeAllObjects Specifies that the search scope will search all objects.
int DssXmlSearchScopeStandaloneObjects Specifies that the search scope is limited to standalone objects.
int DssXmlSearchScopeUnRootedObjects Specifies that the search scope is limited to unrooted objects.

Constants

public static final int DssXmlSearchScopeManagedObjects

Specifies that the search scope is limited to managed objects.

Constant Value: 2 (0x00000002)

public static final int DssXmlSearchScopeReserved

Reserved for future use.

Constant Value: 0 (0x00000000)

public static final int DssXmlSearchScopeRootedObjects

Specifies that the search scope is limited to rooted objects. This is the default value.

Constant Value: 4 (0x00000004)

public static final int DssXmlSearchScopeScopeAllObjects

Specifies that the search scope will search all objects.

Constant Value: 31 (0x0000001f)

public static final int DssXmlSearchScopeStandaloneObjects

Specifies that the search scope is limited to standalone objects.

Constant Value: 1 (0x00000001)

public static final int DssXmlSearchScopeUnRootedObjects

Specifies that the search scope is limited to unrooted objects.

Constant Value: 8 (0x00000008)