org.ow2.proactive.scheduler.common.usage

Interface SchedulerUsage

All Known Subinterfaces:

ISchedulerClient, Scheduler

All Known Implementing Classes:

AbstractSmartProxy, ClientBase, RestSmartProxyImpl, SchedulerClient, SchedulerNodeClient, SchedulerProxyUserInterface, SmartProxyImpl

@PublicAPI
public interface SchedulerUsage

Scheduler interface for accounting information, usage data and statistics.

Since:

ProActive Scheduling 3.4

Method Summary

Modifier and Type	Method and Description
List<JobUsage>	getAccountUsage(String user, Date startDate, Date endDate) Returns details on job and task execution times for a given user's executions.
List<JobUsage>	getMyAccountUsage(Date startDate, Date endDate) Returns details on job and task execution times for the caller's executions.

Method Detail

getMyAccountUsage

List<JobUsage> getMyAccountUsage(Date startDate,
                                 Date endDate)
                          throws NotConnectedException,
                                 PermissionException

Returns details on job and task execution times for the caller's executions.

Only the jobs finished between the start date and the end date will be returned: i.e startDate <= job.finishedTime <= endDate.

Parameters:

startDate - must not be null, inclusive

endDate - must not be null, inclusive

Returns:

a list of JobUsage objects where job finished times are between start date and end date

Throws:

NotConnectedException - if the caller is not connected

PermissionException - if the caller hasn't the permission to call this method

getAccountUsage

List<JobUsage> getAccountUsage(String user,
                               Date startDate,
                               Date endDate)
                        throws NotConnectedException,
                               PermissionException

Returns details on job and task execution times for a given user's executions.

Only the jobs finished between the start date and the end date will be returned: i.e startDate <= job.finishedTime <= endDate.

If user is the same as the caller, then it will fallback to to getMyAccountUsage(Date, Date).

Parameters:

user - must match a username as defined in the Scheduler's users

startDate - must not be null, inclusive

endDate - must not be null, inclusive

Returns:

a list of JobUsage objects where job finished times are between start date and end date

Throws:

NotConnectedException - if the caller is not connected

PermissionException - if the caller hasn't the permission to call this method