eu.dnetlib.enabling.tools.blackboard

Interface BlackboardJob

All Known Implementing Classes:

BlackboardJobImpl

public interface BlackboardJob

High level representation of a blackboard job.

Author:

marko

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() Get the bb message.
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.

Method Detail

getId

String getId()

Get the message id.

Returns:

id

setId

void setId(String identifier)

Set message id.

Parameters:

identifier - id

getAction

String getAction()

Get the action name.

Returns:

action name

setAction

void setAction(String action)

Set the action name.

Parameters:

action - action name

getActionStatus

ActionStatus getActionStatus()

Get the action status.

Returns:

action status

setActionStatus

void setActionStatus(ActionStatus actionStatus)

Set the action status.

Parameters:

actionStatus - action status

getDate

String getDate()

Get the message date.

Returns:

date

setDate

void setDate(String date)

Set the message date.

Parameters:

date - date

getParameters

Map<String,String> getParameters()

obtains a mutable parameter map (key/value).

Returns:

mutable parameter map

getError

String getError()

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.

Returns:

error message

setError

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.

Parameters:

error - error message

getServiceId

String getServiceId()

Get the setviceId.

Returns:

the serviceId

isCompleted

boolean isCompleted()

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

Returns:

true if completed

getMessage

BlackboardMessage getMessage()

Get the bb message.

Returns:

the bb message