org.caleigo.core
Interface IEntityAction

All Known Subinterfaces:

IBinaryEntityAction, ITransactionEntityAction, IUnaryEntityAction

All Known Implementing Classes:

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

public interface IEntityAction

IEntityAction objects are used to perform or trigger some kind of work or data calculation. It is the preffered way in the celgen application framework to encapsulate and handle business logic.

Using IEntityAction it is possible to make business-logic transperent for multiple types view solutions in the frameworks MVC design. The IEntityAction objects can be connected to the entity descriptor model making it pssible to integrate the business logic in the dynamic view structure in the swing based view implementation.

Version:

1.00

Author:

Dennis Zikovic

Field Summary

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

Method Summary

java.lang.String	getCodeName() Access method that returns the code name that can be used to identify the called IAction object.
IDataBundleDescriptor	getDataBundleDescriptor() Access method that returns the IActionDataDescriptor for the IActionData theat the called action needs to perform its logic payload.
java.lang.String	getDisplayHint() Access method that returns a end-user presentable hint text that can be used as a help text or fly-by hint.
java.lang.String	getDisplayName() Access method that returns a end-user presentable name that can be used as button and meny labels.
IEntityDescriptor	getEntityDescriptor() Access method that returns the IEntityDescriptor object that the called action object is a part of.
boolean	isInCategory(int category) Access method that return true if the called action object has of the provided category flag set to true.
void	perform(IDataBundle data) Performs the actions logic using the provided IActionData object.

Field Detail

ENTITY

public static final int ENTITY

See Also:

Constant Field Values

SELECTION

public static final int SELECTION

See Also:

Constant Field Values

QUALIFIER

public static final int QUALIFIER

See Also:

Constant Field Values

READ_ONLY

public static final int READ_ONLY

See Also:

Constant Field Values

SYSTEM

public static final int SYSTEM

See Also:

Constant Field Values

NEVER_EXPORT

public static final int NEVER_EXPORT

See Also:

Constant Field Values

IDENTITY_EXPORT

public static final int IDENTITY_EXPORT

See Also:

Constant Field Values

ASSOCIATION_EXPORT

public static final int ASSOCIATION_EXPORT

See Also:

Constant Field Values

PRIMARY

public static final int PRIMARY

See Also:

Constant Field Values

SECONDARY

public static final int SECONDARY

See Also:

Constant Field Values

MISCELLANEOUS

public static final int MISCELLANEOUS

See Also:

Constant Field Values

DRAG

public static final int DRAG

See Also:

Constant Field Values

Method Detail

perform

public void perform(IDataBundle data)

Performs the actions logic using the provided IActionData object.

getDataBundleDescriptor

public IDataBundleDescriptor getDataBundleDescriptor()

Access method that returns the IActionDataDescriptor for the IActionData theat the called action needs to perform its logic payload.

getEntityDescriptor

public IEntityDescriptor getEntityDescriptor()

Access method that returns the IEntityDescriptor object that the called action object is a part of.

getCodeName

public java.lang.String getCodeName()

Access method that returns the code name that can be used to identify the called IAction object.

getDisplayName

public java.lang.String getDisplayName()

Access method that returns a end-user presentable name that can be used as button and meny labels.

getDisplayHint

public java.lang.String getDisplayHint()

Access method that returns a end-user presentable hint text that can be used as a help text or fly-by hint.

isInCategory

public boolean isInCategory(int category)

Access method that return true if the called action object has of the provided category flag set to true.