ccc.api.core
Class ActionSummary

java.lang.Object
  ccc.api.core.Res
      ccc.api.core.ActionSummary

All Implemented Interfaces:

java.io.Serializable

public final class ActionSummary
extends Res

Summary of a CCC scheduled action.

Author:

Civic Computing Ltd.

See Also:

Serialized Form

Field Summary

static java.lang.String	EXECUTE_AFTER EXECUTE_AFTER : String.
static java.lang.String	FAILURE_CODE FAILURE : String.
static java.lang.String	ID ID : String.
static java.lang.String	PATH PATH : String.
static java.lang.String	STATUS STATUS : String.
static java.lang.String	SUBJECT_TYPE SUBJECT_TYPE : String.
static java.lang.String	TYPE TYPE : String.
static java.lang.String	USERNAME USERNAME : String.

Constructor Summary

ActionSummary()
Constructor.

ActionSummary(java.util.UUID id, CommandType type, Username actorUsername, java.util.Date after, ResourceType subjectType, java.lang.String path, ActionStatus status, FailureCode fCode)
Constructor.

Method Summary

Username	getActorUsername() Accessor.
java.util.Date	getExecuteAfter() Accessor.
FailureCode	getFailureCode() Accessor.
java.util.UUID	getId() Accessor.
ActionStatus	getStatus() Accessor.
java.lang.String	getSubjectPath() Accessor.
ResourceType	getSubjectType() Accessor.
CommandType	getType() Accessor.
java.lang.String	self() Link.
void	setActorUsername(Username actorUsername) Mutator.
void	setExecuteAfter(java.util.Date executeAfter) Mutator.
void	setFCode(FailureCode code) Mutator.
void	setId(java.util.UUID id) Mutator.
void	setStatus(ActionStatus status) Mutator.
void	setSubjectPath(java.lang.String subjectPath) Mutator.
void	setSubjectType(ResourceType subjectType) Mutator.
void	setType(CommandType type) Mutator.

Methods inherited from class ccc.api.core.Res

addLink, addLinks, getLink, getLinks

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ID

public static final java.lang.String ID

ID : String.

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

TYPE : String.

See Also:

Constant Field Values

USERNAME

public static final java.lang.String USERNAME

USERNAME : String.

See Also:

Constant Field Values

EXECUTE_AFTER

public static final java.lang.String EXECUTE_AFTER

EXECUTE_AFTER : String.

See Also:

Constant Field Values

PATH

public static final java.lang.String PATH

PATH : String.

See Also:

Constant Field Values

SUBJECT_TYPE

public static final java.lang.String SUBJECT_TYPE

SUBJECT_TYPE : String.

See Also:

Constant Field Values

STATUS

public static final java.lang.String STATUS

STATUS : String.

See Also:

Constant Field Values

FAILURE_CODE

public static final java.lang.String FAILURE_CODE

FAILURE : String.

See Also:

Constant Field Values

Constructor Detail

ActionSummary

public ActionSummary()

Constructor.

ActionSummary

public ActionSummary(java.util.UUID id,
                     CommandType type,
                     Username actorUsername,
                     java.util.Date after,
                     ResourceType subjectType,
                     java.lang.String path,
                     ActionStatus status,
                     FailureCode fCode)

Constructor.

Parameters:

id - The action's id.

type - The type of command the action will perform.

subjectType - The subject's type.

actorUsername - The action's actor.

after - The date after which the action should be executed.

path - The absolute path of the action's subject.

status - The action's status.

fCode - The action's failure code.

Method Detail

getId

public java.util.UUID getId()

Accessor.

Returns:

Returns the id.

getType

public CommandType getType()

Accessor.

Returns:

Returns the type.

getActorUsername

public Username getActorUsername()

Accessor.

Returns:

Returns the actor.

getExecuteAfter

public java.util.Date getExecuteAfter()

Accessor.

Returns:

Returns the executeAfter.

getSubjectType

public ResourceType getSubjectType()

Accessor.

Returns:

Returns the subjectType.

getSubjectPath

public java.lang.String getSubjectPath()

Accessor.

Returns:

Returns the subjectPath.

getFailureCode

public FailureCode getFailureCode()

Accessor.

Returns:

Returns the failure code.

getStatus

public ActionStatus getStatus()

Accessor.

Returns:

Returns the status.

setStatus

public void setStatus(ActionStatus status)

Mutator.

Parameters:

status - The status to set.

setId

public void setId(java.util.UUID id)

Mutator.

Parameters:

id - The id to set.

setType

public void setType(CommandType type)

Mutator.

Parameters:

type - The type to set.

setActorUsername

public void setActorUsername(Username actorUsername)

Mutator.

Parameters:

actorUsername - The actorUsername to set.

setExecuteAfter

public void setExecuteAfter(java.util.Date executeAfter)

Mutator.

Parameters:

executeAfter - The executeAfter to set.

setSubjectType

public void setSubjectType(ResourceType subjectType)

Mutator.

Parameters:

subjectType - The subjectType to set.

setSubjectPath

public void setSubjectPath(java.lang.String subjectPath)

Mutator.

Parameters:

subjectPath - The subjectPath to set.

setFCode

public void setFCode(FailureCode code)

Mutator.

Parameters:

code - The fCode to set.

self

public java.lang.String self()

Link.

Returns:

A link to this action.