Package com.axemble.vdoc.sdk.interfaces

Interface IAgent

All Superinterfaces:

IElement, IProtocolSupport, ISecuritySupport, Serializable

public interface IAgent
extends IElement, ISecuritySupport

This class allows to manipulate scheduled tasks.

Since:

1.0, 24/03/2009

Author:

vlygeros

See Also:

• IUser
• IGroup

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IAgent.ExecutionStatus	All execution states.

Method Summary

Modifier and Type	Method	Description
String	getCategoryName()	Gets the category name of the agent.
String	getClassName()	Gets the name of the class associated with the agent.
Date	getLastExecutionDate()	Gets the last execution start date of the agent.
Date	getLastExecutionEndDate()	Gets the last execution end date of the agent.
int	getLastExecutionStatus()	Gets last result status
Date	getLastFailureDate()	Gets the date of the last failure of the agent.
byte[]	getLastReport()	Gets the last report of the agent
Date	getLastSuccessDate()	Gets the date of the last success of the agent.
String	getName()	Gets the name of the agent.

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport

getProtocolURI, getProtocolURI

Method Details

getName

String getName()

Gets the name of the agent.

Returns:

a String object.

getCategoryName

String getCategoryName()

Gets the category name of the agent.

Returns:

a String object.

getClassName

String getClassName()

Gets the name of the class associated with the agent.

Returns:

a String object.

getLastExecutionStatus

int getLastExecutionStatus()

Gets last result status

Returns:

the last execution status, one of ExecutionStatus.NEVER_RUN or ExecutionStatus.RUNNING or ExecutionStatus.SUCCESS or ExecutionStatus.WARNING or ExecutionStatus.FAILURE

getLastExecutionDate

Date getLastExecutionDate()

Gets the last execution start date of the agent.

Returns:

the last execution start date.

getLastReport

byte[] getLastReport()

Gets the last report of the agent

Returns:

the last report as an array of bytes.

getLastSuccessDate

Date getLastSuccessDate()

Gets the date of the last success of the agent.

Returns:

the last success start date.

getLastFailureDate

Date getLastFailureDate()

Gets the date of the last failure of the agent.

Returns:

the last failure start date.

getLastExecutionEndDate

Date getLastExecutionEndDate()

Gets the last execution end date of the agent.

Returns:

the last execution end date.