com.metamatrix.server.admin.api
Interface QueryAdminAPI

All Superinterfaces:

java.io.Serializable, SubSystemAdminAPI

All Known Implementing Classes:

QueryAdminAPIImpl

public interface QueryAdminAPI
extends SubSystemAdminAPI

Method Summary

void	cancelRequest(RequestID requestID) Cancel a single query.
void	cancelRequest(RequestID requestID, int nodeID) Cancel an atomic query for the user session.
void	cancelRequests(MetaMatrixSessionID userSessionID) Cancel all queries for the user session.
java.util.Collection	getAllRequests() Return all queries that are in the system.
java.util.Collection	getRequestsForSession(MetaMatrixSessionID userSessionID) Return all queries that are currently being processed for the user session.

Method Detail

getAllRequests

java.util.Collection getAllRequests()
                                    throws AuthorizationException,
                                           InvalidSessionException,
                                           MetaMatrixComponentException

Return all queries that are in the system.

Returns:

a collection of Request objects.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurs in communicating with a component.

getRequestsForSession

java.util.Collection getRequestsForSession(MetaMatrixSessionID userSessionID)
                                           throws AuthorizationException,
                                                  InvalidSessionException,
                                                  MetaMatrixComponentException

Return all queries that are currently being processed for the user session.

Parameters:

userSessionID - the primary identifier for the user account.

Returns:

a collection of Request objects.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurs in communicating with a component.

cancelRequest

void cancelRequest(RequestID requestID)
                   throws AuthorizationException,
                          InvalidSessionException,
                          InvalidRequestIDException,
                          MetaMatrixComponentException

Cancel a single query.

Parameters:

requestID - the identifier of the query to be cancelled.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

InvalidRequestIDException - if the Request specified by the ID does not exist.

MetaMatrixComponentException - if an error occurs in communicating with a component.

cancelRequests

void cancelRequests(MetaMatrixSessionID userSessionID)
                    throws AuthorizationException,
                           InvalidSessionException,
                           MetaMatrixComponentException

Cancel all queries for the user session.

Parameters:

userSessionID - the primary identifier for the user account.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

MetaMatrixComponentException - if an error occurs in communicating with a component.

cancelRequest

void cancelRequest(RequestID requestID,
                   int nodeID)
                   throws AuthorizationException,
                          InvalidSessionException,
                          InvalidRequestIDException,
                          MetaMatrixComponentException

Cancel an atomic query for the user session.

Parameters:

callerSessionID - ID of the caller's current session.

requestID - the identifier of the query to be cancelled.

nodeID - identifies the node in the query to cancel.

Throws:

AuthorizationException - if caller is not authorized to perform this method.

InvalidSessionException - if the callerSessionID is not valid or is expired.

InvalidRequestIDException - if the Request specified by the ID does not exist.

MetaMatrixComponentException - if an error occurs in communicating with a component.