public interface Credential extends OsidObject
A Credential
represents something awarded at program
completion.
Modifier and Type | Method and Description |
---|---|
CredentialRecord |
getCredentialRecord(Type credentialRecordType)
Gets the credential record corresponding to the given
Credential record Type. |
Duration |
getLifetime()
Gets the lifetime of this credential once awarded.
|
boolean |
hasLifeTime()
Tests if this credential has a limited lifetime.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
boolean hasLifeTime()
true
if this credential expires, false
if permanentmandatory
- This method is must be implemented. Duration getLifetime()
IllegalStateException
- hasLifetime()
is
false
mandatory
- This method must be implemented. CredentialRecord getCredentialRecord(Type credentialRecordType) throws OperationFailedException
Credential
record Type.
This method is used to
retrieve an object implementing the requested record. The
credentialRecordType
may be the Type
returned
in getRecordTypes()
or any of its parents in a
Type
hierarchy where
hasRecordType(credentialRecordType)
is true
.credentialRecordType
- the type of credential record to retrieveNullArgumentException
- credentialRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(credentialRecordType)
is false
mandatory
- This method must be implemented.