OSID - osid.rules.check.Check Service Interface Definition

Interface	osid.rules.check.Check
Implements	`osid.OsidRule`
Description	A `Check` is something that needs to checked. Some basic checks are baked into this interface but can be extended through a check record or it can reference an external rule evaluation. Each type of check is unique and should not be combined. `Checks` come in a variety of flavors indicated by the boolean methods in this interface. Each type of `Check` may be accompanied by data required to evaluate the check. Fail Check Time Check By Date Time Check by Event Time Check By Cyclic Event Hold Check Inquiry Check Process Check
Method	isFailCheck
Description	Tests if this check is a placeholder check that always fails when evaluated. A failure check can be used to block certain conditions specified in an `Instruction.` If `isFailCheck()` is `true,` then `isTimeCheckByDate(),` `isTimeCheckByEvent(),` `isTimeCheckByCyclicEvent(),` `isHoldCheck(), isInquiryCheck(),` and `isProcessCheck()` must be `false.`
Return	`boolean`		`true` if this is a fail check, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	isTimeCheckByDate
Description	Tests if this check is for a time check specified by a date. If `isTimeCheckByDate()` is `true,` then `isFailCheck(),` `isTimeCheckByEvent(),` `isTimeCheckByCyclicEvent(),` `isHoldCheck(),` `isInquiryCheck(),` and `isProcessCheck()` must be `false.`
Return	`boolean`		`true` if this check is for a time specified by date, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckStartDate
Description	Gets the time check start date. The check passes if the current time is within the time interval inclusive. If the start time of the interval is undefined, then the check for the start time always passes. If the end time of the interval is undefined, then the check for the deadline always passes.
Return	`osid.calendaring.DateTime`		the start of the time period
Errors	ILLEGAL_STATE		`isTimeCheckByDate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckEndDate
Description	Gets the time check end date. The check passes if the current time is within the time interval inclusive. If the start time of the interval is undefined, then the check for the start time always passes. If the end time of the interval is undefined, then the check for the deadline always passes.
Return	`osid.calendaring.DateTime`		the end of the time period
Errors	ILLEGAL_STATE		`isTimeCheckByDate()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	isTimeCheckByEvent
Description	Tests if this check is for a time check specified by an event. The starting and ending times of the event are used as a time interval to perform the time check. If `isTimeCheckByEvent()` is `true,` then `isFailCheck(),` `isTimeCheckByDate(),` `isTimeCheckByCyclicEvent(),` `isHoldCheck(),` `isInquiryCheck(),` and `isProcessCheck()` must be `false.`
Return	`boolean`		`true` if this check is for a time speciifed by event, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckEventId
Description	Gets the time check event `Id.`
Return	`osid.id.Id`		the event `Id`
Errors	ILLEGAL_STATE		`isTimeCheckByEvent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckEvent
Description	Gets the time check event.
Return	`osid.calendaring.Event`		the event
Errors	ILLEGAL_STATE		`isTimeCheckByEvent()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isTimeCheckByCyclicEvent
Description	Tests if this check is for a time check specified by a cyclic event. The time check is performed using the starting and ending dates of the derived event. If the event is a rceurring event, the time must be within the starting and ending dates of at least one of the events in the series. If `isTimeCheckByCyclicEvent()` is `true,` then `isFailCheck(),` `isTimeCheckByDate(),` `isTimeCheckByEvent(),` `isHoldCheck(), isInquiryCheck(),` and `isProcessCheck()` must be `false.`
Return	`boolean`		`true` if this check is for a time check specified by cyclic event, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckCyclicEventId
Description	Gets the time check cyclic event `Id.`
Return	`osid.id.Id`		the cyclic event `Id`
Errors	ILLEGAL_STATE		`isTimeCheckByCyclicEvent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckCyclicEvent
Description	Gets the time check cyclic event.
Return	`osid.calendaring.cycle.CyclicEvent`		the cyclic event
Errors	ILLEGAL_STATE		`isTimeCheckByCyclicEvent()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isHoldCheck
Description	Tests if this check is for a hold service block. If a block exists for the agent being checked, the check fails. If `isHoldCheck()` is `true,` then `isFailCheck(),` `isTimeCheckByDate(),` `isTimeCheckByEvent(),` `isTimeCheckByCyclicEvent(),` `isInquiryCheck(),` and `isProcessCheck()` must be `false.`
Return	`boolean`		`true` if this check is for a block, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getHoldCheckBlockId
Description	Gets the `Block Id` for this check,
Return	`osid.id.Id`		the `Block Id`
Errors	ILLEGAL_STATE		`isHoldCheck()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getHoldCheckBlock
Description	Gets the `Block` for this check.
Return	`osid.hold.Block`		the `Block`
Errors	ILLEGAL_STATE		`isHoldCheck()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isInquiryCheck
Description	Tests if this check is for a hold service block. If a block exists for the agent being checked, the check fails. If `isInquiryCheck()` is `true,` then `isFailCheck(),` `isTimeCheckByDate(),` `isTimeCheckByEvent(),` `isTimeCheckByCyclicEvent(),` `isHoldCheck(),` and `isProcessCheck()` must be `false.`
Return	`boolean`		`true` if this check is for a block, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryCheckAuditId
Description	Gets the `Audit Id` for this check,
Return	`osid.id.Id`		the `Block Id`
Errors	ILLEGAL_STATE		`isInquiryCheck()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryCheckAudit
Description	Gets the `Audit` for this check.
Return	`osid.inquiry.Audit`		the `Audit`
Errors	ILLEGAL_STATE		`isInquiryCheck()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	isProcessCheck
Description	Tests if this check is for a another agenda. The agenda for the specified agenda is retrieved and processed before continuing with the checks in this agenda. If `isProcessCheck()` is `true,` then `isFailCheck(),` `isTimeCheckByDate(),` `isTimeCheckByEvent(),` `isTimeCheckByCyclicEvent(),` `isHoldCheck(),` and `isInquiryCheck()` must be `false.`
Return	`boolean`		`true` if this check is for another agenda, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProcessCheckAgendaId
Description	Gets the `Agenda Id` for this check.
Return	`osid.id.Id`		the `Block Id`
Errors	ILLEGAL_STATE		`isProcessCheck()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessCheckAgenda
Description	Gets the `Agenda` for this check.
Return	`osid.rules.check.Agenda`		the `Agenda`
Errors	ILLEGAL_STATE		`isProcessCheck()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getCheckRecord
Description	Gets the check record corresponding to the given `Check` record `Type.` This method is used to retrieve an object implementing the requested record. The `checkRecordType` may be the `Type` returned in `getRecordTypes()` or any of its parents in a `Type` hierarchy where `hasRecordType(checkRecordType)` is `true` .
Parameters	`osid.type.Type`	`checkRecordType`	the type of check record to retrieve
Return	`osid.rules.check.records.CheckRecord`		the check record
Errors	NULL_ARGUMENT		`checkRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(checkRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.