public interface CredentialEntryForm extends OsidRelationshipForm
This is the form for creating and updating CredentialEntries.
Like all OsidForm
objects, various data elements
may be set here for use in the create and update methods in the
ChronicleAdminSession.
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 |
clearDateAwarded()
Clears the award date.
|
void |
clearProgram()
Clears the program.
|
CredentialEntryFormRecord |
getCredentialEntryFormRecord(Type credentialEntryRecordType)
Gets the
CredentialEntryFormRecord corresponding to the
given credential entry record Type. |
Metadata |
getDateAwardedMetadata()
Gets the metadata for the award date.
|
Metadata |
getProgramMetadata()
Gets the metadata for the program.
|
void |
setDateAwarded(DateTime date)
Sets the award date.
|
void |
setProgram(Id programId)
Sets the program.
|
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 getDateAwardedMetadata()
mandatory
- This method must be implemented. void setDateAwarded(DateTime date)
date
- the new dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearDateAwarded()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getProgramMetadata()
mandatory
- This method must be implemented. void setProgram(Id programId)
programId
- the new programInvalidArgumentException
- programId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- programId
is
null
mandatory
- This method must be implemented. void clearProgram()
NoAccessException
- Metadata.isRequired()
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. CredentialEntryFormRecord getCredentialEntryFormRecord(Type credentialEntryRecordType) throws OperationFailedException
CredentialEntryFormRecord
corresponding to the
given credential entry record Type.
credentialEntryRecordType
- a credential entry record typeNullArgumentException
-
credentialEntryRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(credentialEntryRecordType)
is
false
mandatory
- This method must be implemented.