com.businessobjects.sdk.plugin.admin.fullclientserveradmin
Interface IFullClientCacheAdmin

public interface IFullClientCacheAdmin

The IFullClientCacheAdmin interface allows you manage the metrics and properties for the Desktop Intelligence Cache Server.

Method Summary

void	commit() Commits the Desktop Intelligence Cache Server updates.
int	getCachePurgeThreshold() Returns the cache purge threshold size in megabytes.
int	getCachePurgeThresholdUpdate() Returns the cache purge threshold size in megabytes.
boolean	isAlwaysShareReportJobs() Returns a boolean that indicates whether documents with shared data are shared between users.
boolean	isAlwaysShareReportJobsUpdate() Returns a boolean that indicates whether documents with shared data are shared between users on the next restart of the server.
void	setAlwaysShareReportJobsUpdate(boolean s) Sets a boolean that indicates whether documents with shared data are shared between users on the next restart of the server.
void	setCachePurgeThresholdUpdate(int n) Sets the cache purge threshold size in megabytes.

Method Detail

commit

void commit()
            throws SDKException

Commits the Desktop Intelligence Cache Server updates.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isAlwaysShareReportJobsUpdate

boolean isAlwaysShareReportJobsUpdate()
                                      throws SDKException

Returns a boolean that indicates whether documents with shared data are shared between users on the next restart of the server.

Returns:

true if documents with shared data are shared between users on the next restart of the server, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setAlwaysShareReportJobsUpdate

void setAlwaysShareReportJobsUpdate(boolean s)
                                    throws SDKException

Sets a boolean that indicates whether documents with shared data are shared between users on the next restart of the server.

Parameters:

s - A boolean that indicates whether documents with shared data are shared between users on the next restart of the server.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCachePurgeThresholdUpdate

int getCachePurgeThresholdUpdate()
                                 throws SDKException

Returns the cache purge threshold size in megabytes.

Returns:

An int that indicates the cache purge threshold size in megabytes.

Throws:

SDKException - This is thrown if the process is unsuccessful.

setCachePurgeThresholdUpdate

void setCachePurgeThresholdUpdate(int n)
                                  throws SDKException

Sets the cache purge threshold size in megabytes.

Parameters:

n - An int that indicates the cache purge threshold size in megabytes.

Throws:

SDKException - This is thrown if the process is unsuccessful.

isAlwaysShareReportJobs

boolean isAlwaysShareReportJobs()
                                throws SDKException

Returns a boolean that indicates whether documents with shared data are shared between users.

Returns:

true if documents with shared data are shared between users, and false otherwise.

Throws:

SDKException - This is thrown if the process is unsuccessful.

getCachePurgeThreshold

int getCachePurgeThreshold()
                           throws SDKException

Returns the cache purge threshold size in megabytes.

Returns:

An int that indicates the cache purge threshold size in megabytes.

Throws:

SDKException - This is thrown if the process is unsuccessful.