org.dlese.dpc.schemedit.standards
Class CATServiceHelper

java.lang.Object
  org.dlese.dpc.schemedit.standards.CATServiceHelper

All Implemented Interfaces:

SuggestionServiceHelper

Direct Known Subclasses:

AsnSuggestionServiceHelper, CommCoreServiceHelper, DleseSuggestionServiceHelper, TeachersDomainServiceHelper

public abstract class CATServiceHelper
extends Object
implements SuggestionServiceHelper

Run-time support for CAT suggestion service, which acts as intermediary between CAT Service client and Form bean/JSP pages.

The CAT service UI involves extraction of several values from the item record being edited for each framework, such as selected keywords, selected graderanges, etc. The functionality to extract these values is delegated to the framework-specific plug-in, which implments CATHelperPlugin.

Author:

ostwald

Field Summary

static String	ALL_CONTENT NOT YET DOCUMENTED
static String	BOTH_CONTENT NOT YET DOCUMENTED
static String	LIST_MODE NOT YET DOCUMENTED
static String	SELECTED_CONTENT NOT YET DOCUMENTED
static String	SUGGESTIONS_CONTENT NOT YET DOCUMENTED
static String	TREE_MODE NOT YET DOCUMENTED

Constructor Summary

CATServiceHelper(SchemEditForm sef, CATHelperPlugin frameworkPlugin)
Constructor for the CATServiceHelper object

Method Summary

void	displaySuggestions(List standardsList) Debugging
SchemEditForm	getActionForm() Gets the actionForm attribute of the CATServiceHelper object
String	getAuthor() Resolves author from the asnDocument (which it gets from the StandardsDocument)
List	getAvailableDocs() Gets the availableDocs attribute of the CATServiceHelper object
protected CATRequestConstraints	getConstraints() Build a MetadataContraint instance from current CATServiceHelper attributes, including keywords, description, gradeRanges (when the corresponding "use" attributes return true).
String	getCurrentDoc() Gets the currentDoc attribute of the CATServiceHelper object
String	getDerivedCATEndGrade() Gets the gradeRangeOptionValue corresponding to the highest selected gradeRange in the current instance document.
String	getDerivedCATStartGrade() Gets the gradeRangeOptionValue corresponding to the lowest selected gradeRange in the current instance document.
String	getDisplayContent() Determines what standards to display (SUGGESTED_CONTENT, STANDARDS_CONTENT, BOTH, ALL)
String	getDisplayMode() Determines whether standards are displayed as a heirarchical tree or flat list.
protected MetaDataFramework	getFramework() Gets the framework attribute of the CATServiceHelper object
CATHelperPlugin	getFrameworkPlugin() Gets the frameworkPlugin attribute of the SuggestionServiceHelper object
List	getGradeRangeOptions() Gets the gradeRanges corresponding to the grades searchable in the current framework
protected abstract String	getIdFromCATStandard(CATStandard std) Gets the idFromCATStandard attribute of the CATServiceHelper object
static CATServiceHelper	getInstance(SchemEditForm sef) Gets the instance attribute of the CATServiceHelper class
protected Document	getInstanceDocument() Gets the document attribute of the CATServiceHelper object
int	getKeywordWeighting()
int	getNumSelectedStandards() Gets the numSelectedStandards attribute of the CATServiceHelper object
List	getOptionalCatUIFields() Gets a list specifying what optional fields (e.g., "subject", "keyword") is exported by this framework.
Map	getOtherSelectedStandards() Gets the otherSelectedStandards attribute of the CATServiceHelper object
String	getRecordDescription() Gets the value of the description field of the current metadata record
String[]	getRecordGradeRanges() Gets the gradeRanges assigned for the current record
String[]	getRecordKeywords() Gets the value of the description field of the current metadata record
String[]	getRecordSubjects() Gets the recordSubjects attribute of the CATServiceHelper object
String	getRecordUrl() Gets the recordUrl specified in the instance document (via the SchemEditForm).
StandardsNode	getRootStandardNode() Gets the rootStandardNode attribute of the CATServiceHelper object
String[]