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

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() Commits changes made to the server.
int	getAgentTimeoutMins() The number of minutes of idle time before a server agent times out.
boolean	getAutoDBDisconnect() Deprecated. should use isAutoDBDisconnect() instead.
int	getCurrentAgentCount() Returns the number of agent threads running.
int	getCurrentDocumentCount() Returns the number of documents opened.
boolean	getEnableAsyncQuery() Deprecated. should use isEnableAsyncQuery() instead.
boolean	getEnablePushDownGroupBy() Deprecated. should use isEnablePushDownGroupBy() instead.
boolean	getEnableSelectDistinctRecords() Deprecated. should use isEnableSelectDistinctRecords() instead.
int	getMaxNumOfRecords() The specified maximum number of records.
int	getMaxReportJobs() The specified maximum number of jobs.
int	getMinutesBetweenDBRefresh() The oldest processed data given to a client in minutes.
int	getNumOfBrowsingRecords() The specified number of browsing records.
int	getRowsetBatchSize() The specified size of rowset batch.
int	getTotalAgentCount() Returns the total number of agent threads created since server startup.
int	getTotalDocumentCount() Returns the total number of documents opened since server startup.
boolean	getUseInprocAgent() Deprecated. should use isUseInprocAgent() instead.
boolean	isAutoDBDisconnect() Report job automatically disconnects from database when all records have been retrieved.
boolean	isEnableAsyncQuery() Returns True if the program uses asynchronous queries and False otherwise.
boolean	isEnablePushDownGroupBy() Returns True if the program performs grouping on the server (server-side processing) and False otherwise.
boolean	isEnableSelectDistinctRecords() Returns True if, in the report, only unique records are being selected from the SQL tables in your database and False otherwise.
boolean	isUseInprocAgent() Returns True if the server is using an inproc agent.
void	setAgentTimeoutMins(int val) The number of minutes of idle time before a server agent times out.
void	setAutoDBDisconnect(boolean val) Report job automatically disconnects from database when all records have been retrieved.
void	setEnableAsyncQuery(boolean val) Indicate to server whether or not the program uses asynchronous queries.
void	setEnablePushDownGroupBy(boolean val) Indicate to the server whether or not grouping should be used.
void	setEnableSelectDistinctRecords(boolean val) Indicate to the server whether or not reports only select unique records from SQL tables.
void	setMaxNumOfRecords(int val) Specifies the maximum number of records.
void	setMaxReportJobs(int val) Specifies the maximum number of jobs.
void	setMinutesBetweenDBRefresh(int val) Specifies the oldest processed data given to a client in minutes.
void	setNumOfBrowsingRecords(int val) Specifies the number of browsing records.
void	setRowsetBatchSize(int val) Specifies the size of rowset batch.
void	setUseInprocAgent(boolean val) Indicate to the server whether an inproc agent should be used.

Method Detail

getAutoDBDisconnect

public boolean getAutoDBDisconnect()
                            throws SDKException

Deprecated. should use isAutoDBDisconnect() instead.

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

public boolean isAutoDBDisconnect()
                           throws SDKException

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

public void setAutoDBDisconnect(boolean val)
                         throws SDKException

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

public int getAgentTimeoutMins()
                        throws SDKException

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

public void setAgentTimeoutMins(int val)
                         throws SDKException

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

public boolean getEnableAsyncQuery()
                            throws SDKException

Deprecated. should use isEnableAsyncQuery() instead.

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

public boolean isEnableAsyncQuery()
                           throws SDKException

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

public void setEnableAsyncQuery(boolean val)
                         throws SDKException

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

public boolean getEnablePushDownGroupBy()
                                 throws SDKException

Deprecated. should use isEnablePushDownGroupBy() instead.

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

public boolean isEnablePushDownGroupBy()
                                throws SDKException

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

public void setEnablePushDownGroupBy(boolean val)
                              throws SDKException

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

public boolean getEnableSelectDistinctRecords()
                                       throws SDKException

Deprecated. should use isEnableSelectDistinctRecords() instead.

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

public boolean isEnableSelectDistinctRecords()
                                      throws SDKException

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

public void setEnableSelectDistinctRecords(boolean val)
                                    throws SDKException

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

public int getMaxNumOfRecords()
                       throws SDKException

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

public void setMaxNumOfRecords(int val)
                        throws SDKException

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

public int getMaxReportJobs()
                     throws SDKException

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

public void setMaxReportJobs(int val)
                      throws SDKException

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

public int getMinutesBetweenDBRefresh()
                               throws SDKException

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

public void setMinutesBetweenDBRefresh(int val)
                                throws SDKException

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

public int getNumOfBrowsingRecords()
                            throws SDKException

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

public void setNumOfBrowsingRecords(int val)
                             throws SDKException

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

public int getRowsetBatchSize()
                       throws SDKException

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

public void setRowsetBatchSize(int val)
                        throws SDKException

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

public boolean getUseInprocAgent()
                          throws SDKException

Deprecated. should use isUseInprocAgent() instead.

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

public boolean isUseInprocAgent()
                         throws SDKException

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

public void setUseInprocAgent(boolean val)
                       throws SDKException

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

public int getCurrentAgentCount()
                         throws SDKException

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

public int getCurrentDocumentCount()
                            throws SDKException

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

public int getTotalAgentCount()
                       throws SDKException

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

public int getTotalDocumentCount()
                          throws SDKException

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

public void commit()
            throws SDKException

Commits changes made to the server.

Throws:

SDKException - This is thrown if the process is unsuccessful.