Package org.silverpeas.core.workflow.api.model

Interface ProcessModel

  • All Known Implementing Classes:
    ProcessModelImpl
    public interface ProcessModel
    Interface describing a representation of the main <processModel> element of a Process Model. The entry point to reading and manipulating the whole Process Model.

    • Method Detail

      • getModelId

        String getModelId()
        Get the id of this process model
        Returns:
        process model id

      • setModelId

        void setModelId​(String modelId)
        Set the id of this process model
        Parameters:
        modelId - process model id

      • getName

        String getName()
        Get the name of this process model
        Returns:
        process model's name

      • setName

        void setName​(String name)
        Set the name of this process model
        Parameters:
        name - model's name

      • getLabel

        String getLabel​(String role,
                String language)
        Get label in specific language for the given role
        Parameters:
        language - label's language
        role - role for which the label is
        Returns:
        wanted label as a String object. If label is not found, search label with given role and default language, if not found again, return the default label in given language, if not found again, return the default label in default language, if not found again, return empty string.

      • getLabels

        ContextualDesignations getLabels()
        Get all the labels
        Returns:
        an object containing the collection of the labels

      • getDescription

        String getDescription​(String role,
                      String language)
        Get description in specific language for the given role
        Parameters:
        role - role for which the description is
        Returns:
        wanted description as a String object. If description is not found, search description with given role and default language, if not found again, return the default description in given language, if not found again, return the default description in default language, if not found again, return empty string.

      • getDescriptions

        ContextualDesignations getDescriptions()
        Get all the descriptions
        Returns:
        an object containing the collection of the descriptions

      • getPresentation

        Presentation getPresentation()
        Get the presentation configuration
        Returns:
        presentation configuration

      • setPresentation

        void setPresentation​(Presentation presentation)
        Set the presentation's configuration
        Parameters:
        presentation - presentation's configuration

      • createPresentation

        Presentation createPresentation()
        Create a Presentation
        Returns:
        an object implementing Presentation

      • getParticipants

        Participant[] getParticipants()
        Get the participants definition
        Returns:
        participants definition

      • getParticipantsEx

        Participants getParticipantsEx()
        Get all the participants definitions

      • setParticipants

        void setParticipants​(Participants participants)
        Set the participants definition
        Parameters:
        participants - participants definition

      • createParticipants

        Participants createParticipants()
        Create Participants
        Returns:
        an object implementing Participants

      • getRoles

        Role[] getRoles()
        Get the roles definition
        Returns:
        roles definition

      • getRolesEx

        Roles getRolesEx()
        Get the Roles definitions

      • getRole

        Role getRole​(String name)
        Get the role definition with given name
        Parameters:
        name - role name
        Returns:
        wanted role definition

      • setRoles

        void setRoles​(Roles roles)
        Set the roles definition
        Parameters:
        roles - roles definition

      • createRoles

        Roles createRoles()
        Create Roles
        Returns:
        an object implementing Roles

      • getStates

        State[] getStates()
        Get the states defined for this process model
        Returns:
        states defined for this process model

      • getStatesEx

        States getStatesEx()
        Get the states definitions

      • getState

        State getState​(String name)
        Get the state definition with given name
        Parameters:
        name - state name
        Returns:
        wanted state definition

      • setStates

        void setStates​(States states)
        Set the states defined for this process model
        Parameters:
        states - states defined for this process model

      • createStates

        States createStates()
        Create States
        Returns:
        an object implementing States

      • getActions

        Action[] getActions()
        Get the actions defined for this process model
        Returns:
        actions defined for this process model

      • getActionsEx

        Actions getActionsEx()
        Get the actions definitions

      • setActions

        void setActions​(Actions actions)
        Set the actions defined for this process model
        Parameters:
        actions - actions defined for this process model

      • createActions

        Actions createActions()
        Create Actions
        Returns:
        an object implementing Actions

      • getDataFolder

        DataFolder getDataFolder()
        Get the data folder defined for this process model
        Returns:
        data folder defined for this process model. it contains all the items declarations

      • setDataFolder

        void setDataFolder​(DataFolder dataFolder)
        Set the data folder for this process model
        Parameters:
        dataFolder - folder for this process model. it contains all the items declarations

      • createDataFolder

        DataFolder createDataFolder()
        Create DataFolder
        Returns:
        an object implementing DataFolder

      • getUserInfos

        DataFolder getUserInfos()
        Get the user infos defined for this process model
        Returns:
        user infos defined for this process model. It contains all the items necessary about user to allow him to use the instance

      • setUserInfos

        void setUserInfos​(DataFolder userInfos)
        Set the user infos defined for this process model It contains all the items necessary about user to allow him to use the instance
        Parameters:
        userInfos - user infos defined for this process model.

      • getForms

        Forms getForms()
        Get the forms definitions

      • getForm

        Form getForm​(String name)
        Get the form definition with given name
        Parameters:
        name - action form
        Returns:
        wanted form definition

      • getForm

        Form getForm​(String name,
             String role)
        Get the form definition with given name for the given role
        Parameters:
        name - action form
        Returns:
        wanted form definition

      • setForms

        void setForms​(Forms forms)
        Set the forms defined for this process model
        Parameters:
        forms - forms defined for this process model.

      • createForms

        Forms createForms()
        Create Forms
        Returns:
        an object implementing Forms

      • createQualifiedUsers

        QualifiedUsers createQualifiedUsers()
        Create an object implementing QualifiedUsers

      • createRelatedUser

        RelatedUser createRelatedUser()
        Create an object implementing RelatedUser

      • getFolderRecordSetName

        String getFolderRecordSetName()

      • getFormRecordSetName

        String getFormRecordSetName​(String formName)

      • getActionForm

        Form getActionForm​(String actionName)
            throws WorkflowException
        Returns the form (if any) associated to the named action. Returns null if the action has no form. Throws a WorkflowException if the action is unknown.
        Throws:
        WorkflowException

      • getPublicationForm

        Form getPublicationForm​(String actionName,
                        String role,
                        String language)
                 throws WorkflowException
        Returns the Form which be used to publish the form associated to the named action. Returns null if the action has no form. Throws a WorkflowException if the action is unknown.
        Throws:
        WorkflowException

      • getPresentationForm

        Form getPresentationForm​(String name,
                         String role,
                         String language)
                  throws WorkflowException
        Returns the Form which be used to publish the named form. We can give an action name too. Returns null if the action exists but has no form. Throws a WorkflowException if the action/form is unknown.
        Throws:
        WorkflowException

      • getAllDataTemplate

        RecordTemplate getAllDataTemplate​(String role,
                                  String lang)
        Returns the RecordTemplate which describes all the data of the process instance built from this model.

      • getRowTemplate

        RecordTemplate getRowTemplate​(String role,
                              String lang)
        Returns the RecordTemplate which describes a process instance in a row.

      • getRowTemplate

        RecordTemplate getRowTemplate​(String role,
                              String lang,
                              boolean isProcessIdVisible)
        Returns the RecordTemplate which describes a process instance in a row.

      • getNewActionRecord

        DataRecord getNewActionRecord​(String actionName,
                              String roleName,
                              String lang,
                              DataRecord data)
                       throws WorkflowException
        Returns an empty DataRecord which must be filled in order to process the named action. Returns null if no form is required to process this action. Throws a WorkflowException if the action is unknown.
        Throws:
        WorkflowException

      • getNewUserInfosRecord

        DataRecord getNewUserInfosRecord​(String roleName,
                                 String lang)
                          throws WorkflowException
        Returns an empty DataRecord which must be filled in order to fill the user information Throws a WorkflowException if problem encountered.
        Throws:
        WorkflowException