Package 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 Java class represents a Java action that can be set in a scenario file of an SAP CC Import/Export Connector (IEC) application; Your customized class can be processed by the IEC application at runtime.

Implementation in Your Customized IEC Application

You must develop a Java class that extends the JavaTask abstract class.

During the execution of a scenario, two methods are invoked by the running IEC application:

It can access to other features regarding the following implementations:

  • JavaTaskStateListener
    • The method stateTerminated(..) is invoked when the last action has fully treated the current DataCollection
    • The method stateRejected(..) is invoked when an action rejected the current DataCollection. The reasons are explained in the arguments
    • The method stateFiltered(..) is invoked when an action filtered the current DataCollection is fully treated
  • JavaTaskIterator
      • While the method "boolean hasNext(DataCollection collection)" returns true,
      invoke the method "execute(DataCollection collection)" with the same DataCollection
  • JavaTaskInitializable
    • Invoke the method setUp(DataCollection collection) before:
      • The invocation of the execute method when the Java task is not a JavaTaskIterator
      • The iterations when the Java task is not a JavaTaskIterator
    • Invoke the method tearDown(DataCollection collection) after:
      • The invocation of the execute method when the Java task is not a JavaTaskIterator
      • The iterations when the Java task is not a JavaTaskIterator

Additional Information

Consult the primary help of the SAP CC Connector Administration Tool (CAT Tool) in the related documentation about how to create and configure a scenario and how to add a Java Action component to this scenario file.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    CLASSNAME
     
    static final String
    CONTEXT_PROPERTY
     
    static final String
    NAME
     
    static final String
    PROPERTY
     
    static final String
    TYPE
     
    static final 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

    Constructors
    Constructor
    Description
    JavaActionModel()
    Creation of an instance of this model.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addChild(String tagName, com.highdeal.hci.XMLMarshallable child)
     
    String
    getClassName()
    Gets the class name of the Java task to perform.
    Properties
    getProperties()
    Gets the properties to initialize the Java task.
    boolean
    isValid(int level)
     
    void
    setAttributes(com.highdeal.hci.XMLAttributes atts)
     
    void
    setClassName(String className)
    Sets the class name of the Java task to perform.
    void
    setNodeContext(Vector props, Vector renamedProps, Vector lastPropertyNames, Vector deletedProps)
     
    void
    setProperties(Properties props)
    Sets 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 Details

  • Constructor Details

    • JavaActionModel

      public JavaActionModel()
      Creation of an instance of this model.

  • Method Details

    • setClassName

      public void setClassName(String className)
      Sets the class name of the Java task to perform.
      Parameters:
      className - The class name of the Java task to perform

    • getClassName

      public String getClassName()
      Gets the class name of the Java task to perform.
      Returns:
      The class name of the Java task to perform

    • setProperties

      public void setProperties(Properties props)
      Sets the properties to initialize the Java task.
      Parameters:
      props - The properties to initialize the Java task

    • getProperties

      public Properties getProperties()
      Gets the properties to initialize the Java task.
      Returns:
      The properties to initialize the Java task

    • setNodeContext

      public void setNodeContext(Vector props, Vector renamedProps, Vector lastPropertyNames, 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)
      Specified by:
      setAttributes in interface com.highdeal.hci.XMLMarshallable
      Overrides:
      setAttributes in class com.highdeal.iec.hci.ActionModelImpl

    • addChild

      public void addChild(String tagName, com.highdeal.hci.XMLMarshallable child)
      Specified by:
      addChild in interface com.highdeal.hci.XMLMarshallable
      Overrides:
      addChild in class com.highdeal.iec.hci.ActionModelImpl

    • xmlDescription

      public void xmlDescription(com.highdeal.hci.XMLOutputter output)
      Overrides:
      xmlDescription in class com.highdeal.iec.hci.ActionModelImpl