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 Convocations. Like all OsidForms, 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

Modifier and Type	Method	Description
void	clearAwards()	Clears the awards.
void	clearDate()	Clears the date.
void	clearSponsors()	Removes the sponsors.
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	getSponsorsMetadata()	Gets the metadata for the sponsors.
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	setSponsors(IdList sponsorIds)	Sets the sponsors.
void	setTimePeriod(Id timePeriodId)	Sets the time period.

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

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

Modifier and Type	Method	Description
void	clearBranding()	Removes the branding.
void	clearLicense()	Removes the license.
void	clearProvider()	Removes the provider.
Metadata	getBrandingMetadata()	Gets the metadata for the asset branding.
Metadata	getLicenseMetadata()	Gets the metadata for the license.
Metadata	getProviderMetadata()	Gets the metadata for a provider.
void	setBranding(Id[] assetIds)	Sets the branding.
void	setLicense(String license)	Sets the license.
void	setProvider(Id providerId)	Sets a provider.

Method Details

getSponsorsMetadata

Metadata getSponsorsMetadata()

Gets the metadata for the sponsors.

Returns:

metadata for the sponsors

Compliance:

mandatory - This method must be implemented.

setSponsors

void setSponsors(IdList sponsorIds)

Sets the sponsors.

Parameters:

sponsorIds - the new sponsors

Throws:

InvalidArgumentException - sponsorIds is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - sponsorIds is null

Compliance:

mandatory - This method must be implemented.

clearSponsors

void clearSponsors()

Removes the sponsors.

Throws:

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

Compliance:

mandatory - This method must be implemented.

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.