Class AbstractCallableActor

    • Field Detail

      • BACKUP_CALLABLEACTOR

        public static final String BACKUP_CALLABLEACTOR
        the key for backing up the callable actor.
        See Also:
        Constant Field Values
      • BACKUP_CONFIGURED

        public static final String BACKUP_CONFIGURED
        the key for backing up the configured state.
        See Also:
        Constant Field Values
      • m_CallableActor

        protected Actor m_CallableActor
        the callable actor.
      • m_Configured

        protected boolean m_Configured
        whether the callable actor has been configured.
      • m_Optional

        protected boolean m_Optional
        whether the callable actor is optional.
    • Constructor Detail

      • AbstractCallableActor

        public AbstractCallableActor()
    • Method Detail

      • reset

        protected void reset()
        Resets the scheme.
        Overrides:
        reset in class AbstractActor
      • setCallableName

        public void setCallableName​(CallableActorReference value)
        Sets the name of the callable actor to use.
        Parameters:
        value - the callable name
      • getCallableName

        public CallableActorReference getCallableName()
        Returns the name of the callable actor in use.
        Returns:
        the callable name
      • callableNameTipText

        public String callableNameTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • setOptional

        public void setOptional​(boolean value)
        Sets whether the callable actor is optional.
        Parameters:
        value - true if optional
      • getOptional

        public boolean getOptional()
        Returns whether the callable actor is optional.
        Returns:
        true if optional
      • optionalTipText

        public String optionalTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.
      • findCallableActor

        protected Actor findCallableActor()
        Tries to find the callable actor referenced by its callable name.
        Returns:
        the callable actor or null if not found
      • hasCallableActor

        public boolean hasCallableActor()
        Checks whether a reference to the callable actor is currently available.
        Returns:
        true if a reference is available
        See Also:
        getCallableActor()
      • getCallableActor

        public Actor getCallableActor()
        Returns the currently set callable actor.
        Specified by:
        getCallableActor in interface CallableActorUser
        Returns:
        the actor, can be null
      • setUpCallableActor

        protected String setUpCallableActor()
        Configures the callable actor.
        Returns:
        null if successful, otherwise error message
      • executeCallableActor

        protected abstract String executeCallableActor()
        Executes the callable actor. Derived classes might need to override this method to ensure atomicity.
        Returns:
        null if no error, otherwise error message
      • doExecute

        protected String doExecute()
        Executes the flow item.
        Specified by:
        doExecute in class AbstractActor
        Returns:
        null if everything is fine, otherwise error message
      • isFinished

        public boolean isFinished()
        Returns whether the actor has finished.
        Specified by:
        isFinished in interface Actor
        Overrides:
        isFinished in class AbstractActor
        Returns:
        true if finished