OSID - osid.course.chronicle.CredentialEntry Service Interface Definition

Interface	osid.course.chronicle.CredentialEntry
Implements	`osid.OsidRelationship`
Used By	`osid.course.chronicle.CredentialEntryAdminSession`
	`osid.course.chronicle.CredentialEntryList`
	`osid.course.chronicle.CredentialEntryLookupSession`
Description	A `CredentialEntry` represents an academic record entry for a credential.
Method	getStudentId
Description	Gets the `Id` of the `Student`.
Return	`osid.id.Id`		the student `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getStudent
Description	Gets the `Student`.
Return	`osid.resource.Resource`		the student
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialId
Description	Gets the `Id` of the `Credential`.
Return	`osid.id.Id`		the credential `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getCredential
Description	Gets the `Credential`.
Return	`osid.course.program.Credential`		the credential
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isMatriculationKnown
Description	Tests if the matriculation status for this credential entry is known.
Return	`boolean`		`true` if the matriculation status is known, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStartDate
Description	Gets the start date of the matriculation.
Return	`osid.calendaring.DateTime`		the start date
Errors	ILLEGAL_STATE		`isMatriculationKnown()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getStartTermId
Description	Gets the `Id` of the start `Term`.
Return	`osid.id.Id`		the start term `Id`
Errors	ILLEGAL_STATE		`isMatriculationKnown()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getStartTerm
Description	Gets the start `Term`.
Return	`osid.course.Term`		the start term
Errors	ILLEGAL_STATE		`isMatriculationKnown()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isExpectedToComplete
Description	Tests if an expected completion is known.
Return	`boolean`		`true` if an expected completion is known, `false` otherwise
Errors	ILLEGAL_STATE		`isMatriculationKnown()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getExpectedCompletionDate
Description	Gets the expected completion date.
Return	`osid.calendaring.DateTime`		the expected completion date
Errors	ILLEGAL_STATE		`isExpectedToComplete()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getExpectedCompletionTermId
Description	Gets the `Id` of the expected completion `Term`.
Return	`osid.id.Id`		the expected completion term `Id`
Errors	ILLEGAL_STATE		`isExpectedToComplete()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getExpectedCompletionTerm
Description	Gets the expected completion `Term`.
Return	`osid.course.Term`		the expected completion term
Errors	ILLEGAL_STATE		`isExpectedToComplete()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isActivelyPursuing
Description	Tests if the credential is being actively pursued.
Return	`boolean`		`true` if the credential is being actively pursued, `false` otherwise
Errors	ILLEGAL_STATE		`isMatriculationKnown()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isPaused
Description	Tests if the pursuit of the credential is paused.
Return	`boolean`		`true` if the pursuit of the credential is paused, `false` otherwise
Errors	ILLEGAL_STATE		`isMatriculationKnown()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isAbandoned
Description	Tests if the pursuit of the credential has been abandoned.
Return	`boolean`		`true` if the pursuit of the credential has been abandoned, `false` otherwise
Errors	ILLEGAL_STATE		`isMatriculationKnown()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAbandonDate
Description	Gets the date the credential was abandoned.
Return	`osid.calendaring.DateTime`		the abandon date
Errors	ILLEGAL_STATE		`isAbandoned()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAbandonTermId
Description	Gets the `Id` of the abandon `Term`.
Return	`osid.id.Id`		the abandon term `Id`
Errors	ILLEGAL_STATE		`isAbandoned()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAbandonTerm
Description	Gets the abandon `Term`.
Return	`osid.course.Term`		the abandon term
Errors	ILLEGAL_STATE		`isAbandoned()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isAwarded
Description	Tests if the credential has been awarded.
Return	`boolean`		`true` if the credential has been awarded, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAwardDate
Description	Gets the date the credential was awarded.
Return	`osid.calendaring.DateTime`		the award date
Errors	ILLEGAL_STATE		`isAwarded()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardTermId
Description	Gets the `Id` of the award `Term`.
Return	`osid.id.Id`		the award term `Id`
Errors	ILLEGAL_STATE		`isAwarded()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAwardTerm
Description	Gets the award `Term`.
Return	`osid.course.Term`		the award term
Errors	ILLEGAL_STATE		`isAwarded()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getDateAwarded
Description	Gets the award date.
Return	`osid.calendaring.DateTime`		the date awarded
Compliance	`mandatory`		This method must be implemented.
Method	hasProgram
Description	Tests if a program is associated with this credential.
Return	`boolean`		`true` if a program is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramId
Description	Gets the `Id` of the `Program`.
Return	`osid.id.Id`		the program `Id`
Errors	ILLEGAL_STATE		`hasProgram()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getProgram
Description	Gets the `Program`.
Return	`osid.course.program.Program`		the program
Errors	ILLEGAL_STATE		`hasProgram()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntryRecord
Description	Gets the credential entry record corresponding to the given `CredentialEntry` record `Type`. This method is used to retrieve an object implementing the requested record. The `credentialEntryRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(credentialEntryRecordType)` is `true`.
Parameters	`osid.type.Type`	`credentialEntryRecordType`	the type of credential entry record to retrieve
Return	`osid.course.chronicle.records.CredentialEntryRecord`		the credential entry record
Errors	NULL_ARGUMENT		`credentialEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(credentialEntryRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.