Interface CompositionEnablerForm

All Superinterfaces:

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

public interface CompositionEnablerForm
extends OsidEnablerForm

This is the form for creating and updating CompositionEnablers . Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CompositionEnablerAdminSession . For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Method Summary

Modifier and Type	Method	Description
CompositionEnablerFormRecord	getCompositionEnablerFormRecord(Type compositionEnablerRecordType)	Gets the CompositionEnablerFormRecord corresponding to the given composition enabler record Type .

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidEnablerForm

clearCyclicEvent, clearCyclicTimePeriod, clearEvent, clearRequirement, clearSchedule, clearTimePeriod, getCyclicEventMetadata, getCyclicTimePeriodPeriodMetadata, getEventMetadata, getRequirementMetadata, getScheduleMetadata, getTimePeriodPeriodMetadata, setCyclicEvent, setCyclicTimePeriod, setEvent, setRequirement, setSchedule, setTimePeriod

Modifier and Type	Method	Description
void	clearCyclicEvent()	Removes the cyclic event.
void	clearCyclicTimePeriod()	Removes the cyclic time period.
void	clearEvent()	Removes the event.
void	clearRequirement()	Removes the requirement flag.
void	clearSchedule()	Removes the schedule.
void	clearTimePeriod()	Removes the time period.
Metadata	getCyclicEventMetadata()	Gets the metadata for the cyclic event.
Metadata	getCyclicTimePeriodPeriodMetadata()	Gets the metadata for the cyclic time period.
Metadata	getEventMetadata()	Gets the metadata for an associated event.
Metadata	getRequirementMetadata()	Gets the metadata for the requirement flag.
Metadata	getScheduleMetadata()	Gets the metadata for an associated schedule.
Metadata	getTimePeriodPeriodMetadata()	Gets the metadata for the time period.
void	setCyclicEvent(Id cyclicEventId)	Sets the cyclic event.
void	setCyclicTimePeriod(Id cyclicTimePeriodId)	Sets the cyclic time period.
void	setEvent(Id eventId)	Sets an event.
void	setRequirement(boolean requirement)	Sets the requirement flag.
void	setSchedule(Id scheduleId)	Sets a schedule.
void	setTimePeriod(Id timePeriodId)	Sets the time period.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for 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.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Methods inherited from interface OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Modifier and Type	Method	Description
void	clearEndDate()	Clears the end date.
void	clearStartDate()	Clears the start date.
Metadata	getEndDateMetadata()	Gets the metadata for an end date.
Metadata	getStartDateMetadata()	Gets the metadata for a start date.
void	setEndDate(DateTime date)	Sets the end date.
void	setStartDate(DateTime date)	Sets the start date.

Method Details

getCompositionEnablerFormRecord

CompositionEnablerFormRecord getCompositionEnablerFormRecord(Type compositionEnablerRecordType)
                                                      throws OperationFailedException

Gets the CompositionEnablerFormRecord corresponding to the given composition enabler record Type .

Parameters:

compositionEnablerRecordType - a composition enabler record type

Returns:

the composition enabler form record

Throws:

NullArgumentException - compositionEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(compositionEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.