org.dlese.dpc.schemedit.standards
Interface CATHelperPlugin

All Known Implementing Classes:

AbstractCATHelperPlugin, AdnFrameworkPlugin, AsnCATPlugin, CommCoreFrameworkPlugin, EngPathFrameworkPlugin, MastFrameworkPlugin, Msp2FrameworkPlugin, NcsAnnoFrameworkPlugin, NcsItemFrameworkPlugin, ResQualFrameworkPlugin, TeachersDomainFrameworkPlugin

public interface CATHelperPlugin

Interface for framework-specific plugins to the CATServiceHelper

Author:

ostwald

Method Summary

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.
List	getGradeRangeOptions() Gets the gradeRangeOptions for this framework
List	getOptionalCatUIFields() Gets a list specifying what optional fields (e.g., "subject", "keyword") is exported by this framework.
String	getRecordDescription() Gets the recordDescription for the current record
String[]	getRecordGradeRanges() Gets the recordGradeRanges for the current record
String[]	getRecordKeywords() Gets the recordKeywords for the current record
String[]	getRecordSubjects() Gets the recordSubjects for the current record
int	getSelectedCATEndGrade(String[] gradeConstraints)
int	getSelectedCATStartGrade(String[] gradeConstraints)
void	init(CATServiceHelper helper) Initialize the plugin with a CATServiceHelper instance

Method Detail

init

void init(CATServiceHelper helper)

Initialize the plugin with a CATServiceHelper instance

Parameters:

helper - NOT YET DOCUMENTED

getOptionalCatUIFields

List getOptionalCatUIFields()

Gets a list specifying what optional fields (e.g., "subject", "keyword") is exported by this framework. The UI controls for these fields will be active.

Returns:

The optionalCatUIFields value

getRecordDescription

String getRecordDescription()

Gets the recordDescription for the current record

Returns:

The recordDescription value

getRecordKeywords

String[] getRecordKeywords()

Gets the recordKeywords for the current record

Returns:

The recordKeywords value

getRecordGradeRanges

String[] getRecordGradeRanges()

Gets the recordGradeRanges for the current record

Returns:

The recordGradeRanges 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

getRecordSubjects

String[] getRecordSubjects()

Gets the recordSubjects for the current record

Returns:

The recordSubjects value

getGradeRangeOptions

List getGradeRangeOptions()

Gets the gradeRangeOptions for this framework

Returns:

The gradeRangeOptions value

getSelectedCATEndGrade

int getSelectedCATEndGrade(String[] gradeConstraints)

getSelectedCATStartGrade

int getSelectedCATStartGrade(String[] gradeConstraints)