com.highdeal.iec.hci
Class JavaActionModel

java.lang.Object
  com.highdeal.iec.hci.ActionModelImpl
      com.highdeal.iec.hci.JavaActionModel

All Implemented Interfaces:

com.highdeal.hci.XMLMarshallable, com.highdeal.iec.hci.ActionModel, com.highdeal.iec.hci.ContextualModel

public class JavaActionModel
extends com.highdeal.iec.hci.ActionModelImpl

This class represents an Java Action that can perform a Java class.

The class must to extend the com.highdeal.iec.action.JavaTask.
During the execution, two methods are invoked:

• "setProperties(Properties props)"
To receive the properties of initialization of your java task
The properties are those define in this model
• "execute(DataCollection collection)
To treat the DataCollection given in argument
DataCollection contains data (like ExtendedChargeableItem)

It can access to other service regarding the following implementations:

• JavaTaskStateListener
• The method "stateTerminated(String actionUid)" is invoked
  when the last action has fully treated the current DataCollection
• The method "stateRejected(String actionUid, String[] arguments)" is invoked
  when an action rejected the current DataCollection.
  The reason are explained in the arguments
• The method "stateFiltered(String actionUid)" is invoked
  when an action filtered the current DataCollection is fully treated
• JavaTaskIterator
While the method "boolean hasNext(DataCollection collection)" return true,
invoke the method "execute(DataCollection collection)" with the same DataCollection
• JavaTaskInitializable
• Invoke the method "setUp(DataCollection collection)" before:
  • the invocation of "execute" when the java task isn't an JavaTaskIterator
  • the iterations when the java task isn't an JavaTaskIterator
• Invoke the method "tearDown(DataCollection collection)" after:
  • the invocation of "execute" when the java task isn't an JavaTaskIterator
  • the iterations when the java task isn't an JavaTaskIterator

Field Summary

static java.lang.String	CLASSNAME
static java.lang.String	CONTEXT_PROPERTY
static java.lang.String	NAME
static java.lang.String	PROPERTY
static java.lang.String	TYPE
static java.lang.String	VALUE

Fields inherited from class com.highdeal.iec.hci.ActionModelImpl

ACTION_XMLTAG, children, DESCRIPTION_XMLATTR, EMPTYCHILD_XMLTAG, TYPE_XMLATTR, UID_XMLATTR

Fields inherited from interface com.highdeal.iec.hci.ContextualModel

SAVE, USAGE

Constructor Summary

JavaActionModel()
Creation of an instance of this model.

Method Summary

void	addChild(java.lang.String tagName, com.highdeal.hci.XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
java.lang.String	getClassName() Get the class name of the java task to perform.
java.util.Properties	getProperties() Get the properties to initialize the java task.
boolean	isValid(int level)
void	setAttributes(com.highdeal.hci.XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.
void	setClassName(java.lang.String className) Set the class name of the java task to perform.
void	setNodeContext(java.util.Vector props, java.util.Vector renamedProps, java.util.Vector lastPropertyNames, java.util.Vector deletedProps)
void	setProperties(java.util.Properties props) Set the properties to initialize the java task.
void	xmlDescription(com.highdeal.hci.XMLOutputter output)

Methods inherited from class com.highdeal.iec.hci.ActionModelImpl

addCharacterData, addChild, addContextProperty, contextPropertyRemoved, contextPropertyRenamed, countChildren, getChildAt, getChildren, getContext, getDescription, getMaxChildCount, getName, getNodeContext, getParent, insertChildAt, isNull, marshal, removeChildAt, removeContextProperty, renameContextProperty, setChildAt, setDescription, setMaxChildCount, setName, setParent, toString, toXML, updateContext, updateContext, xmlTag

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTY

public static final java.lang.String PROPERTY

See Also:

Constant Field Values

CONTEXT_PROPERTY

public static final java.lang.String CONTEXT_PROPERTY

See Also:

Constant Field Values

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

VALUE

public static final java.lang.String VALUE

See Also:

Constant Field Values

CLASSNAME

public static final java.lang.String CLASSNAME

See Also:

Constant Field Values

Constructor Detail

JavaActionModel

public JavaActionModel()

Creation of an instance of this model.

Method Detail

setClassName

public void setClassName(java.lang.String className)

Set the class name of the java task to perform.

Parameters:

className - the class name of the java task to perform.

getClassName

public java.lang.String getClassName()

Get the class name of the java task to perform.

Returns:

the class name of the java task to perform.

setProperties

public void setProperties(java.util.Properties props)

Set the properties to initialize the java task.

Parameters:

props - the properties to initialize the java task.

getProperties

public java.util.Properties getProperties()

Get the properties to initialize the java task.

Returns:

the properties to initialize the java task.

setNodeContext

public void setNodeContext(java.util.Vector props,
                           java.util.Vector renamedProps,
                           java.util.Vector lastPropertyNames,
                           java.util.Vector deletedProps)

isValid

public boolean isValid(int level)

Specified by:

isValid in interface com.highdeal.iec.hci.ContextualModel

Overrides:

isValid in class com.highdeal.iec.hci.ActionModelImpl

Parameters:

level - ContextualModel.SAVE or ContextualModel.USAGE level.

Returns:

Returns true if the model is valid, false otherwise.

setAttributes

public void setAttributes(com.highdeal.hci.XMLAttributes atts)

Description copied from interface: com.highdeal.hci.XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface com.highdeal.hci.XMLMarshallable

Overrides:

setAttributes in class com.highdeal.iec.hci.ActionModelImpl

Parameters:

atts - the XML attributes of the current element.

addChild

public void addChild(java.lang.String tagName,
                     com.highdeal.hci.XMLMarshallable child)

Description copied from interface: com.highdeal.hci.XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface com.highdeal.hci.XMLMarshallable

Overrides:

addChild in class com.highdeal.iec.hci.ActionModelImpl

Parameters:

tagName - the name of tag for the child.

child - the child to be added.

xmlDescription

public void xmlDescription(com.highdeal.hci.XMLOutputter output)

Overrides:

xmlDescription in class com.highdeal.iec.hci.ActionModelImpl