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.
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.
|
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearEndDate, clearStartDate, getEndDateMetadata, getStartDateMetadata, setEndDate, setStartDate
Metadata getReferenceMetadata()
mandatory
- This method must be implemented. void setReference(Id referenceId)
referenceId
- the referenceInvalidArgumentException
- referenceId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- referenceId
is
null
mandatory
- This method must be implemented. void clearReference()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getConvocationMetadata()
mandatory
- This method must be implemented. void setConvocation(Id convocationId)
convocationId
- the convocation Id
InvalidArgumentException
- convocationId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- convocationId
is
null
mandatory
- This method must be implemented. void clearConvocation()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. ConferralFormRecord getConferralFormRecord(Type conferralRecordType) throws OperationFailedException
ConferralFormRecord
corresponding to the given
conferral record Type.
conferralRecordType
- the conferral record typeNullArgumentException
- conferralRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(conferralRecordType)
is false
mandatory
- This method must be implemented.