net.messagevortex.router.operation

Interface Operation

All Known Implementing Classes:

AbstractOperation, AddRedundancy, IdMapOperation, RemoveRedundancy

public interface Operation

This interface represents a standard operation in the payload space of an identity.

Method Summary

Modifier and Type	Method and Description
boolean	canRun() Checks if all prerequisiting fields do exist or can be provided by a subsequent operation.
int[]	execute(int[] id) Executes the operation and sets at least the provided set of id.
IdentityBlock	getIdentity()
int[]	getInputId() Gets all ids which are required to execute this operation.
int[]	getOutputId() Gets all ids which are written by this operation.
boolean	isInUsagePeriod() Checks if this operation is still valid or might be purged from the identities working space.
void	setInternalPayload(InternalPayloadSpace payload) Sets the internal payload and associated identity.

Method Detail

getIdentity

IdentityBlock getIdentity()

canRun

boolean canRun()

Checks if all prerequisiting fields do exist or can be provided by a subsequent operation.

Returns:

true if all prerequisits can potentially be satisfied

isInUsagePeriod

boolean isInUsagePeriod()

Checks if this operation is still valid or might be purged from the identities working space.

Returns:

true if the operation should remain in the payload space

getOutputId

int[] getOutputId()

Gets all ids which are written by this operation.

Returns:

array representing all ids which will be potentially set by this operation

getInputId

int[] getInputId()

Gets all ids which are required to execute this operation.

Returns:

array representing all ids which will be potentially set by this operation

execute

int[] execute(int[] id)

Executes the operation and sets at least the provided set of id.

This operation might trigger to execute prerequisiting operations.

Parameters:

id - the namespace id to be set minimally

Returns:

array representing all ids which have been set

setInternalPayload

void setInternalPayload(InternalPayloadSpace payload)

Sets the internal payload and associated identity.

This method is called from the InternalPayloadSpace when registering.

Parameters:

payload - the internal payload of an identity to be registered within