org.osid.recognition

Interface ConvocationForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidGovernatorForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidSourceableForm, Suppliable

All Known Subinterfaces:

ConvocationBatchForm

public interface ConvocationForm
extends OsidGovernatorForm

This is the form for creating and updating Convocation objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ConvocationAdminSession. 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	clearAwards() Clears the awards.
void	clearDate() Clears the date.
void	clearTimePeriod() Clears the time period.
Metadata	getAwardsMetadata() Gets the metadata for the awards.
ConvocationFormRecord	getConvocationFormRecord(Type convocationRecordType) Gets the ConvocationFormRecord corresponding to the given convocation record Type.
Metadata	getDateMetadata() Gets the metadata for the date.
Metadata	getTimePeriodMetadata() Gets the metadata for the time period.
void	setAwards(Id[] awardIds) Sets the list of awards.
void	setDate(DateTime date) Sets the date.
void	setTimePeriod(Id timePeriodId) Sets the time period.

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

clearBranding, clearLicense, clearProvider, getBrandingMetadata, getLicenseMetadata, getProviderMetadata, setBranding, setLicense, setProvider

Method Detail

getAwardsMetadata

Metadata getAwardsMetadata()

Gets the metadata for the awards.

Returns:

metadata for the awards

Compliance:

mandatory - This method must be implemented.

setAwards

void setAwards(Id[] awardIds)

Sets the list of awards.

Parameters:

awardIds - a list of award Ids

Throws:

InvalidArgumentException - awardIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - awardIds is null

Compliance:

mandatory - This method must be implemented.

clearAwards

void clearAwards()

Clears the awards.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getDateMetadata

Metadata getDateMetadata()

Gets the metadata for the date.

Returns:

metadata for the date

Compliance:

mandatory - This method must be implemented.

setDate

void setDate(DateTime date)

Sets the date.

Parameters:

date - a date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearDate

void clearDate()

Clears the date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getTimePeriodMetadata

Metadata getTimePeriodMetadata()

Gets the metadata for the time period.

Returns:

metadata for the time period

Compliance:

mandatory - This method must be implemented.

setTimePeriod

void setTimePeriod(Id timePeriodId)

Sets the time period.

Parameters:

timePeriodId - the time period Id

Throws:

InvalidArgumentException - timePeriodId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - timePeriodId is null

Compliance:

mandatory - This method must be implemented.

clearTimePeriod

void clearTimePeriod()

Clears the time period.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getConvocationFormRecord

ConvocationFormRecord getConvocationFormRecord(Type convocationRecordType)
                                               throws OperationFailedException

Gets the ConvocationFormRecord corresponding to the given convocation record Type.

Parameters:

convocationRecordType - the convocation record type

Returns:

the convocation form record

Throws:

NullArgumentException - convocationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(convocationRecordType) is false

Compliance:

mandatory - This method must be implemented.