com.crystaldecisions.sdk.plugin.admin.reportappserveradmin
Interface IReportAppServerAdmin

Deprecated. As of version 12.0. See the BusinessObjects Enterprise SDK Java Developer Guide for information on how to programmatically perform server administration tasks using the new Server Intelligence framework.

public interface IReportAppServerAdmin

The IReportAppServerAdmin interface allows you to perform a number of Report Application Server (RAS) tasks. For example, you can limit the number of records that will be retrieved from the database or determine how long a user can be inactive before the server will time out. Furthermore, you can also view the metrics for a particular RAS server.

Method Summary

void	commit() Deprecated. As of version 12.0.
int	getAgentTimeoutMins() Deprecated. As of version 12.0.
boolean	getAutoDBDisconnect() Deprecated. As of version 12.0.
int	getCurrentAgentCount() Deprecated. As of version 12.0.
int	getCurrentDocumentCount() Deprecated. As of version 12.0.
boolean	getEnableAsyncQuery() Deprecated. As of version 12.0.
boolean	getEnablePushDownGroupBy() Deprecated. As of version 12.0.
boolean	getEnableSelectDistinctRecords() Deprecated. As of version 12.0.
int	getMaxNumOfRecords() Deprecated. As of version 12.0.
int	getMaxReportJobs() Deprecated. As of version 12.0.
int	getMinutesBetweenDBRefresh() Deprecated. As of version 12.0.
int	getNumOfBrowsingRecords() Deprecated. As of version 12.0.
int	getRowsetBatchSize() Deprecated. As of version 12.0.
int	getTotalAgentCount() Deprecated. As of version 12.0.
int	getTotalDocumentCount() Deprecated. As of version 12.0.
boolean	getUseInprocAgent() Deprecated. As of version 12.0.
boolean	isAutoDBDisconnect() Deprecated. As of version 12.0.
boolean	isEnableAsyncQuery() Deprecated. As of version 12.0.
boolean	isEnablePushDownGroupBy() Deprecated. As of version 12.0.
boolean	isEnableSelectDistinctRecords() Deprecated. As of version 12.0.
boolean	isUseInprocAgent() Deprecated. As of version 12.0.
void	setAgentTimeoutMins(int val) Deprecated. As of version 12.0.
void	setAutoDBDisconnect(boolean val) Deprecated. As of version 12.0.
void	setEnableAsyncQuery(boolean val) Deprecated. As of version 12.0.
void	setEnablePushDownGroupBy(boolean val) Deprecated. As of version 12.0.
void	setEnableSelectDistinctRecords(boolean val) Deprecated. As of version 12.0.
void	setMaxNumOfRecords(int val) Deprecated. As of version 12.0.
void	setMaxReportJobs(int val) Deprecated. As of version 12.0.
void	setMinutesBetweenDBRefresh(int val) Deprecated. As of version 12.0.
void	setNumOfBrowsingRecords(int val) Deprecated. As of version 12.0.
void	setRowsetBatchSize(int val) Deprecated. As of version 12.0.
void	setUseInprocAgent(boolean val) Deprecated. As of version 12.0.

Method Detail

getAutoDBDisconnect

boolean getAutoDBDisconnect()
                            throws SDKException

Deprecated. As of version 12.0.

Report job automatically disconnects from database when all records have been retrieved.

Returns:

A boolean indicating if automatic disconnect is in use

Throws:

SDKException - This is thrown if the process is unsuccessful

isAutoDBDisconnect

boolean isAutoDBDisconnect()
                           throws SDKException

Deprecated. As of version 12.0.

Report job automatically disconnects from database when all records have been retrieved.

Returns:

A boolean indicating if automatic disconnect is in use

Throws:

SDKException - This is thrown if the process is unsuccessful

setAutoDBDisconnect

void setAutoDBDisconnect(boolean val)
                         throws SDKException

Deprecated. As of version 12.0.

Report job automatically disconnects from database when all records have been retrieved.

Parameters:

val - A boolean indicating if automatic disconnect should be used

Throws:

SDKException - This is thrown if the process is unsuccessful

getAgentTimeoutMins

int getAgentTimeoutMins()
                        throws SDKException

Deprecated. As of version 12.0.

The number of minutes of idle time before a server agent times out.

Returns:

