Interface CredentialRequirement

All Superinterfaces:
Aggregateable, Browsable, Extensible, Identifiable, Operable, OsidObject, OsidRule
public interface CredentialRequirement extends OsidRule, Aggregateable

A CredentialRequirement is an OsidRule and represents a requirement based on a Credential .

  • Method Details

    • getAltRequisites

      Requisite[] getAltRequisites()
      Gets any Requisites that may be substituted in place of this CredentialRequirement . All Requisites must be satisifed to be a substitute for this credential requirement. Inactive Requisites are not evaluated but if no applicable requisite exists, then the alternate requisite is not satisifed.
      Returns:
      the alternate requisites
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialId

      Id getCredentialId()
      Gets the Id of the Credential .
      Returns:
      the credential Id
      Compliance:
      mandatory - This method must be implemented.

    • getCredential

      Credential getCredential() throws OperationFailedException
      Gets the Credential .
      Returns:
      the credential
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasTimeframe

      boolean hasTimeframe()
      Tests if the credential has to be earned within the required duration.
      Returns:
      true if the credential must be earned within a required time, false if it could have been earned at any time in the past
      Compliance:
      mandatory - This method must be implemented.

    • getTimeframe

      Duration getTimeframe()
      Gets the timeframe in which the credential has to be earned. A negative duration indicates the credential had to be earned within the specified amount of time in the past. A posiitive duration indicates the credential must be earned within the specified amount of time in the future. A zero duration indicates the credential must be earned in the current term.
      Returns:
      the time frame
      Throws:
      IllegalStateException - hasTimeframe() is false
      Compliance:
      mandatory - This method must be implemented.

    • getCredentialRequirementRecord

      CredentialRequirementRecord getCredentialRequirementRecord(Type credentialRequirementRecordType) throws OperationFailedException
      Gets the credential requirement record corresponding to the given CredentialRequirement record Type . This method is used to retrieve an object implementing the requested record. The credentialRequirementRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(credentialRequirementRecordType) is true .
      Parameters:
      credentialRequirementRecordType - the type of credential requirement record to retrieve
      Returns:
      the credential requirement record
      Throws:
      NullArgumentException - credentialRequirementRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(credentialRequirementRecordType) is false
      Compliance:
      mandatory - This method must be implemented.