Class AbstractOsidRuleApplicatorForm

java.lang.Object

net.okapia.osid.jamocha.spi.AbstractIdentifiable

net.okapia.osid.jamocha.spi.AbstractOsidForm

net.okapia.osid.jamocha.spi.AbstractOsidExtensibleForm

net.okapia.osid.jamocha.spi.AbstractOsidBrowsableForm

net.okapia.osid.jamocha.spi.AbstractOsidObjectForm

net.okapia.osid.jamocha.spi.AbstractOperableOsidObjectForm

net.okapia.osid.jamocha.spi.AbstractOsidRuleForm

net.okapia.osid.jamocha.spi.AbstractOsidEnablerForm

net.okapia.osid.jamocha.spi.AbstractOsidRuleApplicatorForm

All Implemented Interfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidEnablerForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleApplicatorForm, OsidRuleForm, OsidTemporalForm, Suppliable

public abstract class AbstractOsidRuleApplicatorForm
extends AbstractOsidEnablerForm
implements OsidRuleApplicatorForm

A basic OsidRuleApplicatorForm.

Nested Class Summary

Nested classes/interfaces inherited from class AbstractOperableOsidObjectForm

AbstractOperableOsidObjectForm.OsidOperableForm

Modifier and Type	Class	Description
protected class	AbstractOperableOsidObjectForm.OsidOperableForm	Defines an OsidOperableForm.

Nested classes/interfaces inherited from class AbstractOsidExtensibleForm

AbstractOsidExtensibleForm.Extensible

Modifier and Type	Class	Description
protected class	AbstractOsidExtensibleForm.Extensible	Defines an Extensible.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractOsidRuleApplicatorForm(Locale locale, boolean update)	Constructs a new AbstractOsidRuleApplicatorForm.

Method Summary

Modifier and Type	Method	Description
void	clearResource()	Clears the resource.
protected Id	getResourceId()	Returns the current resource value.
Metadata	getResourceMetadata()	Gets the metadata for the resource.
protected boolean	isResourceCleared()	Tests if the resource has been cleared in this form.
protected boolean	isResourceSet()	Tests if the resource has been set in this form.
void	setResource(Id resourceId)	Sets the resource.
protected void	setResourceMetadata(Metadata metadata)	Sets the resource metadata.

Methods inherited from class AbstractOsidEnablerForm

clearCyclicEvent, clearCyclicTimePeriod, clearEndDate, clearEvent, clearRequirement, clearSchedule, clearStartDate, clearTimePeriod, getCyclicEventId, getCyclicEventMetadata, getCyclicTimePeriodId, getCyclicTimePeriodPeriodMetadata, getEndDate, getEndDateMetadata, getEventId, getEventMetadata, getRequirement, getRequirementMetadata, getScheduleId, getScheduleMetadata, getStartDate, getStartDateMetadata, getTimePeriodId, getTimePeriodPeriodMetadata, isCyclicEventCleared, isCyclicEventSet, isCyclicTimePeriodCleared, isCyclicTimePeriodSet, isEndDateCleared, isEndDateSet, isEventCleared, isEventSet, isRequirementCleared, isRequirementSet, isScheduleCleared, isScheduleSet, isStartDateCleared, isStartDateSet, isTimePeriodCleared, isTimePeriodSet, setCyclicEvent, setCyclicEventMetadata, setCyclicTimePeriod, setCyclicTimePeriodMetadata, setEndDate, setEndDateMetadata, setEvent, setEventMetadata, setRequirement, setRequirementMetadata, setSchedule, setScheduleMetadata, setStartDate, setStartDateMetadata, setTimePeriod, setTimePeriodMetadata

