Interface | osid.rules.check.Check | ||
---|---|---|---|
Implements | osid.OsidRule | ||
Description |
A
| ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | |
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 | ||
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 | ||
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 | |
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 | ||
Return | boolean | true if this check is for a block, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getHoldCheckBlockId | ||
Description |
Gets the | ||
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 | ||
Return | osid.hold.Block | the Block | |
Errors | ILLEGAL_STATE | isHoldCheck() is false | |
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 | ||
Return | boolean | true if this check is for a block, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getInquiryCheckAuditId | ||
Description |
Gets the | ||
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 | ||
Return | osid.inquiry.Audit | the Audit | |
Errors | ILLEGAL_STATE | isInquiryCheck() is false | |
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 | ||
Return | boolean | true if this check is for another agenda, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getProcessCheckAgendaId | ||
Description |
Gets the | ||
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 | ||
Return | osid.rules.check.Agenda | the Agenda | |
Errors | ILLEGAL_STATE | isProcessCheck() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getCheckRecord | ||
Description |
Gets the check record corresponding to the given | ||
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. |