org.eclipse.wst.common.frameworks.datamodel
Interface IDataModelOperation

All Known Implementing Classes:

AbstractDataModelOperation

public interface IDataModelOperation

IDataModelOperation defines an IDataModel driven undoable operation. Every IDataModelOperation may be extended by third party clients using the extended operation framework.

Since:

1.0

See Also:

IDataModel

Method Summary

IDataModel	getDataModel() Returns this operation's IDataModel.
java.util.Set	getDataModelIDs()
java.lang.String	getID() Returns the unique operation id.
int	getOperationExecutionFlags()
java.util.List	getPostOperations() An operation can specify a list of operations that should run after this operation.
java.util.List	getPreOperations() An operation can specify a list of operations that should run before this operation.
ISchedulingRule	getSchedulingRule()
void	setDataModel(IDataModel model) Sets the IDataModel for this operation.
void	setEnvironment(IEnvironment environment) The framework will set the environment on this operation before it is executed.
void	setID(java.lang.String id) Sets the unique operation id.

Method Detail

setID

public void setID(java.lang.String id)

Sets the unique operation id. Typically, clients should not invoke this method.

Parameters:

id - the unique operation id

getID

public java.lang.String getID()

Returns the unique operation id.

Returns:

the unique operation id

setDataModel

public void setDataModel(IDataModel model)

Sets the IDataModel for this operation.

Parameters:

model - the IDataModel used to run this operation

getDataModel

public IDataModel getDataModel()

Returns this operation's IDataModel.

Returns:

this operation's IDataModel.

getDataModelIDs

public java.util.Set getDataModelIDs()

getSchedulingRule

public ISchedulingRule getSchedulingRule()

getOperationExecutionFlags

public int getOperationExecutionFlags()

setEnvironment

public void setEnvironment(IEnvironment environment)

The framework will set the environment on this operation before it is executed. The operation can then use the environment to report status, log information, and access resources in an environment neutral way.

getPreOperations

public java.util.List getPreOperations()

An operation can specify a list of operations that should run before this operation. Subclasses can override this method to provide these operations. The operations provided will be executed in the order specified in the list.

Returns:

returns a list of data model operations or null. Null indicates that there are no pre operations.

getPostOperations

public java.util.List getPostOperations()

An operation can specify a list of operations that should run after this operation. Subclasses can override this method to provide these operations. The operations provided will be executed in the order specified in the list.

Returns:

returns a list of data model operations or null. Null indicates that there are no post operations.