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

Interface Presentation

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    PresentationImpl
    public interface Presentation
extends Serializable
    Interface describing a representation of the <presentation> element of a Process Model.

    • Method Detail

      • getTitle

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

      • getTitles

        ContextualDesignations getTitles()
        Get all the titles
        Returns:
        an object containing the collection of the titles

      • getColumns

        Column[] getColumns​(String roleName)
        Get the contents of the Columns object with the given role name, or of the 'Columns' for the default role if nothing for the specified role can be found.
        Parameters:
        roleName - the name of the role
        Returns:
        the contents of 'Columns' as an array of 'Column'

      • getColumnsByRole

        Columns getColumnsByRole​(String strRoleName)
        Get the Columns object referenced by the given role name
        Parameters:
        strRoleName - the name of the Columns object
        Returns:
        a Columns implementation

      • iterateColumns

        Iterator<Columns> iterateColumns()
        Iterate through the Column objects
        Returns:
        an iterator

      • addColumns

        void addColumns​(Columns columns)
        Add an column to the collection
        Parameters:
        columns - to be added

      • createColumns

        Columns createColumns()
        Create an Column
        Returns:
        an object implementing Column

      • deleteColumns

        void deleteColumns​(String strRoleName)
            throws WorkflowException
        Delete the Columns object with the given name
        Parameters:
        strRoleName - the name of the Columns object (a role name)
        Throws:
        WorkflowException - when the Columns for the given name have not been found.