Package org.dlese.dpc.schemedit.standards

Interface SuggestionServiceHelper

All Known Implementing Classes:
AsnSuggestionServiceHelper, CATServiceHelper, CommCoreServiceHelper, DleseSuggestionServiceHelper, ResQualSuggestionServiceHelper, TeachersDomainServiceHelper
public interface SuggestionServiceHelper
Run-time support for handling interaction with user in the context of content standard assignment aided by a suggestionService (e.g., CAT).

Has access to the the current instanceDocument (in the metadata editor), and retrieves suggestions from the suggestion service.

Author:
ostwald
See Also:

  • Method Details

    • getServiceIsActive

      boolean getServiceIsActive()
      Gets the serviceIsActive attribute of the SuggestionServiceHelper object
      Returns:
      true if the SuggestionService is available

    • getStandardsManager

      StandardsManager getStandardsManager()
      Gets the standardsManager attribute of the SuggestionServiceHelper object
      Returns:
      The standardsManager value

    • getXpath

      String getXpath()
      Gets the xpath of the metadata element containing the managedStandards
      Returns:
      The xpath value

    • getXmlFormat

      String getXmlFormat()
      Gets the xmlFormat attribute of the SuggestionServiceHelper object
      Returns:
      The xmlFormat value

    • getSuggestedStandards

      List getSuggestedStandards()
      Gets the suggested Standards represented in ADN format.
      Returns:
      The suggestedStandards value

    • getNumSelectedStandards

      int getNumSelectedStandards()
      Gets the numSelectedStandards attribute of the SuggestionServiceHelper object
      Returns:
      The numSelectedStandards value

    • getSelectedStandards

      List getSelectedStandards()
      Gets the standards that are selected in the instanceDoc
      Returns:
      The selectedStandards value

    • setSuggestedStandards

      void setSuggestedStandards(List stds)
      Sets the suggestedStandards attribute of the SuggestionServiceHelper object
      Parameters:
      stds - The new suggestedStandards value

    • getDisplayMode

      String getDisplayMode()
      Determines whether standards are displayed as a heirarchical tree or flat list.
      Returns:
      e.g., LIST_MODE for list mode, TREE_MODE for tree mode.

    • getDisplayContent

      String getDisplayContent()
      Determines what standards to display (e.g., SUGGESTED_CONTENT, STANDARDS_CONTENT, BOTH, ALL)
      Returns:
      The displayContent value

    • getCurrentDoc

      String getCurrentDoc()
      Gets the currentDoc attribute of the SuggestionServiceHelper object
      Returns:
      The currentDoc value

    • updateSuggestions

      void updateSuggestions() throws Exception
      Update suggestedStandards by performing a query on the SuggestionService using current constraints.
      Throws:
      Exception - NOT YET DOCUMENTED

    • getUrl

      String getUrl()
      Gets the url attribute of the SuggestionServiceHelper object
      Returns:
      The url value

    • getRecordUrl

      String getRecordUrl()
      Gets the url of the instance document
      Returns:
      The recordUrl value

    • getDerivedCATStartGrade

      String getDerivedCATStartGrade()
      Gets the gradeRangeOptionValue corresponding to the lowest selected gradeRange in the current instance document.

      NOTE: this requires converting from possible gradeRange metadata values to the values supplied for gradeRangeOptions.

      Returns:
      The startGrade value

    • getDerivedCATEndGrade

      String getDerivedCATEndGrade()
      Gets the gradeRangeOptionValue corresponding to the highest selected gradeRange in the current instance document.

      NOTE: this requires converting from possible gradeRange metadata values to the values supplied for gradeRangeOptions.

      Returns:
      The endGrade value

    • updateStandardsDisplay

      void updateStandardsDisplay(String displayContent) throws Exception
      Hides and exposes nodes in the hierarchical standards display.
      Parameters:
      displayContent - Description of the Parameter
      Throws:
      Exception - NOT YET DOCUMENTED