eu.dnetlib.enabling.tools.blackboard

Class BlackboardJobImpl

java.lang.Object

eu.dnetlib.enabling.tools.blackboard.BlackboardJobImpl

All Implemented Interfaces:

BlackboardJob

public class BlackboardJobImpl
extends Object
implements BlackboardJob

High level representation of a blackboard job.

Author:

marko

Constructor Summary

Constructors

Constructor and Description
BlackboardJobImpl(String serviceId, BlackboardMessage message) Construct a new blackboard job from a blackboard message.

Method Summary

Modifier and Type	Method and Description
String	getAction() Get the action name.
ActionStatus	getActionStatus() Get the action status.
String	getDate() Get the message date.
String	getError() Get the error message, if the actionStatus is FAILED.
String	getId() Get the message id.
BlackboardMessage	getMessage() returns the blackboard message, potentially modified.
Map<String,String>	getParameters() obtains a mutable parameter map (key/value).
String	getServiceId() Get the setviceId.
boolean	isCompleted() True if the action status is one of the termination statuses (e.g.
void	setAction(String action) Set the action name.
void	setActionStatus(ActionStatus actionStatus) Set the action status.
void	setDate(String date) Set the message date.
void	setError(String error) Set the error message, if the actionStatus is FAILED.
void	setId(String identifier) Set message id.
void	setMessage(BlackboardMessage message)
void	setServiceId(String serviceId)

Methods inherited from class java.lang.Object

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

Constructor Detail

BlackboardJobImpl

public BlackboardJobImpl(String serviceId,
                         BlackboardMessage message)

Construct a new blackboard job from a blackboard message.

Parameters:

serviceId - service identifier

message - underlying low-level blackboard message

Method Detail

getId

public String getId()

Description copied from interface: BlackboardJob

Get the message id.

Specified by:

getId in interface BlackboardJob

Returns:

id

setId

public void setId(String identifier)

Set message id.

Specified by:

setId in interface BlackboardJob

Parameters:

identifier - id

See Also:

BlackboardJob.setId(java.lang.String)

getAction

public String getAction()

Description copied from interface: BlackboardJob

Get the action name.

Specified by:

getAction in interface BlackboardJob

Returns:

action name

getActionStatus

public ActionStatus getActionStatus()

Description copied from interface: BlackboardJob

Get the action status.

Specified by:

getActionStatus in interface BlackboardJob

Returns:

action status

getDate

public String getDate()

Description copied from interface: BlackboardJob

Get the message date.

Specified by:

getDate in interface BlackboardJob

Returns:

date

getError

public String getError()

Description copied from interface: BlackboardJob

Get the error message, if the actionStatus is FAILED. Usually the error message is also present in the parameter map but it's preferred to use this method.

Specified by:

getError in interface BlackboardJob

Returns:

error message

getParameters

public Map<String,String> getParameters()

Description copied from interface: BlackboardJob

obtains a mutable parameter map (key/value).

Specified by:

getParameters in interface BlackboardJob

Returns:

mutable parameter map

setAction

public void setAction(String action)

Set the action name.

Specified by:

setAction in interface BlackboardJob

Parameters:

action - action name

See Also:

BlackboardJob.setAction(java.lang.String)

setActionStatus

public void setActionStatus(ActionStatus actionStatus)

Set the action status.

Specified by:

setActionStatus in interface BlackboardJob

Parameters:

actionStatus - action status

See Also:

BlackboardJob.setActionStatus(eu.dnetlib.enabling.tools.blackboard.ActionStatus)

setDate

public void setDate(String date)

Set the message date.

Specified by:

setDate in interface BlackboardJob

Parameters:

date - date

See Also:

BlackboardJob.setDate(java.lang.String)

setError

public void setError(String error)

Set the error message, if the actionStatus is FAILED. Usually the error message is also present in the parameter map but it's preferred to use this method.

Specified by:

setError in interface BlackboardJob

Parameters:

error - error message

See Also:

BlackboardJob.setError(java.lang.String)

getMessage

public BlackboardMessage getMessage()

returns the blackboard message, potentially modified.

Specified by:

getMessage in interface BlackboardJob

Returns:

underlying blackboard message

setMessage

public void setMessage(BlackboardMessage message)

getServiceId

public String getServiceId()

Description copied from interface: BlackboardJob

Get the setviceId.

Specified by:

getServiceId in interface BlackboardJob

Returns:

the serviceId

setServiceId

public void setServiceId(String serviceId)

isCompleted

public boolean isCompleted()

Description copied from interface: BlackboardJob

True if the action status is one of the termination statuses (e.g. done and failed).

Specified by:

isCompleted in interface BlackboardJob

Returns:

true if completed