com.openexchange.admin.rmi
Interface OXTaskMgmtInterface

All Superinterfaces:
Remote
All Known Implementing Classes:
OXTaskMgmtImpl

public interface OXTaskMgmtInterface
extends Remote

This interface defines the methods of the task management which are accessibly through RMI.

Author:
Manuel Kraft, Carsten Hoeger, Dennis Sieben

Field Summary
static String RMI_NAME
          RMI name to be used in the naming lookup.
 
Method Summary
 void deleteJob(Context ctx, Credentials auth, int i)
          This method is used to delete finished jobs (jobs != running) from the list
 void flush(Context ctx, Credentials auth)
          Flushes all jobs from the queue which are finished ( != running)
 String getJobList(Context ctx, Credentials cred)
           
 Object getTaskResults(Context ctx, Credentials cred, int id)
          Gets the result from the task with the specified id
 

Field Detail

RMI_NAME

static final String RMI_NAME
RMI name to be used in the naming lookup.

See Also:
Constant Field Values
Method Detail

getTaskResults

Object getTaskResults(Context ctx,
                      Credentials cred,
                      int id)
                      throws RemoteException,
                             InvalidCredentialsException,
                             StorageException,
                             InterruptedException,
                             ExecutionException,
                             InvalidDataException
Gets the result from the task with the specified id

Parameters:
ctx -
cred -
id -
Returns:
an object which has to be casted to the return value specified in the method which adds the job
Throws:
RemoteException
InvalidCredentialsException
StorageException
InterruptedException
ExecutionException
InvalidDataException

getJobList

String getJobList(Context ctx,
                  Credentials cred)
                  throws RemoteException,
                         InvalidDataException,
                         InvalidCredentialsException,
                         StorageException
Returns:
Throws:
RemoteException
InvalidDataException
StorageException
InvalidCredentialsException

deleteJob

void deleteJob(Context ctx,
               Credentials auth,
               int i)
               throws RemoteException,
                      InvalidDataException,
                      InvalidCredentialsException,
                      StorageException,
                      TaskManagerException
This method is used to delete finished jobs (jobs != running) from the list

Parameters:
ctx -
auth -
i -
Throws:
RemoteException
InvalidDataException
InvalidCredentialsException
StorageException
TaskManagerException

flush

void flush(Context ctx,
           Credentials auth)
           throws RemoteException,
                  InvalidDataException,
                  InvalidCredentialsException,
                  StorageException,
                  TaskManagerException
Flushes all jobs from the queue which are finished ( != running)

Parameters:
ctx -
auth -
Throws:
RemoteException
InvalidDataException
InvalidCredentialsException
StorageException
TaskManagerException