org.osid.course.program

Interface CredentialForm

All Superinterfaces:

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

All Known Subinterfaces:

CredentialBatchForm

public interface CredentialForm
extends OsidObjectForm

This is the form for creating and updating Credentials. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the CredentialAdminSession. 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	clearLifetime() Removes the lifetime.
CredentialFormRecord	getCredentialFormRecord(Type credentialRecordType) Gets the CredentialFormRecord corresponding to the given course record Type.
Metadata	getLifetimeMetadata() Gets the metadata for a credential lifetime.
void	setLifetime(Duration lifetime) Sets the lifetime.

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

Method Detail

getLifetimeMetadata

Metadata getLifetimeMetadata()

Gets the metadata for a credential lifetime.

Returns:

metadata for the lifetime

Compliance:

mandatory - This method must be implemented.

setLifetime

void setLifetime(Duration lifetime)

Sets the lifetime.

Parameters:

lifetime - the new lifetime

Throws:

InvalidArgumentException - lifetime is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - lifetime is null

Compliance:

mandatory - This method must be implemented.

clearLifetime

void clearLifetime()

Removes the lifetime.

Throws:

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

Compliance:

mandatory - This method must be implemented.

getCredentialFormRecord

CredentialFormRecord getCredentialFormRecord(Type credentialRecordType)
                                             throws OperationFailedException

Gets the CredentialFormRecord corresponding to the given course record Type.

Parameters:

credentialRecordType - a course record type

Returns:

the course form record

Throws:

NullArgumentException - credentialRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(credentialRecordType) is false

Compliance:

mandatory - This method must be implemented.