com.crystaldecisions.sdk.occa.report.application
Class OpenReportOptions

java.lang.Object
  extended by com.crystaldecisions.sdk.occa.report.application.OpenReportOptions

public final class OpenReportOptions
extends java.lang.Object

This object contains options that can be specified when opening a report. Use this in conjunction with the ClientDocument object's open method as the options argument.


Field Summary
static int _discardSavedData
           
static int _openAsReadOnly
           Open as read only.
static int _refreshRepositoryObjects
           Specifies whether repository objects must be updated or not when opening a report.
static int _retrieveMinimumReportDocument
           For internal use only.
static int _retrieveNoReportDefinition
           Do not retrieve the report definition.
static int _retrievePictureImage
           Retrieve all images.
static OpenReportOptions discardSavedData
           
static OpenReportOptions openAsReadOnly
           An OpenReportOptions object that specifies to open the report as read only.
static OpenReportOptions refreshRepositoryObjects
           An OpenReportOptions object that specifies whether repository objects must be updated or not when opening a report.
static OpenReportOptions retrieveMinimumReportDocument
           For internal use only.
static OpenReportOptions retrieveNoReportDefinition
           An OpenReportOptions object that specifies to not retrieve the report definition option.
static OpenReportOptions retrievePictureImage
           An OpenReportOptions object that specifies to retrieve all images.
 
Method Summary
static OpenReportOptions from_int(int val)
           Returns an OpenReportOptions object that corresponds to the specified value.
 int value()
           Returns the current value of this object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

_retrieveNoReportDefinition

public static final int _retrieveNoReportDefinition

Do not retrieve the report definition.

See Also:
Constant Field Values

_retrieveMinimumReportDocument

public static final int _retrieveMinimumReportDocument

For internal use only.

See Also:
Constant Field Values

_openAsReadOnly

public static final int _openAsReadOnly

Open as read only.

See Also:
Constant Field Values

_retrievePictureImage

public static final int _retrievePictureImage

Retrieve all images.

See Also:
Constant Field Values

_refreshRepositoryObjects

public static final int _refreshRepositoryObjects

Specifies whether repository objects must be updated or not when opening a report.

NOTE: This feature is only available when RAS is managed from BusinessObjects Enterprise.

See Also:
Constant Field Values

_discardSavedData

public static final int _discardSavedData
See Also:
Constant Field Values

retrieveNoReportDefinition

public static OpenReportOptions retrieveNoReportDefinition

An OpenReportOptions object that specifies to not retrieve the report definition option.


retrieveMinimumReportDocument

public static OpenReportOptions retrieveMinimumReportDocument

For internal use only.


openAsReadOnly

public static OpenReportOptions openAsReadOnly

An OpenReportOptions object that specifies to open the report as read only.


retrievePictureImage

public static OpenReportOptions retrievePictureImage

An OpenReportOptions object that specifies to retrieve all images.


refreshRepositoryObjects

public static OpenReportOptions refreshRepositoryObjects

An OpenReportOptions object that specifies whether repository objects must be updated or not when opening a report.


discardSavedData

public static OpenReportOptions discardSavedData
Method Detail

from_int

public static final OpenReportOptions from_int(int val)

Returns an OpenReportOptions object that corresponds to the specified value. Note, this is the same as retrieving the corresponding OpenReportOptions object defined as a field.

Parameters:
val - The value of the OpenReportOptions object you wish to retrieve.
Returns:
An OpenReportOptions object that corresponds to the specified value.

value

public int value()

Returns the current value of this object. This value reflects which options are currently specified.

Returns:
An int that specifies the current value of this object.