org.osid.calendaring

Interface RecurringEventForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidContainableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

All Known Subinterfaces:

RecurringEventBatchForm

public interface RecurringEventForm
extends OsidRuleForm, OsidContainableForm

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

Method Summary

Methods

Modifier and Type	Method and Description
void	clearSponsors() Clears the sponsors.
RecurringEventFormRecord	getRecurringEventFormRecord(Type recurringEventRecordType) Gets the RecurringEventFormRecord corresponding to the given recurring event record Type.
Metadata	getSponsorMetadata() Gets the metadata for a sponsor.
void	setSponsors(Id[] sponsorIds) Sets the sponsors.

Methods inherited from interface org.osid.OsidRuleForm

clearRule, getRuleMetadata, setRule

Methods inherited from interface org.osid.OsidObjectForm

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

Methods inherited from interface org.osid.OsidExtensibleForm

getRequiredRecordTypes

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidForm

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

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Methods inherited from interface org.osid.OsidContainableForm

clearSequestered, getSequesteredMetadata, setSequestered

Method Detail

getSponsorMetadata

Metadata getSponsorMetadata()

Gets the metadata for a sponsor.

Returns:

metadata for the sponsor

Compliance:

mandatory - This method must be implemented.

setSponsors

void setSponsors(Id[] sponsorIds)

Sets the sponsors.

Parameters:

sponsorIds - the new sponsor

Throws:

InvalidArgumentException - sponsorIds is invalid

NoAccessException - sponsorIds cannot be modified

NullArgumentException - sponsorIds is null

Compliance:

mandatory - This method must be implemented.

clearSponsors

void clearSponsors()

Clears the sponsors.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getRecurringEventFormRecord

RecurringEventFormRecord getRecurringEventFormRecord(Type recurringEventRecordType)
                                                     throws OperationFailedException

Gets the RecurringEventFormRecord corresponding to the given recurring event record Type.

Parameters:

recurringEventRecordType - the recurring event record type

Returns:

the recurring event form record

Throws:

NullArgumentException - recurringEventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(recurringEventRecordType) is false

Compliance:

mandatory - This method must be implemented.