org.osid.recognition

Interface ConferralForm

All Superinterfaces:

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

All Known Subinterfaces:

ConferralBatchForm

public interface ConferralForm
extends OsidRelationshipForm

This is the form for creating and updating Conferral objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the ConferralAdminSession. 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	clearConvocation() Clears the convocation.
void	clearReference() Clears the reference.
ConferralFormRecord	getConferralFormRecord(Type conferralRecordType) Gets the ConferralFormRecord corresponding to the given conferral record Type.
Metadata	getConvocationMetadata() Gets the metadata for the convocation.
Metadata	getReferenceMetadata() Gets the metadata for the reference.
void	setConvocation(Id convocationId) Sets the convocation.
void	setReference(Id referenceId) Sets the date conferred.

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

Method Detail

getReferenceMetadata

Metadata getReferenceMetadata()

Gets the metadata for the reference.

Returns:

metadata for the reference

Compliance:

mandatory - This method must be implemented.

setReference

void setReference(Id referenceId)

Sets the date conferred.

Parameters:

referenceId - the reference

Throws:

InvalidArgumentException - referenceId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - referenceId is null

Compliance:

mandatory - This method must be implemented.

clearReference

void clearReference()

Clears the reference.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getConvocationMetadata

Metadata getConvocationMetadata()

Gets the metadata for the convocation.

Returns:

metadata for the convocation

Compliance:

mandatory - This method must be implemented.

setConvocation

void setConvocation(Id convocationId)

Sets the convocation.

Parameters:

convocationId - the convocation Id

Throws:

InvalidArgumentException - convocationId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - convocationId is null

Compliance:

mandatory - This method must be implemented.

clearConvocation

void clearConvocation()

Clears the convocation.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getConferralFormRecord

ConferralFormRecord getConferralFormRecord(Type conferralRecordType)
                                           throws OperationFailedException

Gets the ConferralFormRecord corresponding to the given conferral record Type.

Parameters:

conferralRecordType - the conferral record type

Returns:

the conferral form record

Throws:

NullArgumentException - conferralRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(conferralRecordType) is false

Compliance:

mandatory - This method must be implemented.