OSID - osid.calendaring.EventForm Service Interface Definition

Interface	osid.calendaring.EventForm
Implements	`osid.OsidObjectForm`
	`osid.OsidTemporalForm`
	`osid.OsidContainableForm`
Implemented By	`osid.calendaring.batch.EventBatchForm`
Used By	`osid.calendaring.EventAdminSession`
Description	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	getLocationDescriptionMetadata
Description	Gets the metadata for a location description.
Return	`osid.Metadata`		metadata for the location description
Compliance	`mandatory`		This method must be implemented.
Method	setLocationDescription
Description	Sets the location description.
Parameters	`string`	`location`	the new location description
Errors	INVALID_ARGUMENT		`location` is invalid
	NO_ACCESS		`location` cannot be modified
	NULL_ARGUMENT		`location` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLocationDescription
Description	Clears the location description.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLocationMetadata
Description	Gets the metadata for a location.
Return	`osid.Metadata`		metadata for the location
Compliance	`mandatory`		This method must be implemented.
Method	setLocation
Description	Sets the location.
Parameters	`osid.id.Id`	`locationId`	the new location
Errors	INVALID_ARGUMENT		`locationId` is invalid
	NO_ACCESS		`locationId` cannot be modified
	NULL_ARGUMENT		`locationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLocation
Description	Clears the location.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getSponsorsMetadata
Description	Gets the metadata for a sponsor.
Return	`osid.Metadata`		metadata for the sponsor
Compliance	`mandatory`		This method must be implemented.
Method	setSponsors
Description	Sets the sponsors.
Parameters	`osid.id.Id[]`	`sponsorIds`	the new sponsor
Errors	INVALID_ARGUMENT		`sponsorIds` is invalid
	NO_ACCESS		`sponsorIds` cannot be modified
	NULL_ARGUMENT		`sponsorIds` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSponsors
Description	Clears the sponsors.
Errors	NO_ACCESS		`Metadata.isRequired()` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getEventFormRecord
Description	Gets the `EventFormRecord` corresponding to the given event record `Type`.
Parameters	`osid.type.Type`	`eventRecordType`	the event record type
Return	`osid.calendaring.records.EventFormRecord`		the event form record
Errors	NULL_ARGUMENT		`eventRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(eventRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.