com.prosyst.mprm.backend.rules.spi.time.sequence

Interface TimeSequenceProvider

public interface TimeSequenceProvider

Should be registered as an OSGi service in the backend mPRM framework to resolve the next time sequence trigger.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TIME_SEQUENCE_TYPE Service registration property defining the time sequence type.

Method Summary

Modifier and Type	Method and Description
TimeSequence	parse(java.lang.String source, SystemContext systemContext) Invoked by the system to resolve the time sequence.
TimeSequenceBE	resolve(TimeSequence source, SystemContext systemContext) Invoked by the system to parse the text representation of a TimeSequence object.

Field Detail

TIME_SEQUENCE_TYPE

static final java.lang.String TIME_SEQUENCE_TYPE

Service registration property defining the time sequence type. Should match the type of the respective font-end TimeSequence object: TimeSequence.getType().

See Also:

Constant Field Values

Method Detail

parse

TimeSequence parse(java.lang.String source,
                   SystemContext systemContext)
            throws ManagementException

Invoked by the system to resolve the time sequence.

Parameters:

source - source object with which the Rule is created on the front-end.

systemContext - system-provided context information.

Returns:

object capable to calculate the trigger dates.

Throws:

ManagementException - if error occurs.

resolve

TimeSequenceBE resolve(TimeSequence source,
                       SystemContext systemContext)
                throws ManagementException

Invoked by the system to parse the text representation of a TimeSequence object. This method should be able to restore a TimeSequence object by its text representation, i.e., to do the opposite of the TimeSequence.getTextRepresentation() method. Such parsing is needed by the system when a Rule that have been previously exported as JSON text is being imported.

Parameters:

source - text to be parsed.

systemContext - system-provided context information.

Returns:

parsed object.

Throws:

ManagementException - if error occurs.