org.osid.calendaring

Interface EventForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidContainableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidTemporalForm, Suppliable

All Known Subinterfaces:

EventBatchForm

public interface EventForm
extends OsidObjectForm, OsidTemporalForm, OsidContainableForm

This is the form for creating and updating Events. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the EventAdminSession. 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	clearLocation() Clears the location.
void	clearLocationDescription() Clears the location description.
void	clearSponsors() Clears the sponsors.
EventFormRecord	getEventFormRecord(Type eventRecordType) Gets the EventFormRecord corresponding to the given event record Type.
Metadata	getLocationDescriptionMetadata() Gets the metadata for a location description.
Metadata	getLocationMetadata() Gets the metadata for a location.
Metadata	getSponsorMetadata() Gets the metadata for a sponsor.
void	setLocation(Id locationId) Sets the location.
void	setLocationDescription(java.lang.String location) Sets the location description.
void	setSponsors(Id[] sponsorIds) Sets the sponsors.

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.OsidTemporalForm

clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate

Methods inherited from interface org.osid.OsidContainableForm

clearSequestered, getSequesteredMetadata, setSequestered

Method Detail

getLocationDescriptionMetadata

Metadata getLocationDescriptionMetadata()

Gets the metadata for a location description.

Returns:

metadata for the location description

Compliance:

mandatory - This method must be implemented.

setLocationDescription

void setLocationDescription(java.lang.String location)

Sets the location description.

Parameters:

location - the new location description

Throws:

InvalidArgumentException - location is invalid

NoAccessException - location cannot be modified

NullArgumentException - location is null

Compliance:

mandatory - This method must be implemented.

clearLocationDescription

void clearLocationDescription()

Clears the location description.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getLocationMetadata

Metadata getLocationMetadata()

Gets the metadata for a location.

Returns:

metadata for the location

Compliance:

mandatory - This method must be implemented.

setLocation

void setLocation(Id locationId)

Sets the location.

Parameters:

locationId - the new location

Throws:

InvalidArgumentException - locationId is invalid

NoAccessException - locationId cannot be modified

NullArgumentException - locationId is null

Compliance:

mandatory - This method must be implemented.

clearLocation

void clearLocation()

Clears the location.

Throws:

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

Compliance:

mandatory - This method must be implemented.

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.

getEventFormRecord

EventFormRecord getEventFormRecord(Type eventRecordType)
                                   throws OperationFailedException

Gets the EventFormRecord corresponding to the given event record Type.

Parameters:

eventRecordType - the event record type

Returns:

the event form record

Throws:

NullArgumentException - eventRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(eventRecordType) is false

Compliance:

mandatory - This method must be implemented.