An int indicating timeout value in minutes

Throws:

SDKException - This is thrown if the process is unsuccessful

setAgentTimeoutMins

void setAgentTimeoutMins(int val)
                         throws SDKException

Deprecated. As of version 12.0.

The number of minutes of idle time before a server agent times out.

Parameters:

val - An int indicating timeout value in minutes to set

Throws:

SDKException - This is thrown if the process is unsuccessful

getEnableAsyncQuery

boolean getEnableAsyncQuery()
                            throws SDKException

Deprecated. As of version 12.0.

Returns True if the program uses asynchronous queries and False otherwise.

Returns:

A boolean indicating whether or not the program uses asynchronous queries

Throws:

SDKException - This is thrown if the process is unsuccessful

isEnableAsyncQuery

boolean isEnableAsyncQuery()
                           throws SDKException

Deprecated. As of version 12.0.

Returns True if the program uses asynchronous queries and False otherwise.

Returns:

A boolean indicating whether or not the program uses asynchronous queries

Throws:

SDKException - This is thrown if the process is unsuccessful

setEnableAsyncQuery

void setEnableAsyncQuery(boolean val)
                         throws SDKException

Deprecated. As of version 12.0.

Indicate to server whether or not the program uses asynchronous queries.

Parameters:

val - A boolean indicating whether or not asynchronous queries should be used

Throws:

SDKException - This is thrown if the process is unsuccessful

getEnablePushDownGroupBy

boolean getEnablePushDownGroupBy()
                                 throws SDKException

Deprecated. As of version 12.0.

Returns True if the program performs grouping on the server (server-side processing) and False otherwise.

Returns:

A boolean indicating whether or not grouping is used on the server

Throws:

SDKException - This is thrown if the process is unsuccessful

isEnablePushDownGroupBy

boolean isEnablePushDownGroupBy()
                                throws SDKException

Deprecated. As of version 12.0.

Returns True if the program performs grouping on the server (server-side processing) and False otherwise.

Returns:

A boolean indicating whether or not grouping is used on the server

Throws:

SDKException - This is thrown if the process is unsuccessful

setEnablePushDownGroupBy

void setEnablePushDownGroupBy(boolean val)
                              throws SDKException

Deprecated. As of version 12.0.

Indicate to the server whether or not grouping should be used.

Parameters:

val - A boolean indicating whether or not grouping should be used on the server

Throws:

SDKException - This is thrown if the process is unsuccessful

getEnableSelectDistinctRecords

boolean getEnableSelectDistinctRecords()
                                       throws SDKException

Deprecated. As of version 12.0.

Returns True if, in the report, only unique records are being selected from the SQL tables in your database and False otherwise.

Returns:

A boolean indicating whether or not reports only select unique records from SQL tables

Throws:

SDKException - This is thrown if the process is unsuccessful

isEnableSelectDistinctRecords

boolean isEnableSelectDistinctRecords()
                                      throws SDKException

Deprecated. As of version 12.0.

Returns True if, in the report, only unique records are being selected from the SQL tables in your database and False otherwise.

Returns:

A boolean indicating whether or not reports only select unique records from SQL tables

Throws:

SDKException - This is thrown if the process is unsuccessful

setEnableSelectDistinctRecords

void setEnableSelectDistinctRecords(boolean val)
                                    throws SDKException

Deprecated. As of version 12.0.

Indicate to the server whether or not reports only select unique records from SQL tables.

Parameters:

val - A boolean indicating whether reports only select unique records from SQL tables.

Throws:

SDKException - This is thrown if the process is unsuccessful

getMaxNumOfRecords

int getMaxNumOfRecords()
                       throws SDKException

Deprecated. As of version 12.0.

The specified maximum number of records.

Returns:

An int indicating the maximum number of records.

Throws:

SDKException - This is thrown if the process is unsuccessful

setMaxNumOfRecords

void setMaxNumOfRecords(int val)
                        throws SDKException

Deprecated. As of version 12.0.

Specifies the maximum number of records.

Parameters:

val - An int indicating the maximum number of records.

Throws:

SDKException - This is thrown if the process is unsuccessful

getMaxReportJobs

int getMaxReportJobs()
                     throws SDKException

Deprecated. As of version 12.0.

The specified maximum number of jobs.

