Package ch.ivyteam.ivy.workflow

Interface IWebServiceProcess

  • public interface IWebServiceProcess

    Holds configuration information about a web service process in a PMV. This model is persisted with the PMV.

    IvyScript Example to get the IWebServiceProcesses from a PMV:

    import ch.ivyteam.ivy.workflow.WorkflowNavigationUtil;
    import ch.ivyteam.ivy.workflow.IWebServiceProcess;

    List<IWebServiceProcess> webServiceProcesses;
    webServiceProcesses = new java.util.ArrayList(WorkflowNavigationUtil.getWorkflowProcessModelVersion(ivy.request.getProcessModelVersion()).getWebServiceProcesses());

    Since:
    26.07.2010
    API:
    This is a public API.

    • Method Detail

      • getProcessIdentifier

        String getProcessIdentifier()
        Gets the process identifier of the process that implements the web service.
        Returns:
        process identifier. Never null nor empty.
        Throws:
        PersistencyException
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getName

        String getName()
        Gets the name of the web service process
        Returns:
        name. Never null.
        Throws:
        PersistencyException
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • getDescription

        String getDescription()
        Gets the description of the web service process
        Returns:
        description. Never null.
        Throws:
        PersistencyException
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.

      • getWebServiceImplementationClassName

        String getWebServiceImplementationClassName()
        Gets the name of the stub class for the web service framework. This class is responsible for the parameter mapping and the execution of the web service process.
        Returns:
        web service implementation class name. Never null.
        Throws:
        PersistencyException
        API:
        This public API is available in IvyScript and Java. It has the visibility EXPERT.

      • getWebServiceProcessStartElements

        Set<IWebServiceProcessStartElement> getWebServiceProcessStartElements()
        Gets all web service process start elements of this web service process
        Returns:
        set of web service process starts. Maybe empty. Never null.
        Throws:
        PersistencyException
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • findWebServiceProcessStartElement

        IWebServiceProcessStartElement findWebServiceProcessStartElement​(String signature)
        Finds a web service process start element with the given signature
        Parameters:
        signature - the signature of the web service process start
        Returns:
        the web service process start element with the given signature or null.
        Throws:
        PersistencyException
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getProcessModelVersion

        IWorkflowProcessModelVersion getProcessModelVersion()
        Gives the process model version this web service process belongs to
        Returns:
        process model version. Never null.
        Throws:
        PersistencyException
        API:
        This public API is available in IvyScript and Java. It has the visibility NOVICE.