com.businessobjects.dsws.biplatform
Interface GetOptions

public interface GetOptions

Specifies the retrieval options.

See Also:

BIPlatform

Nested Class Summary

static class

GetOptions.Factory A class with methods for creating instances of the GetOptions type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

boolean	getExportDependencies() Returns whether to get additional InfoObjects that are dependencies of the InfoObjects in your query.
boolean	getIncludeSecurity() Returns whether to include security information with the returned InfoObjects.
int	getPageSize() Returns the number of InfoObjects returned in a single page.
boolean	isSetExportDependencies() Checks if the ExportDependencies has been set.
boolean	isSetIncludeSecurity() Checks if the IncludeSecurity has been set.
boolean	isSetPageSize() Checks if the PageSize has been set.
void	setExportDependencies(boolean exportDependencies) Sets whether to get additional InfoObjects that are dependencies of the InfoObjects in your query.
void	setIncludeSecurity(boolean includeSecurity) Sets whether to include security information with the returned InfoObjects.
void	setPageSize(int pageSize) Sets the number of InfoObjects returned in a single page.
void	unsetExportDependencies() Deletes or unsets the ExportDependencies element.
void	unsetIncludeSecurity() Deletes or unsets the IncludeSecurity element.
void	unsetPageSize() Deletes or unsets the PageSize element.
org.apache.xmlbeans.XmlBoolean	xgetExportDependencies() Internal Use Only.
org.apache.xmlbeans.XmlBoolean	xgetIncludeSecurity() Internal Use Only.
org.apache.xmlbeans.XmlInt	xgetPageSize() Internal Use Only.
void	xsetExportDependencies(org.apache.xmlbeans.XmlBoolean exportDependencies) Internal Use Only.
void	xsetIncludeSecurity(org.apache.xmlbeans.XmlBoolean includeSecurity) Internal Use Only.
void	xsetPageSize(org.apache.xmlbeans.XmlInt pageSize) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getExportDependencies

boolean getExportDependencies()

Returns whether to get additional InfoObjects that are dependencies of the InfoObjects in your query.

Set this property only if you have specified dependent objects in your query. For example, you want to get both a report and the universe associated with it.

The default value is false.

Returns:

exportDependencies true if you want to get additional InfoObjects that are dependencies of the InfoObjects in your query, false otherwise.

xgetExportDependencies

org.apache.xmlbeans.XmlBoolean xgetExportDependencies()

Internal Use Only.

isSetExportDependencies

boolean isSetExportDependencies()

Checks if the ExportDependencies has been set.

Returns:

true if the ExportDependencies element has been set,otherwise false.

setExportDependencies

void setExportDependencies(boolean exportDependencies)

Sets whether to get additional InfoObjects that are dependencies of the InfoObjects in your query.

Set this property only if you have specified dependent objects in your query. For example, you want to get both a report and the universe associated with it.

The default value is false.

Parameters:

exportDependencies - true if you want to get additional InfoObjects that are dependencies of the InfoObjects in your query, false otherwise.

xsetExportDependencies

void xsetExportDependencies(org.apache.xmlbeans.XmlBoolean exportDependencies)

Internal Use Only.

unsetExportDependencies

void unsetExportDependencies()

Deletes or unsets the ExportDependencies element.

getIncludeSecurity

boolean getIncludeSecurity()

Returns whether to include security information with the returned InfoObjects.

The default value is false.

Returns:

includeSecurity true if you want to include security information with the returned InfoObjects, false otherwise.

xgetIncludeSecurity

org.apache.xmlbeans.XmlBoolean xgetIncludeSecurity()

Internal Use Only.

isSetIncludeSecurity

boolean isSetIncludeSecurity()

Checks if the IncludeSecurity has been set.

Returns:

true if the IncludeSecurity element has been set,otherwise false.

setIncludeSecurity

void setIncludeSecurity(boolean includeSecurity)

Sets whether to include security information with the returned InfoObjects.

The default value is false.

Parameters:

includeSecurity - true if you want to include security information with the returned InfoObjects, false otherwise.

xsetIncludeSecurity

void xsetIncludeSecurity(org.apache.xmlbeans.XmlBoolean includeSecurity)

Internal Use Only.

unsetIncludeSecurity

void unsetIncludeSecurity()

Deletes or unsets the IncludeSecurity element.

getPageSize

int getPageSize()

Returns the number of InfoObjects returned in a single page.

Returns:

The number of InfoObjects returned in a single page.

xgetPageSize

org.apache.xmlbeans.XmlInt xgetPageSize()

Internal Use Only.

isSetPageSize

boolean isSetPageSize()

Checks if the PageSize has been set.

Returns:

true if the PageSize element has been set,otherwise false.

setPageSize

void setPageSize(int pageSize)

Sets the number of InfoObjects returned in a single page.

If this property is not specified, then the defaultpagesize value in the dsws.properties file will be used.

Parameters:

pageSize - The number of InfoObjects returned in a single page.

xsetPageSize

void xsetPageSize(org.apache.xmlbeans.XmlInt pageSize)

Internal Use Only.

unsetPageSize

void unsetPageSize()

Deletes or unsets the PageSize element.