org.osid.course.chronicle

Interface CredentialEntryForm

All Superinterfaces:

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

All Known Subinterfaces:

CredentialEntryBatchForm

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.

Method Summary

Methods

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.

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

getDateAwardedMetadata

Metadata getDateAwardedMetadata()

Gets the metadata for the award date.

Returns:

metadata for the award date

Compliance:

mandatory - This method must be implemented.

setDateAwarded

void setDateAwarded(DateTime date)

Sets the award date.

Parameters:

date - the new date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearDateAwarded

void clearDateAwarded()

Clears the award date.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getProgramMetadata

Metadata getProgramMetadata()

Gets the metadata for the program.

Returns:

metadata for the program

Compliance:

mandatory - This method must be implemented.

setProgram

void setProgram(Id programId)

Sets the program.

Parameters:

programId - the new program

Throws:

InvalidArgumentException - programId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - programId is null

Compliance:

mandatory - This method must be implemented.

clearProgram

void clearProgram()

Clears the program.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCredentialEntryFormRecord

CredentialEntryFormRecord getCredentialEntryFormRecord(Type credentialEntryRecordType)
                                                       throws OperationFailedException

Gets the CredentialEntryFormRecord corresponding to the given credential entry record Type.

Parameters:

credentialEntryRecordType - a credential entry record type

Returns:

the credential entry form record

Throws:

NullArgumentException - credentialEntryRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialEntryRecordType) is false

Compliance:

mandatory - This method must be implemented.