OSID Logo
OSID Specifications
course program package
Version 3.0.0
Release Candidate Preview
Interfaceosid.course.program.CredentialForm
Implementsosid.OsidObjectForm
Description

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.

MethodgetLifetimeMetadata
Description

Gets the metadata for a credential lifetime.

Returnosid.Metadatametadata for the lifetime
CompliancemandatoryThis method must be implemented.
MethodsetLifetime
Description

Sets the lifetime.

Parametersosid.calendaring.Durationlifetimethe new lifetime
ErrorsINVALID_ARGUMENT lifetime is invalid
NO_ACCESS Metadata.isReadOnly() is true
NULL_ARGUMENT lifetime is null
CompliancemandatoryThis method must be implemented.
MethodclearLifetime
Description

Removes the lifetime.

ErrorsNO_ACCESS Metadata.isRequired() is true or Metadata.isReadOnly() is true
CompliancemandatoryThis method must be implemented.
MethodgetCredentialFormRecord
Description

Gets the CredentialFormRecord corresponding to the given course record Type.

Parametersosid.type.TypecredentialRecordTypea course record type
Returnosid.course.program.records.CredentialFormRecordthe course form record
ErrorsNULL_ARGUMENT credentialRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(credentialRecordType) is false
CompliancemandatoryThis method must be implemented.