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

Interface	osid.course.chronicle.CredentialEntryQuery
Implements	`osid.OsidRelationshipQuery`
Used By	`osid.course.chronicle.CredentialEntryQuerySession`
	`osid.course.chronicle.CredentialEntrySearchSession`
	`osid.course.chronicle.CredentialEntrySmartCourseCatalogSession`
Description	This is the query for searching credential entries. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchStudentId
Description	Sets the student `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`resourceId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStudentIdTerms
Description	Clears the student `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStudentQuery
Description	Tests if a `StudentQuery` is available.
Return	`boolean`		`true` if a student query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStudentQuery
Description	Gets the query for a student option. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		a student query
Errors	UNIMPLEMENTED		`supportsStudentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStudentQuery()` is `true`.
Method	clearStudentTerms
Description	Clears the student option terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCredentialId
Description	Sets the credential `Id` for this query to match entries that have an entry for the given course.
Parameters	`osid.id.Id`	`credentialId`	a credential `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`credentialId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCredentialIdTerms
Description	Clears the credential `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCredentialQuery
Description	Tests if a `CredentialQuery` is available.
Return	`boolean`		`true` if a credential query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialQuery
Description	Gets the query for a credential entry. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.CredentialQuery`		a credential query
Errors	UNIMPLEMENTED		`supportsCredentialQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCredentialQuery()` is `true`.
Method	clearCredentialTerms
Description	Clears the credential terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIsMatriculationKnown
Description	Matches credential entries with a matriculation known value.
Parameters	`boolean`	`match`	`true` to match a `true` value, `false` to match a `false` value
Compliance	`mandatory`		This method must be implemented.
Method	clearIsMatriculationKnownTerms
Description	Clears the matriculation known terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStartDate
Description	Matches start dates between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyStartDate
Description	Matches credential entries with any start date.
Parameters	`boolean`	`match`	`true` to match entries with a start date, `false` to match entries with no start date
Compliance	`mandatory`		This method must be implemented.
Method	clearStartDateTerms
Description	Clears the start date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchStartTermId
Description	Sets the start term `Id` for this query.
Parameters	`osid.id.Id`	`startTermId`	a start term `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`startTermId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearStartTermIdTerms
Description	Clears the start term `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsStartTermQuery
Description	Tests if a `TermQuery` is available.
Return	`boolean`		`true` if a start term query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getStartTermQuery
Description	Gets the query for a start term. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.TermQuery`		a start term query
Errors	UNIMPLEMENTED		`supportsStartTermQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsStartTermQuery()` is `true`.
Method	clearStartTermTerms
Description	Clears the start term terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIsExpectedToComplete
Description	Matches credential entries with a expected to complete value.
Parameters	`boolean`	`match`	`true` to match a `true` value, `false` to match a `false` value
Compliance	`mandatory`		This method must be implemented.
Method	clearIsExpectedToCompleteTerms
Description	Clears the expected to complete terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchExpectedCompletionDate
Description	Matches expected completion dates between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyExpectedCompletionDate
Description	Matches credential entries with any expected completion date.
Parameters	`boolean`	`match`	`true` to match entries with a expected completion date, `false` to match entries with no expected completion date
Compliance	`mandatory`		This method must be implemented.
Method	clearExpectedCompletionDateTerms
Description	Clears the expected completion date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchExpectedCompletionTermId
Description	Sets the expected completion term `Id` for this query.
Parameters	`osid.id.Id`	`expectedCompletionTermId`	a expected completion term `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`expectedCompletionTermId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearExpectedCompletionTermIdTerms
Description	Clears the expected completion term `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsExpectedCompletionTermQuery
Description	Tests if a `TermQuery` is available.
Return	`boolean`		`true` if a expected completion term query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getExpectedCompletionTermQuery
Description	Gets the query for a expected completion term. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.TermQuery`		a expected completion term query
Errors	UNIMPLEMENTED		`supportsExpectedCompletionTermQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsExpectedCompletionTermQuery()` is `true`.
Method	clearExpectedCompletionTermTerms
Description	Clears the expected completion term terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIsActivelyPursuing
Description	Matches credential entries with a actively pursuing value.
Parameters	`boolean`	`match`	`true` to match a `true` value, `false` to match a `false` value
Compliance	`mandatory`		This method must be implemented.
Method	clearIsActivelyPursuingTerms
Description	Clears the actively pursuing terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIsPaused
Description	Matches credential entries with a paused value.
Parameters	`boolean`	`match`	`true` to match a `true` value, `false` to match a `false` value
Compliance	`mandatory`		This method must be implemented.
Method	clearIsPausedTerms
Description	Clears the paused terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIsAbandoned
Description	Matches credential entries with a abandoned value.
Parameters	`boolean`	`match`	`true` to match a `true` value, `false` to match a `false` value
Compliance	`mandatory`		This method must be implemented.
Method	clearIsAbandonedTerms
Description	Clears the abandoned terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAbandonDate
Description	Matches abandon dates between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyAbandonDate
Description	Matches credential entries with any abandon date.
Parameters	`boolean`	`match`	`true` to match entries with a abandon date, `false` to match entries with no abandon date
Compliance	`mandatory`		This method must be implemented.
Method	clearAbandonDateTerms
Description	Clears the abandon date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAbandonTermId
Description	Sets the abandon term `Id` for this query.
Parameters	`osid.id.Id`	`abandonTermId`	a abandon term `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`abandonTermId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAbandonTermIdTerms
Description	Clears the abandon term `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAbandonTermQuery
Description	Tests if a `TermQuery` is available.
Return	`boolean`		`true` if a abandon term query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAbandonTermQuery
Description	Gets the query for a abandon term. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.TermQuery`		a abandon term query
Errors	UNIMPLEMENTED		`supportsAbandonTermQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAbandonTermQuery()` is `true`.
Method	clearAbandonTermTerms
Description	Clears the abandon term terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchIsAwarded
Description	Matches credential entries with a awarded value.
Parameters	`boolean`	`match`	`true` to match a `true` value, `false` to match a `false` value
Compliance	`mandatory`		This method must be implemented.
Method	clearIsAwardedTerms
Description	Clears the awarded terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAwardDate
Description	Matches award dates between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyAwardDate
Description	Matches credential entries with any award date.
Parameters	`boolean`	`match`	`true` to match entries with a award date, `false` to match entries with no award date
Compliance	`mandatory`		This method must be implemented.
Method	clearAwardDateTerms
Description	Clears the award date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAwardTermId
Description	Sets the award term `Id` for this query.
Parameters	`osid.id.Id`	`awardTermId`	a award term `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`awardTermId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAwardTermIdTerms
Description	Clears the award term `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAwardTermQuery
Description	Tests if a `TermQuery` is available.
Return	`boolean`		`true` if a award term query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAwardTermQuery
Description	Gets the query for a award term. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.TermQuery`		a award term query
Errors	UNIMPLEMENTED		`supportsAwardTermQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAwardTermQuery()` is `true`.
Method	clearAwardTermTerms
Description	Clears the award term terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDateAwarded
Description	Matches award dates between the given dates inclusive.
Parameters	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`from` is greater than `to`
Errors	NULL_ARGUMENT		`from` or `to` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDateAwarded
Description	Matches entries that have any award date.
Parameters	`boolean`	`match`	`true` to match entries with any award date, `false` to match entries with no award date
Compliance	`mandatory`		This method must be implemented.
Method	clearDateAwardedTerms
Description	Clears the award date terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchProgramId
Description	Sets the program `Id` for this query.
Parameters	`osid.id.Id`	`programId`	a program `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`programId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProgramIdTerms
Description	Clears the program `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsProgramQuery
Description	Tests if a `ProgramQuery` is available.
Return	`boolean`		`true` if a program query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProgramQuery
Description	Gets the query for a program. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.program.ProgramQuery`		a program query
Errors	UNIMPLEMENTED		`supportsProgramQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsProgramQuery()` is `true`.
Method	matchAnyProgram
Description	Matches entries that have any program.
Parameters	`boolean`	`match`	`true` to match entries with any program `false` to match entries with no program
Compliance	`mandatory`		This method must be implemented.
Method	clearProgramTerms
Description	Clears the program terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCourseCatalogId
Description	Sets the course catalog `Id` for this query to match entries assigned to course catalogs.
Parameters	`osid.id.Id`	`courseCatalogId`	the course catalog `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`courseCatalogId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearCourseCatalogIdTerms
Description	Clears the course catalog `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsCourseCatalogQuery
Description	Tests if a `CourseCatalogQuery` is available.
Return	`boolean`		`true` if a course catalog query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogQuery
Description	Gets the query for a course catalog. Multiple retrievals produce a nested `OR` term.
Return	`osid.course.CourseCatalogQuery`		the course catalog query
Errors	UNIMPLEMENTED		`supportsCourseCatalogQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsCourseCatalogQuery()` is `true`.
Method	clearCourseCatalogTerms
Description	Clears the course catalog terms.
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialEntryQueryRecord
Description	Gets the credential entry query record corresponding to the given `CredentialEntry` record `Type`. Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`credentialEntryRecordType`	a credential entry record type
Return	`osid.course.chronicle.records.CredentialEntryQueryRecord`		the credential entry query 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.