Package ch.ivyteam.ivy.workflow

Interface IProcessStart

    • Method Detail

      • getName

        String getName()
        Returns the process start name (the name you specify at the process start element's start tab -> on field "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()
        Returns the description (description you can specify at the process start element's start tab -> on field "Description")
        Returns:
        description
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • getRequestPath

        String getRequestPath()

        Gets the request path (only the "<process identifier>" + "/" + startXY.ivp)

        Use getLink() to get a link to start the process.

        Returns:
        request path
        Throws:
        PersistencyException - if persistency access fails
        See Also:
        getLink()
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getUserFriendlyRequestPath

        String getUserFriendlyRequestPath()

        Gets the user friendly request path.

        Use getLink() to get a link to start the process.

        Returns:
        user friendly request path
        Throws:
        PersistencyException - if persistency access fails
        See Also:
        getLink()
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getFullRequestPath

        String getFullRequestPath()

        Gets the request uri inclusive application and process model name.

        Example: {process model}/{request path}

        Use getLink() to get a link to start the process.

        Returns:
        full request path
        Throws:
        PersistencyException - if persistency access fails
        See Also:
        getLink()
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getFullUserFriendlyRequestPath

        String getFullUserFriendlyRequestPath()

        Gets the user friendly request uri incl. application and process model name.

        Example: {process model}/{user friendly request path}

        Use getLink() to get a link to start the process.

        Returns:
        full user friendly reqeust path
        Throws:
        PersistencyException - if persistency access fails
        See Also:
        getLink()
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getProcessModelVersion

        IWorkflowProcessModelVersion getProcessModelVersion()
        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.

      • getId

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

      • getProcessElementId

        String getProcessElementId()
        Gets the process element id of the process start
        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()
        Gets the task start of this process start
        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.

      • getLink

        WebLink getLink()
        Gets a link to start the process.
        Returns:
        WebLink
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • getLinkEmbedded

        WebLink getLinkEmbedded()
        Gets a link to start the process embedded in a frame.
        Returns:
        WebLink
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getActivator

        ISecurityMember getActivator()
        Gets the activator, which one must own to start a case on this start event element
        Returns:
        activator
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.