Package org.sakaiproject.api.app.help

Interface Resource

  • public interface Resource
    Resource in the help system
    Version:
    $Id$

    • Method Detail

      • getDocId

        String getDocId()
        get the doc id for the resource
        Returns:
        doc id

      • setDocId

        void setDocId​(String docId)
        set the doc id for the resource
        Parameters:
        docId -

      • getLocation

        String getLocation()
        get the location of this resource
        Returns:
        location

      • setLocation

        void setLocation​(String source)
        set the location of this resource
        Parameters:
        location -

      • getSource

        String getSource()
        get the source of this resource
        Returns:
        source

      • setSource

        void setSource​(String source)
        set the source of this resource
        Parameters:
        source -

      • getTstamp

        Long getTstamp()
        get the time stamp of this resource
        Returns:
        tstamp

      • setTstamp

        void setTstamp​(Long tstamp)
        set the time stamp of this resource
        Parameters:
        tstamp -

      • getName

        String getName()
        get the name of this resource
        Returns:
        name

      • setName

        void setName​(String name)
        set the name of this resource
        Parameters:
        name -

      • getScore

        float getScore()
        get the score for this resource
        Returns:
        score

      • setScore

        void setScore​(float score)
        set the score for this resource
        Parameters:
        score -

      • getFormattedScore

        String getFormattedScore()
        get the formatted score for this resource
        Returns:
        formatted score

      • setCategory

        void setCategory​(Category category)
        get the category for this resource
        Parameters:
        category -

      • getDefaultForTool

        String getDefaultForTool()
        determine if this document is the default for a tool
        Returns:

      • setDefaultForTool

        void setDefaultForTool​(String defaultForTool)
        set whether this resource is the default for a tool
        Parameters:
        defaultForTool -

      • getWelcomePage

        String getWelcomePage()
        determine if this document welcome page for the help tool
        Returns:

      • setWelcomePage

        void setWelcomePage​(String welcomePage)
        set whether this resource is the welcome page for the tool
        Parameters:
        defaultForTool -