com.businessobjects.rebean.wi
Interface PropertiesType

public interface PropertiesType

The PropertiesType interface is used to retrieve properties attributed to a DocumentInstance. Properties for a DocumentInstance are set and retrieved using DocumentInstance.setProperties(java.util.Properties) and DocumentInstance.getProperties().

See Also:

DocumentInstance

Field Summary

static java.lang.String	AUTHOR Retrieves the author of the property.
static java.lang.String	BASE_LOCALE Retrieves the locale in which the document was created.
static java.lang.String	DATABASE_CONNECTED_DRILL Retrieves the flag indicating if drill mode is connected to the database.
static java.lang.String	DESCRIPTION Retrieves a description of the property.
static java.lang.String	DOCUMENT_ID Retrieves the document id.
static java.lang.String	DOCUMENT_TYPE Retrieves the document type.
static java.lang.String	ENHANCED_VIEWING Retrieves the 'enhanced viewing' option.
static java.lang.String	HAS_SAMPLING_RESULTS Does the document contain at least one DataProvider with sampled data?
static java.lang.String	IS_PARTIALLY_REFRESHED Does the document contain at least one partially refreshed DataProvider?
static java.lang.String	IS_TRACK_DATA_ACTIVATED Does the track data changes feature is activated on this document?
static java.lang.String	IS_TRACK_DATA_MODE_AUTO_USED Does the reference auto updated on refresh.
static java.lang.String	KEYDATE_INPUT_MODE Retrieves the current document's keydate input mode.
static java.lang.String	KEYWORDS Retrieves the keywords of the property.
static java.lang.String	LAST_REFRESH_DATE Retrieves information regarding the last refresh date.
static java.lang.String	LAST_REFRESH_DURATION Retrieves the duration of the last refresh.
static java.lang.String	LOCALE Retrieves the locale in which DocumentInstance content will be presented.
static java.lang.String	MERGE_DIMENSION Defines a merge dimension created automatically when a queries containing ReportExpression instances defined on the same universe object, are run.
static java.lang.String	NAME Retrieves the document's name.
static java.lang.String	PREVIOUS_VERSION Retrieves the first version of the DocumentInstance.
static java.lang.String	PROMPT_KEYDATE_ONREFRESH Does the keydate should be prompted on refresh document?
static java.lang.String	QAAWS_REFERENCES Retrieves the count of web services referencing this document.
static java.lang.String	REFRESH_ON_OPEN Retrieves the 'refresh on open' option.
static java.lang.String	STRIP_QUERY
static java.lang.String	TITLE Retrieves the title of the property.
static java.lang.String	VERSION Retrieves the document version.

Field Detail

NAME

static final java.lang.String NAME

Retrieves the document's name.

See Also:

DocumentInstance.getProperties(), DocumentInstance.setProperties(java.util.Properties), Constant Field Values

DESCRIPTION

static final java.lang.String DESCRIPTION

Retrieves a description of the property.

See Also:

DocumentInstance.getProperties(), DocumentInstance.setProperties(java.util.Properties), Constant Field Values

KEYWORDS

static final java.lang.String KEYWORDS

Retrieves the keywords of the property.

See Also:

DocumentInstance.getProperties(), DocumentInstance.setProperties(java.util.Properties), Constant Field Values

TITLE

static final java.lang.String TITLE

Retrieves the title of the property.

See Also:

DocumentInstance.getProperties(), DocumentInstance.setProperties(java.util.Properties), Constant Field Values

LOCALE

static final java.lang.String LOCALE

Retrieves the locale in which DocumentInstance content will be presented.

Depending on the the Web Intelligence user's preferences, the presentation locale is either the locale the document was created in or the locale of the current user.

The String containing the DocumentInstance presentation locale consists of a lowercase language code followed underscore and an uppercase country code, for example fr_FR, fr_CA, en_US. The format is the same as the java.util.Locale interface.

See Also:

Locale, PropertiesType.BASE_LOCALE, DocumentInstance.getProperties(), DocumentInstance.setProperties(java.util.Properties), DocumentInstance.getFormattingLocale(), Constant Field Values

BASE_LOCALE

static final java.lang.String BASE_LOCALE

Retrieves the locale in which the document was created.

The String containing the DocumentInstance creation or base locale consists of a lowercase language code followed underscore and an uppercase country code, for example fr_FR, fr_CA, en_US. The format is the same as the java.util.Locale interface.

Since:

11.5

See Also:

Locale, PropertiesType.LOCALE, DocumentInstance.getProperties(), DocumentInstance.setProperties(java.util.Properties), Constant Field Values

DATABASE_CONNECTED_DRILL

static final java.lang.String DATABASE_CONNECTED_DRILL

Retrieves the flag indicating if drill mode is connected to the database.

Since:

11.5

See Also:

