Package ch.ivyteam.ivy.workflow

Interface IIntermediateEventElement

  • public interface IIntermediateEventElement
    Intermediate event element
    Since:
    30.01.2008
    API:
    This is a public API.

    • Method Detail

      • getIntermediateEventBeanClassName

        String getIntermediateEventBeanClassName()
                                  throws PersistencyException
        Gets the class name of the intermediate event bean of the intermediate event element
        Returns:
        intermediate event bean class name
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS IntermediateEventElementReadEventBeanClassName PERMISSION OR OWNS IntermediateEventElementReadEventBeanClassName@SYSTEM PERMISSION

      • getIntermediateEventBeanConfiguration

        String getIntermediateEventBeanConfiguration()
                                      throws PersistencyException
        Gets the configuration string for the intermediate event bean of the intermediate event element
        Returns:
        configuration string
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS IntermediateEventElementReadEventBeanConfiguration PERMISSION OR OWNS IntermediateEventElementReadEventBeanConfiguration@SYSTEM PERMISSION

      • isIntermediateEventBeanEnabled

        boolean isIntermediateEventBeanEnabled()
                                throws PersistencyException
        Is this intermediate event bean enabled to fire
        Returns:
        true if it is enabled to start
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS IntermediateEventElementReadEventBeanEnabled PERMISSION OR OWNS IntermediateEventElementReadEventBeanEnabled@SYSTEM PERMISSION

      • setIntermediateEventBeanEnabled

        void setIntermediateEventBeanEnabled​(boolean enabled)
                              throws PersistencyException
        Sets the enable state of this intermediate event bean.

        • If given enabled is false and the bean is in service state ServiceState.RUNNING, then the bean is stopped and the service state is ServiceState.STOPPED after this call.
        • If given enabled is true, the bean is in service state ServiceState.STOPPED and the IActivity.getActivityState() is ActivityState.ACTIVE, then the bean is started and the service state is ServiceState.RUNNING after this call.
        Parameters:
        enabled - true to set enable, false to set disabled
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS IntermediateEventElementWriteEventBeanEnabled PERMISSION OR OWNS IntermediateEventElementWriteEventBeanEnabled@SYSTEM PERMISSION

      • getProcessModelVersion

        IWorkflowProcessModelVersion getProcessModelVersion()
                                             throws PersistencyException
        Gets the process model version
        Returns:
        process model version
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS ProcessModelVersionRead PERMISSION OR OWNS ProcessModelVersionRead@SYSTEM PERMISSION

      • getId

        long getId()
        Gets the identifier of the intermediate event element
        Returns:
        identifier
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getProcessElementId

        String getProcessElementId()
                    throws PersistencyException
        Gets the process element id of the intermediate event element
        Returns:
        process element id
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getTaskStart

        ITaskStart getTaskStart()
                 throws PersistencyException
        Gets the task start of this intermediate event element
        Returns:
        task start of this process start
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS TaskStartRead PERMISSION OR OWNS TaskStartRead@SYSTEM PERMISSION

      • getName

        String getName()
        throws PersistencyException
        Returns the intermediate event element name
        Returns:
        name of process start
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • getDescription

        String getDescription()
               throws PersistencyException
        Returns the description
        Returns:
        description
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • findIntermediateEvents

        IQueryResult<IIntermediateEvent> findIntermediateEvents​(IPropertyFilter<IntermediateEventProperty> filter,
                                                        List<PropertyOrder<IntermediateEventProperty>> order,
                                                        int startIndex,
                                                        int count,
                                                        boolean returnAllCount)
                                                 throws PersistencyException
        Gets the intermediate events that were created by this intermediate event element
        Parameters:
        filter - a filter to filter the returned intermediate events. Maybe null.
        order - an order to order the returned intermediate events. Maybe null.
        startIndex - the index of the first intermediate events of all intermediate events that is returned in the result
        count - the number of intermediate events to return in the result
        returnAllCount - if true the query result method IQueryResult.getAllCount() returns the overall intermediate events that have been found, if false it returns -1
        Returns:
        a query result with the intermediate events
        Throws:
        PersistencyException - if persistency exception fails
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.
        Security:
        SESSION OWNS IntermediateEventReadAll PERMISSION OR OWNS IntermediateEventReadAll@SYSTEM PERMISSION