org.caleigo.core
Class AbstractTransactionEntityAction

java.lang.Object
  org.caleigo.core.AbstractEntityAction
      org.caleigo.core.AbstractTransactionEntityAction

All Implemented Interfaces:

IEntityAction, ITransactionEntityAction

Direct Known Subclasses:

AbstractEntityDescriptor.DeleteEntityAction, AbstractEntityDescriptor.StoreEntityAction, CompositeEntityDescriptor.CompositeDeleteEntityAction, CompositeEntityDescriptor.CompositeStoreEntityAction

public abstract class AbstractTransactionEntityAction

extends AbstractEntityAction

implements ITransactionEntityAction

Version:

1.00

Author:

Dennis Zikovic

Field Summary

Fields inherited from interface org.caleigo.core.IEntityAction

ASSOCIATION_EXPORT, DRAG, ENTITY, IDENTITY_EXPORT, MISCELLANEOUS, NEVER_EXPORT, PRIMARY, QUALIFIER, READ_ONLY, SECONDARY, SELECTION, SYSTEM

Constructor Summary

AbstractTransactionEntityAction(IEntityDescriptor entityDescriptor, java.lang.String codeName, java.lang.String displayName)
Creates a new instance of AbstractDataAction.

AbstractTransactionEntityAction(IEntityDescriptor entityDescriptor, java.lang.String codeName, java.lang.String displayName, java.lang.String displayHint)
Creates a new instance of AbstractDataAction.

Method Summary

void	cleanUpTransaction(IDataBundle data, IDataTransaction transaction) Clean up method for the action where the action can clean up data operations, if necessary via an overriding method in an implementing class, which were performed by the action.
abstract void	defineDataDescriptor() This method is called by the action objects constructor once and only once.
IDataSource	getDataSource() Help method used to access the data source used by the perform method deined in the IEntityAction interface.
void	perform(IDataBundle data) Performs the actions logic using the provided IActionData object.
abstract void	prepareTransaction(IDataBundle data, IDataTransaction transaction) Prepare method for the action where the action is expected to add the data operations needed to perform the action.

Methods inherited from class org.caleigo.core.AbstractEntityAction

addDataTypeDescriptor, addEntityDescriptor, addSelectionDescriptor, getCodeName, getDataBundleDescriptor, getDisplayHint, getDisplayName, getEntityDescriptor, isInCategory, setCategoryFlags, validateData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.caleigo.core.IEntityAction

getCodeName, getDataBundleDescriptor, getDisplayHint, getDisplayName, getEntityDescriptor, isInCategory

Constructor Detail

AbstractTransactionEntityAction

public AbstractTransactionEntityAction(IEntityDescriptor entityDescriptor,
                                       java.lang.String codeName,
                                       java.lang.String displayName)

Creates a new instance of AbstractDataAction.

AbstractTransactionEntityAction

public AbstractTransactionEntityAction(IEntityDescriptor entityDescriptor,
                                       java.lang.String codeName,
                                       java.lang.String displayName,
                                       java.lang.String displayHint)

Creates a new instance of AbstractDataAction.

Method Detail

prepareTransaction

public abstract void prepareTransaction(IDataBundle data,
                                        IDataTransaction transaction)

Prepare method for the action where the action is expected to add the data operations needed to perform the action.

Specified by:

prepareTransaction in interface ITransactionEntityAction

defineDataDescriptor

public abstract void defineDataDescriptor()

This method is called by the action objects constructor once and only once. The method is expected to define the action data requriments (IDataBundleDescriptor) using the diferent add methods for descriptors defined in this class.

Specified by:

defineDataDescriptor in class AbstractEntityAction

perform

public final void perform(IDataBundle data)

Performs the actions logic using the provided IActionData object. This method is defined by the IAction interface.

Specified by:

perform in interface IEntityAction

Specified by:

perform in class AbstractEntityAction

getDataSource

public IDataSource getDataSource()

Help method used to access the data source used by the perform method deined in the IEntityAction interface. Does by default return the default data source object registered in the the data source descripor that the action object belongs to.

cleanUpTransaction

public void cleanUpTransaction(IDataBundle data,
                               IDataTransaction transaction)

Clean up method for the action where the action can clean up data operations, if necessary via an overriding method in an implementing class, which were performed by the action. E.g. resetting flags etc.