Package ch.ivyteam.ivy.workflow

Interface IPageArchive

  • public interface IPageArchive
    The page archive holds an html form and the information a user has filled into that html form.
    Since:
    17.05.2006
    API:
    This is a public API.

    • Method Detail

      • getId

        long getId()
        Gets the identifier of this page archive
        Returns:
        task identifier
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getTask

        ITask getTask()
       throws PersistencyException
        Gets the task which was running as this page was filled in.
        Returns:
        the task
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS TaskRead PERMISSION OR OWNS TaskRead@SYSTEM PERMISSION

      • getPageContent

        String getPageContent()
               throws PersistencyException
        Gets the page content
        Returns:
        page content
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getPageContentType

        String getPageContentType()
                   throws PersistencyException
        Gets the page content type
        Returns:
        page content type
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getFormData

        String getFormData()
            throws PersistencyException
        Gets the form data
        Returns:
        form data
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getUserName

        String getUserName()
            throws PersistencyException
        Gets the user name of the user who has filled in the form
        Returns:
        user name
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getSubmitTimestamp

        Date getSubmitTimestamp()
                 throws PersistencyException
        Gets the timestamp when the user has submitted the page
        Returns:
        submit timestamp
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getOriginalTemplateUri

        String getOriginalTemplateUri()
                       throws PersistencyException
        Gets the original template uri
        Returns:
        original template uri
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.

      • getName

        String getName()
        throws PersistencyException
        Gets the name of the page archive.
        Returns:
        name of the page archive
        Throws:
        PersistencyException - if persistency access fails
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.