Uploaded image for project: 'Sakai'
  1. Sakai
  2. SAK-39389

Enable tool grouping modification through service changes in kernel

    XMLWordPrintable

    Details

    • Type: Feature Request
    • Status: Verified
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: 10.0
    • Fix Version/s: 2.9.x
    • Component/s: Kernel
    • Labels:
    • Previous Issue Keys:
      KNL-989

      Description

      In order to support the optional, alternate toolOrder.xml file format described by SAK-16600, we propose the following changes:

      1) Add the following new methods to ServerConfigurationService, for pulling the additional definitions out of the toolOrder.xml file:

      /**

      • Access the list of tools by group
        *
      • @param category
      • The tool category
      • @return An unordered list of tool ids (String) in selected group, or an empty list if there are none for this category.
        */
        List getToolGroup(String category);

      /**

      • Access the list of tool ids in order for this category, to impose on the displays of many tools
        *
      • @param category Site type
      • @return An unordered list of group names (String), or an empty list if there are none for this category.
        */
        List<String> getToolOrder(String category);

      /*

      • Returns true if selected tool is contained in pre-initialized list of selected items
      • @parms toolId id of the selected tool
        */
        public boolean toolGroupIsSelected(String groupName, String toolId) ;

      /*

      • Returns true if selected tool is contained in pre-initialized list of required items
      • @parms toolId id of the selected tool
        */
        public boolean toolGroupIsRequired(String groupName, String toolId);

      /**

      • Access the list of groups by category (site type)
        *
      • @param category
      • The tool category
      • @return An ordered list of tool ids (String) indicating the desired tool display order, or an empty list if there are none for this category.
        */

      2) Dependent on the sakai.properties value of config.sitemanage.useToolGroup, the current default toolOrder.xml file format will be parsed with the loadToolOrder() method or the loadToolGroups() method. The default value is false, to use the current default file format.

      See SAK-16600 for sample toolOrder.xml file

        Gliffy Diagrams

          Zeplin

            Attachments

              Issue Links

                Activity

                  People

                  • Assignee:
                    bkirschn Beth Kirschner
                    Reporter:
                    phaggood Patrick Haggood (Inactive)
                  • Votes:
                    0 Vote for this issue
                    Watchers:
                    3 Start watching this issue

                    Dates

                    • Created:
                      Updated:
                      Resolved:

                      Git Integration