pt.digitalis.iss
Interface ISS

All Known Implementing Classes:
ISSImpl

public interface ISS

Defines the ISS behaviour expected by clients.

Author:
Rodrigo Gonçalves rgoncalves@digitalis.pt

Method Summary
 ServiceRequest delegate(IProcess process)
          Overload of the delegate() method.
 ServiceRequest delegate(IProcess aProcess, String id)
          Delegates the process execution to the ISS.
 boolean existsRequest(String id)
          This method informs if a request with a given id is already being served, was served or is waiting.
 ServiceRequest fetchResults(String requestID)
          Returns the execution results to the client.
 long getEstimatedTimeOfExecution(String requestID)
          Returns the estimated time of execution for a given process.
 boolean isStatisticsDumpEnabled()
          Returns the value of the statistics logging control flag.
 void setStatisticsDumpEnabled(boolean showStatistics)
          Sets the value of the statistics logging control flag.
 

Method Detail

delegate

ServiceRequest delegate(IProcess aProcess,
                        String id)
Delegates the process execution to the ISS. Clients call this method to apply for a request service.

Parameters:
aProcess - the process to execute
id - an explicit id for the request
Returns:
the service request associated to the process passed

delegate

ServiceRequest delegate(IProcess process)
Overload of the delegate() method. The client uses this variant if it does not wishes to pass an id of its own.

Parameters:
process - the process to execute
Returns:
the service request associated to the process passed
See Also:
delegate(IProcess, String)

existsRequest

boolean existsRequest(String id)
This method informs if a request with a given id is already being served, was served or is waiting. Clients should use this method when the id is supplied externally to find if a request is already in the system.

Parameters:
id - the id of the request
Returns:
T if the request is on the index, F otherwise

fetchResults

ServiceRequest fetchResults(String requestID)
Returns the execution results to the client.

Parameters:
requestID - the request id
Returns:
the request execution results

getEstimatedTimeOfExecution

long getEstimatedTimeOfExecution(String requestID)
Returns the estimated time of execution for a given process.

Parameters:
requestID - the id of the process
Returns:
the estimated time of execution for the given process in milliseconds

isStatisticsDumpEnabled

boolean isStatisticsDumpEnabled()
Returns the value of the statistics logging control flag.

Returns:
the statisticsDumpEnabled value

setStatisticsDumpEnabled

void setStatisticsDumpEnabled(boolean showStatistics)
Sets the value of the statistics logging control flag.

Parameters:
showStatistics - the statisticsDumpEnabled new value


Copyright © 2010 Digitalis Informática Lda. All Rights Reserved.