Returns:

An int indicating the maximum number of jobs.

Throws:

SDKException - This is thrown if the process is unsuccessful

setMaxReportJobs

void setMaxReportJobs(int val)
                      throws SDKException

Deprecated. As of version 12.0.

Specifies the maximum number of jobs.

Parameters:

val - An int indicating the maximum number of jobs.

Throws:

SDKException - This is thrown if the process is unsuccessful

getMinutesBetweenDBRefresh

int getMinutesBetweenDBRefresh()
                               throws SDKException

Deprecated. As of version 12.0.

The oldest processed data given to a client in minutes.

Returns:

An int indicating the oldest processed data given to a client in minutes.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setMinutesBetweenDBRefresh

void setMinutesBetweenDBRefresh(int val)
                                throws SDKException

Deprecated. As of version 12.0.

Specifies the oldest processed data given to a client in minutes.

Parameters:

val - An int indicating the oldest processed data given to a client in minutes.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getNumOfBrowsingRecords

int getNumOfBrowsingRecords()
                            throws SDKException

Deprecated. As of version 12.0.

The specified number of browsing records.

Returns:

An int indicating the number of browsing records.

Throws:

SDKException - This is thrown if the process is unsuccessful

setNumOfBrowsingRecords

void setNumOfBrowsingRecords(int val)
                             throws SDKException

Deprecated. As of version 12.0.

Specifies the number of browsing records.

Parameters:

val - An int indicating the number of browsing records.

Throws:

SDKException - This is thrown if the process is unsuccessful

getRowsetBatchSize

int getRowsetBatchSize()
                       throws SDKException

Deprecated. As of version 12.0.

The specified size of rowset batch.

Returns:

An int indicating the size of rowset batch.

Throws:

SDKException - This is thrown if the process is unsuccessful

setRowsetBatchSize

void setRowsetBatchSize(int val)
                        throws SDKException

Deprecated. As of version 12.0.

Specifies the size of rowset batch.

Parameters:

val - An int indicating the size of rowset batch.

Throws:

SDKException - This is thrown if the process is unsuccessful

getUseInprocAgent

boolean getUseInprocAgent()
                          throws SDKException

Deprecated. As of version 12.0.

Returns True if the server is using an inproc agent.

Returns:

A boolean indicating whether or not the server is using an inproc agent.

Throws:

SDKException - This is thrown if the process is unsuccessful

isUseInprocAgent

boolean isUseInprocAgent()
                         throws SDKException

Deprecated. As of version 12.0.

Returns True if the server is using an inproc agent.

Returns:

A boolean indicating whether or not the server is using an inproc agent.

Throws:

SDKException - This is thrown if the process is unsuccessful

setUseInprocAgent

void setUseInprocAgent(boolean val)
                       throws SDKException

Deprecated. As of version 12.0.

Indicate to the server whether an inproc agent should be used.

Parameters:

val - A boolean indicating whether or not an inproc agent should be used.

Throws:

SDKException - This is thrown if the process is unsuccessful

getCurrentAgentCount

int getCurrentAgentCount()
                         throws SDKException

Deprecated. As of version 12.0.

Returns the number of agent threads running.

Returns:

An int indicating the number of agent threads running

Throws:

SDKException - This is thrown if the process is unsuccessful

getCurrentDocumentCount

int getCurrentDocumentCount()
                            throws SDKException

Deprecated. As of version 12.0.

Returns the number of documents opened.

Returns:

An int indicating the number of documents opened

Throws:

SDKException - This is thrown if the process is unsuccessful

getTotalAgentCount

int getTotalAgentCount()
                       throws SDKException

Deprecated. As of version 12.0.

Returns the total number of agent threads created since server startup.

Returns:

An int indicating the total number of agent threads created since server startup

Throws:

SDKException - This is thrown if the process is unsuccessful

getTotalDocumentCount

int getTotalDocumentCount()
                          throws SDKException

Deprecated. As of version 12.0.

Returns the total number of documents opened since server startup.

Returns:

An int indicating the total number of documents opened since server startup

Throws:

SDKException - This is thrown if the process is unsuccessful

commit

void commit()
            throws SDKException

Deprecated. As of version 12.0.

Commits changes made to the server.

Throws:

SDKException - This is thrown if the process is unsuccessful