public interface Check extends OsidRule
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.
Modifier and Type | Method and Description |
---|---|
CheckRecord |
getCheckRecord(Type checkRecordType)
Gets the check record corresponding to the given
Check
record Type. |
Block |
getHoldCheckBlock()
Gets the
Block for this check. |
Id |
getHoldCheckBlockId()
Gets the
Block Id for this check, |
Audit |
getInquiryCheckAudit()
Gets the
Audit for this check. |
Id |
getInquiryCheckAuditId()
Gets the
Audit Id for this check, |
Agenda |
getProcessCheckAgenda()
Gets the
Agenda for this check. |
Id |
getProcessCheckAgendaId()
Gets the
Agenda Id for this check. |
CyclicEvent |
getTimeCheckCyclicEvent()
Gets the time check cyclic event.
|
Id |
getTimeCheckCyclicEventId()
Gets the time check cyclic event
Id. |
DateTime |
getTimeCheckEndDate()
Gets the time check end date.
|
Event |
getTimeCheckEvent()
Gets the time check event.
|
Id |
getTimeCheckEventId()
Gets the time check event
Id. |
DateTime |
getTimeCheckStartDate()
Gets the time check start date.
|
boolean |
isFailCheck()
Tests if this check is a placeholder check that always fails when
evaluated.
|
boolean |
isHoldCheck()
Tests if this check is for a hold service block.
|
boolean |
isInquiryCheck()
Tests if this check is for a hold service block.
|
boolean |
isProcessCheck()
Tests if this check is for a another agenda.
|
boolean |
isTimeCheckByCyclicEvent()
Tests if this check is for a time check specified by a cyclic event.
|
boolean |
isTimeCheckByDate()
Tests if this check is for a time check specified by a date.
|
boolean |
isTimeCheckByEvent()
Tests if this check is for a time check specified by an event.
|
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
isActive, isDisabled, isEnabled, isOperational
boolean isFailCheck()
Instruction.
If isFailCheck()
is true,
then isTimeCheckByDate(),
isTimeCheckByEvent(),
isTimeCheckByCyclicEvent(),
isHoldCheck(),
isInquiryCheck(),
and isProcessCheck()
must be
false.
true
if this is a fail check, false
otherwisemandatory
- This method must be implemented. boolean isTimeCheckByDate()
isTimeCheckByDate()
is true,
then
isFailCheck(),
isTimeCheckByEvent(),
isTimeCheckByCyclicEvent(),
isHoldCheck(),
isInquiryCheck(),
and isProcessCheck()
must be false.
true
if this check is for a time specified by
date, false
otherwisemandatory
- This method must be implemented. DateTime getTimeCheckStartDate()
IllegalStateException
- isTimeCheckByDate()
is false
mandatory
- This method must be implemented. DateTime getTimeCheckEndDate()
IllegalStateException
- isTimeCheckByDate()
is false
mandatory
- This method must be implemented. boolean isTimeCheckByEvent()
isTimeCheckByEvent()
is
true,
then isFailCheck(),
isTimeCheckByDate(),
isTimeCheckByCyclicEvent(),
isHoldCheck(),
isInquiryCheck(),
and isProcessCheck()
must be false.
true
if this check is for a time speciifed by
event, false
otherwisemandatory
- This method must be implemented. Id getTimeCheckEventId()
Id.
Id
IllegalStateException
- isTimeCheckByEvent()
is false
mandatory
- This method must be implemented. Event getTimeCheckEvent() throws OperationFailedException
IllegalStateException
- isTimeCheckByEvent()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isTimeCheckByCyclicEvent()
isTimeCheckByCyclicEvent()
is
true,
then isFailCheck(),
isTimeCheckByDate(),
isTimeCheckByEvent(),
isHoldCheck(), isInquiryCheck(),
and
isProcessCheck()
must be false.
true
if this check is for a time check
specified by cyclic event, false
otherwisemandatory
- This method must be implemented. Id getTimeCheckCyclicEventId()
Id.
Id
IllegalStateException
-
isTimeCheckByCyclicEvent()
is false
mandatory
- This method must be implemented. CyclicEvent getTimeCheckCyclicEvent() throws OperationFailedException
IllegalStateException
-
isTimeCheckByCyclicEvent()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isHoldCheck()
isHoldCheck()
is true,
then isFailCheck(),
isTimeCheckByDate(),
isTimeCheckByEvent(),
isTimeCheckByCyclicEvent(),
isInquiryCheck(),
and isProcessCheck()
must be
false.
true
if this check is for a block, false
otherwisemandatory
- This method must be implemented. Id getHoldCheckBlockId()
Block Id
for this check, Block Id
IllegalStateException
- isHoldCheck()
is
false
mandatory
- This method must be implemented. Block getHoldCheckBlock() throws OperationFailedException
Block
for this check. Block
IllegalStateException
- isHoldCheck()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isInquiryCheck()
isInquiryCheck()
is true,
then isFailCheck(),
isTimeCheckByDate(),
isTimeCheckByEvent(),
isTimeCheckByCyclicEvent(),
isHoldCheck(),
and isProcessCheck()
must be
false.
true
if this check is for a block, false
otherwisemandatory
- This method must be implemented. Id getInquiryCheckAuditId()
Audit Id
for this check, Block Id
IllegalStateException
- isInquiryCheck()
is false
mandatory
- This method must be implemented. Audit getInquiryCheckAudit() throws OperationFailedException
Audit
for this check. Audit
IllegalStateException
- isInquiryCheck()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean isProcessCheck()
isProcessCheck()
is
true,
then isFailCheck(),
isTimeCheckByDate(),
isTimeCheckByEvent(),
isTimeCheckByCyclicEvent(),
isHoldCheck(),
and isInquiryCheck()
must be false.
true
if this check is for another agenda,
false
otherwisemandatory
- This method must be implemented. Id getProcessCheckAgendaId()
Agenda Id
for this check. Block Id
IllegalStateException
- isProcessCheck()
is false
mandatory
- This method must be implemented. Agenda getProcessCheckAgenda() throws OperationFailedException
Agenda
for this check. Agenda
IllegalStateException
- isProcessCheck()
is false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CheckRecord getCheckRecord(Type checkRecordType) throws OperationFailedException, PermissionDeniedException
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
.checkRecordType
- the type of check record to retrieveNullArgumentException
- checkRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(checkRecordType)
is false
mandatory
- This method must be implemented.