public interface

EnumDSSXMLSessionFlags

com.microstrategy.webapi.EnumDSSXMLSessionFlags

Class Overview

This interface defines the enumeration constants used to specify the session flags about how to manage Inbox in 3-tier or 4-tier mode.

Summary

Constants
int DssXmlSessionBypassClustering Specifies a session flag to direct the API to ignore load balancing when creating the session.
int DssXmlSessionCancelActiveJobsOnClose Specifies a session flag to cancel all active jobs when the session is closed.
int DssXmlSessionChangePwdOnCreate Specifies a session flag to change password upon session creation.
int DssXmlSessionCheckWebCache Specifies a session flag to check the Web server cache first before running this report against the server.
int DssXmlSessionDeleteReadMsgsOnClose Specifies a session flag to delete all read messages when session is closed.
int DssXmlSessionDeleteUnreadMsgsOnClose Specifies a session flag to delete all unread messages when session is closed.
int DssXmlSessionFBAppLogin
int DssXmlSessionKeepPromptJobOnClose Specifies a session flag to not cancel waiting-for-prompt and saved-in-history-list jobs when closing the session
int DssXmlSessionPreserveFlags Specifies a session flag to preserve the session flags on the creation of the current session and do not overwrite them when session is closed.
int DssXmlSessionUseWebCacheOnly Specifies a session flag to use the Web server cache only or return error if the cache is not found.

Constants

public static final int DssXmlSessionBypassClustering

Specifies a session flag to direct the API to ignore load balancing when creating the session. This flag is typically not used and can have performance implications, hence use it with care.

Constant Value: 512 (0x00000200)

public static final int DssXmlSessionCancelActiveJobsOnClose

Specifies a session flag to cancel all active jobs when the session is closed.

Constant Value: 1 (0x00000001)

public static final int DssXmlSessionChangePwdOnCreate

Specifies a session flag to change password upon session creation.

Constant Value: 4096 (0x00001000)

public static final int DssXmlSessionCheckWebCache

Specifies a session flag to check the Web server cache first before running this report against the server.

Constant Value: 1048576 (0x00100000)

public static final int DssXmlSessionDeleteReadMsgsOnClose

Specifies a session flag to delete all read messages when session is closed.

Constant Value: 16 (0x00000010)

public static final int DssXmlSessionDeleteUnreadMsgsOnClose

Specifies a session flag to delete all unread messages when session is closed.

Constant Value: 256 (0x00000100)

public static final int DssXmlSessionFBAppLogin

Constant Value: 268435456 (0x10000000)

public static final int DssXmlSessionKeepPromptJobOnClose

Specifies a session flag to not cancel waiting-for-prompt and saved-in-history-list jobs when closing the session

Constant Value: 2 (0x00000002)

public static final int DssXmlSessionPreserveFlags

Specifies a session flag to preserve the session flags on the creation of the current session and do not overwrite them when session is closed.

Constant Value: 65536 (0x00010000)

public static final int DssXmlSessionUseWebCacheOnly

Specifies a session flag to use the Web server cache only or return error if the cache is not found.

Constant Value: 2097152 (0x00200000)