Modifier and Type	Method	Description
void	clearCyclicEvent()	Clears the cyclic event.
void	clearCyclicTimePeriod()	Clears the cyclic time period.
void	clearEndDate()	Clears the end date.
void	clearEvent()	Clears the event.
void	clearRequirement()	Clears the requirement.
void	clearSchedule()	Clears the schedule.
void	clearStartDate()	Clears the start date.
void	clearTimePeriod()	Clears the time period.
protected Id	getCyclicEventId()	Returns the current cyclic event value.
Metadata	getCyclicEventMetadata()	Gets the metadata for the cyclic event.
protected Id	getCyclicTimePeriodId()	Returns the current cyclic time period value.
Metadata	getCyclicTimePeriodPeriodMetadata()	Gets the metadata for the cyclic time period.
protected DateTime	getEndDate()	Returns the current end date value.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
protected Id	getEventId()	Returns the current event value.
Metadata	getEventMetadata()	Gets the metadata for the event.
protected boolean	getRequirement()	Returns the current requirement value.
Metadata	getRequirementMetadata()	Gets the metadata for the requirement.
protected Id	getScheduleId()	Returns the current schedule value.
Metadata	getScheduleMetadata()	Gets the metadata for the schedule.
protected DateTime	getStartDate()	Returns the current start date value.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
protected Id	getTimePeriodId()	Returns the current time period value.
Metadata	getTimePeriodPeriodMetadata()	Gets the metadata for the time period.
protected boolean	isCyclicEventCleared()	Tests if the cyclic event has been cleared in this form.
protected boolean	isCyclicEventSet()	Tests if the cyclic event has been set in this form.
protected boolean	isCyclicTimePeriodCleared()	Tests if the cyclic time period has been cleared in this form.
protected boolean	isCyclicTimePeriodSet()	Tests if the cyclic time period has been set in this form.
protected boolean	isEndDateCleared()	Tests if the end date has been cleared in this form.
protected boolean	isEndDateSet()	Tests if the end date has been set in this form.
protected boolean	isEventCleared()	Tests if the event has been cleared in this form.
protected boolean	isEventSet()	Tests if the event has been set in this form.
protected boolean	isRequirementCleared()	Tests if the requirement has been cleared in this form.
protected boolean	isRequirementSet()	Tests if the requirement has been set in this form.
protected boolean	isScheduleCleared()	Tests if the schedule has been cleared in this form.
protected boolean	isScheduleSet()	Tests if the schedule has been set in this form.
protected boolean	isStartDateCleared()	Tests if the start date has been cleared in this form.
protected boolean	isStartDateSet()	Tests if the start date has been set in this form.
protected boolean	isTimePeriodCleared()	Tests if the time period has been cleared in this form.
protected boolean	isTimePeriodSet()	Tests if the time period has been set in this form.
void	setCyclicEvent(Id cyclicEventId)	Sets the cyclic event.
protected void	setCyclicEventMetadata(Metadata metadata)	Sets the cyclic event metadata.
void	setCyclicTimePeriod(Id cyclicTimePeriodId)	Sets the cyclic time period.
protected void	setCyclicTimePeriodMetadata(Metadata metadata)	Sets the cyclic time period metadata.
void	setEndDate(DateTime date)	Sets the end date.
protected void	setEndDateMetadata(Metadata metadata)	Sets the end date metadata.
void	setEvent(Id eventId)	Sets the event.
protected void	setEventMetadata(Metadata metadata)	Sets the event metadata.
void	setRequirement(boolean requirement)	Sets the requirement flag.
protected void	setRequirementMetadata(Metadata metadata)	Sets the requirement metadata.
void	setSchedule(Id scheduleId)	Sets the schedule.
protected void	setScheduleMetadata(Metadata metadata)	Sets the schedule metadata.
void	setStartDate(DateTime date)	Sets the start date.
protected void	setStartDateMetadata(Metadata metadata)	Sets the start date metadata.
void	setTimePeriod(Id timePeriodId)	Sets the time period.
protected void	setTimePeriodMetadata(Metadata metadata)	Sets the time period metadata.

Methods inherited from class AbstractOsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypes, getConditionRecordTypesId, getConditionRecordTypesMetadata, getRule, getRuleId, getRuleMetadata, isConditionRecordTypesCleared, isConditionRecordTypesSet, isRuleCleared, isRuleSet, setConditionRecordTypes, setConditionRecordTypesMetadata, setRule, setRuleMetadata

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
protected Type[]	getConditionRecordTypes()	Returns the current condition record types value.
protected Id	getConditionRecordTypesId()	Gets the Id for the condition record types field.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
protected Id	getRule()	Returns the current rule value.
protected Id	getRuleId()	Gets the Id for the rule Id field.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
protected boolean	isConditionRecordTypesCleared()	Tests if the condition record types have been cleared in this form.
protected boolean	isConditionRecordTypesSet()	Tests if the condition record types have been set in this form.
protected boolean	isRuleCleared()	Tests if the rule has been cleared in this form.
protected boolean	isRuleSet()	Tests if the rule has been set in this form.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
protected void	setConditionRecordTypesMetadata(Metadata metadata)	Sets the condition record types metadata.
void	setRule(Id ruleId)	Sets a rule.
protected void	setRuleMetadata(Metadata metadata)	Sets the rule metadata.

