org.caleigo.core
Interface IDataBundleDescriptor

All Known Implementing Classes:

DataBundleDescriptor

public interface IDataBundleDescriptor

Version:

1.00

Author:

Dennis Zikovic

Field Summary

static int	DATA Constant returned by the getItemType method for data items that are single data fields defined by a DataType object.
static int	ENTITY Constant returned by the getItemType method for data items that are IEntity objects defined by a IEntityDescriptor object.
static int	SELECTION Constant returned by the getItemType method for data items that are a selection of IEntity objects defined by a IEntityDescriptor object.

Method Summary

IDataBundle	createActionData() Action method that creates IActionData object for the called ActionData- Descriptor.
java.lang.String	getCodeName(int index) Access method that returns the code name that can be used to identify the indexed data item.
DataType	getDataType(int index) Returns the DataType of the indexed data item if that item is of the type DATA otherwise null is returned.
java.lang.String	getDisplayHint(int index) 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(int index) Access method that returns a end-user presentable name that can be used as button and meny labels for the indexed data item.
IEntityDescriptor	getEntityDescriptor(int index) Returns the DataType of the indexed data item if that item is of the type ENTITY or SELECTION otherwise null is returned.
int	getItemCount() This method returns the number of data item objects that are defined by the IActionDataDescriptor object.
int	getItemIndex(java.lang.String codeName) Help method that returns the indexed of the named data item.
int	getItemType(int index) This method returns the item type of the indexed data item defined by the IActionDataDescriptor object.
ValidationResult	validateData(IDataBundle actionData) Help method that validates the provided IActionData object.

Field Detail

DATA

public static final int DATA

Constant returned by the getItemType method for data items that are single data fields defined by a DataType object.

See Also:

Constant Field Values

ENTITY

public static final int ENTITY

Constant returned by the getItemType method for data items that are IEntity objects defined by a IEntityDescriptor object.

See Also:

Constant Field Values

SELECTION

public static final int SELECTION

Constant returned by the getItemType method for data items that are a selection of IEntity objects defined by a IEntityDescriptor object.

See Also:

Constant Field Values

Method Detail

getItemCount

public int getItemCount()

This method returns the number of data item objects that are defined by the IActionDataDescriptor object.

getItemType

public int getItemType(int index)

This method returns the item type of the indexed data item defined by the IActionDataDescriptor object.

getDataType

public DataType getDataType(int index)

Returns the DataType of the indexed data item if that item is of the type DATA otherwise null is returned.

getEntityDescriptor

public IEntityDescriptor getEntityDescriptor(int index)

Returns the DataType of the indexed data item if that item is of the type ENTITY or SELECTION otherwise null is returned.

getCodeName

public java.lang.String getCodeName(int index)

Access method that returns the code name that can be used to identify the indexed data item.

getDisplayName

public java.lang.String getDisplayName(int index)

Access method that returns a end-user presentable name that can be used as button and meny labels for the indexed data item.

getDisplayHint

public java.lang.String getDisplayHint(int index)

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

getItemIndex

public int getItemIndex(java.lang.String codeName)

Help method that returns the indexed of the named data item. If the code name can not be identified then a negative value is returned.

createActionData

public IDataBundle createActionData()

Action method that creates IActionData object for the called ActionData- Descriptor. The created IActionData will be defined by the called IActionDataDescriptor and will only be complete if it contains all data specified by that descriptor.

validateData

public ValidationResult validateData(IDataBundle actionData)

Help method that validates the provided IActionData object. The data object must have called descriptor as its defining descriptor or an IllegalArgumentException exception is thrown.