Package repast.simphony.engine.schedule

Interface ContextSchedulableDescriptor<T>

All Superinterfaces:

Descriptor, PredicateFiltered<T>

All Known Implementing Classes:

DefaultContextSchedulableDescriptor

public interface ContextSchedulableDescriptor<T>
extends PredicateFiltered<T>, Descriptor

Descriptor for a schedulable action that will occur on a filtered set of objects. An example usage of this would be to filter a Context based on the filter contained in this descriptor.

Version:

$Revision: 1.1 $ $Date: 2005/12/21 22:25:34 $

Author:

Jerry Vos

Method Summary

Modifier and Type	Method	Description
String	getMethodName()	Retrieves the name of the method to call on the filtered objects.
ScheduleParameters	getScheduleParameters()	Retrieves the parameters for when the action should occur.
boolean	getShuffle()	Retrieves whether or not to shuffle the list of objects before executing them or not.
void	setMethodName(String methodName)	Sets the name of the method to call on the filtered objects.
void	setScheduleParameters(ScheduleParameters scheduleParameters)	Sets the parameters for when the action should occur.
void	setShuffle(boolean shuffle)	Sets whether or not to shuffle the list of objects before executing them or not.

Methods inherited from interface repast.simphony.engine.schedule.Descriptor

getName, setName

Methods inherited from interface repast.simphony.util.PredicateFiltered

getFilter, setFilter

Method Detail

getScheduleParameters

ScheduleParameters getScheduleParameters()

Retrieves the parameters for when the action should occur.

Returns:

parameters for the action's execution

setScheduleParameters

void setScheduleParameters(ScheduleParameters scheduleParameters)

Sets the parameters for when the action should occur.

Parameters:

scheduleParameters - parameters for the action's execution

setMethodName

void setMethodName(String methodName)

Sets the name of the method to call on the filtered objects.

Parameters:

methodName - name of the method to call on the filtered objects.

getMethodName

String getMethodName()

Retrieves the name of the method to call on the filtered objects.

Returns:

name of the method to call on the filtered objects.

setShuffle

void setShuffle(boolean shuffle)

Sets whether or not to shuffle the list of objects before executing them or not.

Parameters:

shuffle - whether or not to shuffle the list of objects before executing them or not

See Also:

ISchedule.scheduleIterable(ScheduleParameters, Iterable, String, boolean, Object[])

getShuffle

boolean getShuffle()

Retrieves whether or not to shuffle the list of objects before executing them or not.

Returns:

whether or not to shuffle the list of objects before executing them or not

See Also:

ISchedule.scheduleIterable(ScheduleParameters, Iterable, String, boolean, Object[])