Methods inherited from class AbstractOperableOsidObjectForm

clearDisabled, clearEnabled, getDisabled, getDisabledId, getDisabledMetadata, getEnabled, getEnabledId, getEnabledMetadata, isDisabledCleared, isDisabledSet, isEnabledCleared, isEnabledSet, setDisabled, setDisabledMetadata, setEnabled, setEnabledMetadata

Modifier and Type	Method	Description
void	clearDisabled()	Clears the disabled flag.
void	clearEnabled()	Clears the enabled flag.
protected boolean	getDisabled()	Returns the current disabled value.
protected Id	getDisabledId()	Gets the Id for the disabled field.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled.
protected boolean	getEnabled()	Returns the current enabled value.
protected Id	getEnabledId()	Gets the Id for the enabled field.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled.
protected boolean	isDisabledCleared()	Tests if the disabled flag has been cleared in this form.
protected boolean	isDisabledSet()	Tests if the disabled flag has been set in this form.
protected boolean	isEnabledCleared()	Tests if the enabled flag has been cleared in this form.
protected boolean	isEnabledSet()	Tests if the enabled flag has been set in this form.
void	setDisabled(boolean disabled)	Sets the disabled flag.
protected void	setDisabledMetadata(Metadata metadata)	Sets the disabled metadata.
void	setEnabled(boolean enabled)	Sets the enabled flag.
protected void	setEnabledMetadata(Metadata metadata)	Sets the enabled metadata.

Methods inherited from class AbstractOsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescription, getDescriptionId, getDescriptionMetadata, getDisplayName, getDisplayNameId, getDisplayNameMetadata, getGenusType, getGenusTypeId, getGenusTypeMetadata, isDescriptionCleared, isDescriptionSet, isDisplayNameCleared, isDisplayNameSet, isGenusTypeCleared, isGenusTypeSet, setDescription, setDescriptionMetadata, setDisplayName, setDisplayNameMetadata, setGenusType, setGenusTypeMetadata

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
protected String	getDescription()	Returns the current description value.
protected Id	getDescriptionId()	Gets the Id for the description field.
Metadata	getDescriptionMetadata()	Gets the metadata for the description.
protected String	getDisplayName()	Returns the current display name value.
protected Id	getDisplayNameId()	Gets the Id for the display name field.
Metadata	getDisplayNameMetadata()	Gets the metadata for the display name.
protected Type	getGenusType()	Returns the current genus type value.
protected Id	getGenusTypeId()	Gets the Id for the genus type field.
Metadata	getGenusTypeMetadata()	Gets the metadata for the genus type.
protected boolean	isDescriptionCleared()	Tests if a description has been cleared in this form.
protected boolean	isDescriptionSet()	Tests if a description has been set in this form.
protected boolean	isDisplayNameCleared()	Tests if the display name has been cleared in this form.
protected boolean	isDisplayNameSet()	Tests if the display name has been set in this form.
protected boolean	isGenusTypeCleared()	Tests if a genus type has been cleared in this form.
protected boolean	isGenusTypeSet()	Tests if a genus type has been set in this form.
void	setDescription(String description)	Sets a description.
protected void	setDescriptionMetadata(Metadata metadata)	Sets the description metadata.
void	setDisplayName(String displayName)	Sets a display name.
protected void	setDisplayNameMetadata(Metadata metadata)	Sets the display name metadata.
void	setGenusType(Type genusType)	Sets a genus type.
protected void	setGenusTypeMetadata(Metadata metadata)	Sets the genus type metadata.

Methods inherited from class AbstractOsidExtensibleForm

addRecordType, addRequiredRecordType, getRecordTypes, getRequiredRecordTypes, hasRecordType

Modifier and Type	Method	Description
protected void	addRecordType(Type recordType)	Adds a record type.
protected void	addRequiredRecordType(Type requiredRecordType)	Adds a required record type.
TypeList	getRecordTypes()	Gets the record types available in this object.
TypeList	getRequiredRecordTypes()	Gets the required record types for this form.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from class AbstractOsidForm

addLocale, addLocales, clearLocales, getDefaultArrayIdMetadata, getDefaultArrayTypeMetadata, getDefaultBooleanMetadata, getDefaultDateTimeMetadata, getDefaultIdMetadata, getDefaultLocale, getDefaultStringMetadata, getDefaultTypeMetadata, getInvalidMetadata, getJournalComment, getJournalCommentId, getJournalCommentMetadata, getLocale, getLocales, getValidationMessages, isForUpdate, isJournalCommentSet, isValid, makeElementId, makeId, setJournalComment, setJournalCommentMetadata, setLocale