DocumentInstance.getProperties(), DocumentInstance.setProperties(java.util.Properties), DrillInfo, Constant Field Values

AUTHOR

static final java.lang.String AUTHOR

Retrieves the author of the property.

See Also:

DocumentInstance.getProperties(), DocumentInstance.setProperties(java.util.Properties), Constant Field Values

REFRESH_ON_OPEN

static final java.lang.String REFRESH_ON_OPEN

Retrieves the 'refresh on open' option.

See Also:

DocumentInstance.getProperties(), DocumentInstance.setProperties(java.util.Properties), Constant Field Values

STRIP_QUERY

static final java.lang.String STRIP_QUERY

Since:

12.2

See Also:

Constant Field Values

ENHANCED_VIEWING

static final java.lang.String ENHANCED_VIEWING

Retrieves the 'enhanced viewing' option.

See Also:

DocumentInstance.getProperties(), DocumentInstance.setProperties(java.util.Properties), Constant Field Values

LAST_REFRESH_DATE

static final java.lang.String LAST_REFRESH_DATE

Retrieves information regarding the last refresh date. Return the time of the last refresh in seconds from the first January 1970.

See Also:

DocumentInstance.getProperties(), Constant Field Values

LAST_REFRESH_DURATION

static final java.lang.String LAST_REFRESH_DURATION

Retrieves the duration of the last refresh.

See Also:

DocumentInstance.getProperties(), Constant Field Values

VERSION

static final java.lang.String VERSION

Retrieves the document version.

The version is returned in the following format:
<major release><minor release>. <service pack><phase>. <iteration><customer service pack>. <build number>

See Also:

DocumentInstance.getProperties(), Constant Field Values

PREVIOUS_VERSION

static final java.lang.String PREVIOUS_VERSION

Retrieves the first version of the DocumentInstance. This function will tell the version of Web Intelligence used to create this DocumentInstance.

The version is returned in the following format:
<major release><minor release>. <service pack><phase>. <iteration><customer service pack>. <build number>

See Also:

DocumentInstance.getProperties(), Constant Field Values

MERGE_DIMENSION

static final java.lang.String MERGE_DIMENSION

Defines a merge dimension created automatically when a queries containing ReportExpression instances defined on the same universe object, are run.

Since:

11.5

See Also:

DocumentInstance.getProperties(), Constant Field Values

IS_PARTIALLY_REFRESHED

static final java.lang.String IS_PARTIALLY_REFRESHED

Does the document contain at least one partially refreshed DataProvider? The value is either "true" or "false"

Since:

11.5

See Also:

DocumentInstance.getProperties(), Constant Field Values

HAS_SAMPLING_RESULTS

static final java.lang.String HAS_SAMPLING_RESULTS

Does the document contain at least one DataProvider with sampled data? The value is either "true" or "false"

Since:

12.0

See Also:

DocumentInstance.getProperties(), Constant Field Values

DOCUMENT_TYPE

static final java.lang.String DOCUMENT_TYPE

Retrieves the document type. The value is 'WID' for Webi and 'REP' for FullClient

Since:

11.5

See Also:

DocumentInstance.getProperties(), Constant Field Values

DOCUMENT_ID

static final java.lang.String DOCUMENT_ID

Retrieves the document id.

Since:

11.5

See Also:

DocumentInstance.getProperties(), Constant Field Values

IS_TRACK_DATA_ACTIVATED

static final java.lang.String IS_TRACK_DATA_ACTIVATED

Does the track data changes feature is activated on this document? The value is either "true" or "false".

Since:

12.0

See Also:

DocumentInstance.getProperties(), TrackData.setTrackDataMode(ReferenceUpdateMode), TrackData.isActive(), Constant Field Values

IS_TRACK_DATA_MODE_AUTO_USED

static final java.lang.String IS_TRACK_DATA_MODE_AUTO_USED

Does the reference auto updated on refresh. The value is either "true" or "false".

Since:

12.0

See Also:

DocumentInstance.getProperties(), TrackData.getTrackDataMode(), Constant Field Values

PROMPT_KEYDATE_ONREFRESH

static final java.lang.String PROMPT_KEYDATE_ONREFRESH

Does the keydate should be prompted on refresh document? The value is either "true" or "false".

Since:

12.0

See Also:

Constant Field Values

KEYDATE_INPUT_MODE

static final java.lang.String KEYDATE_INPUT_MODE

Retrieves the current document's keydate input mode. The values may be "lastforall" (Last available for all queries) or "paramforall" (one user defined keydate value for all queries) or "paramforeach" (each query has it's keydate value).

Since:

12.0

See Also:

Constant Field Values

QAAWS_REFERENCES

static final java.lang.String QAAWS_REFERENCES

Retrieves the count of web services referencing this document.

Since:

12.2

See Also:

Constant Field Values