Modifier and Type	Method	Description
protected void	addLocale(Locale locale)	Adds an available locale.
protected void	addLocales(Collection<Locale> locales)	Adds a collection of available locales.
protected void	clearLocales()	Clears the available locales.
protected Metadata	getDefaultArrayIdMetadata(Id elementId, String field)	Gets a default read-only metadata for Ids.
protected Metadata	getDefaultArrayTypeMetadata(Id elementId, String field)	Gets a default read-only metadata for arrays of types.
protected Metadata	getDefaultBooleanMetadata(Id elementId, String field)	Gets a default read-only metadata for booleans.
protected Metadata	getDefaultDateTimeMetadata(Id elementId, String field)	Gets a default read-only metadata for date times.
protected Metadata	getDefaultIdMetadata(Id elementId, String field)	Gets a default read-only metadata for Ids.
Locale	getDefaultLocale()	Gets a default locale for DisplayTexts when a locale is not specified.
protected Metadata	getDefaultStringMetadata(Id elementId, String field)	Gets a default read-only metadata for strings.
protected Metadata	getDefaultTypeMetadata(Id elementId, String field)	Gets a default read-only metadata for types.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
protected String	getJournalComment()	Returns the current comment value.
protected Id	getJournalCommentId()	Gets the Id for the comment field.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
protected Locale	getLocale()	Gets the current locale.
LocaleList	getLocales()	Gets a list of locales for available DisplayText translations that can be performed using this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
protected boolean	isJournalCommentSet()	Tests if a comment has been set in this form.
boolean	isValid()	Tests if ths form is in a valid state for submission.
protected Id	makeElementId(String identifier)	Makes an Id for a form element.
protected Id	makeId()	Generates a unique Id for this form.
void	setJournalComment(String comment)	Sets a comment.
protected void	setJournalCommentMetadata(Metadata metadata)	Sets the comment metadata.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for DisplayText fields in this form.

Methods inherited from class AbstractIdentifiable

current, equals, getId, hashCode, isCurrent, setId, stale, toString

Modifier and Type	Method	Description
protected void	current()	Sets the current flag to true.
final boolean	equals(Object obj)	Determines if the given Id is equal to this one.
Id	getId()	Gets the Id associated with this instance of this OSID object.
int	hashCode()	Returns a hash code value for this OsidObject based on the Id.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.
protected void	setId(Id id)	Sets the Id associated with this instance of this OSID object.
protected void	stale()	Sets the current flag to false.
String	toString()	Returns a string representation of this OsidObject.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

AbstractOsidRuleApplicatorForm

protected AbstractOsidRuleApplicatorForm(Locale locale,
 boolean update)

Constructs a new AbstractOsidRuleApplicatorForm.

Parameters:

locale - this serves as the default Locale for this form which generally is the Locale of the associated session. Additional locales may be set.

update - true if for update, false if for create

Method Details

getResourceMetadata

@OSID
public Metadata getResourceMetadata()

Gets the metadata for the resource.

Specified by:

getResourceMetadata in interface OsidRuleApplicatorForm

Returns:

metadata for the resource

setResourceMetadata

protected void setResourceMetadata(Metadata metadata)

Sets the resource metadata.

Parameters:

metadata - the resource metadata

Throws:

NullArgumentException - metadata is null

setResource

@OSID
public void setResource(Id resourceId)

Sets the resource.

Specified by:

setResource in interface OsidRuleApplicatorForm

Parameters:

resourceId - the new resource

Throws:

InvalidArgumentException - resourceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - resourceId is null

clearResource

@OSID
public void clearResource()

Clears the resource.

Specified by:

clearResource in interface OsidRuleApplicatorForm

Throws:

NoAccessException - Metadata.isRequired() or Metadata.isReadOnly() is true

isResourceSet

protected boolean isResourceSet()

Tests if the resource has been set in this form.

Returns:

true if the resource has been set, false otherwise

isResourceCleared

protected boolean isResourceCleared()

Tests if the resource has been cleared in this form.

Returns:

true if the resource has been cleared, false otherwise

getResourceId

protected Id getResourceId()

Returns the current resource value.

Returns:

the resource Id or null if isResourceSet() is false