public interface CheckForm extends OsidRuleForm
This is the form for creating and updating Checks.
Like
all OsidForm
objects, various data elements may be set here
for use in the create and update methods in the CheckAdminSession.
For each data element that may be set, metadata may be examined to
provide display hints or data constraints.
Checks come in a variety of flavors. Each type of Check
is determined based on what data is set. If multiple fields are set, the provider will pick one at random.
Modifier and Type | Method and Description |
---|---|
void |
clearFailCheck()
Removes the fail check setting.
|
void |
clearHoldCheckBlock()
Removes the block.
|
void |
clearInquiryCheckAudit()
Removes the audit.
|
void |
clearProcessCheckAgenda()
Removes the agenda.
|
void |
clearTimeCheckCyclicEvent()
Removes the cyclic event.
|
void |
clearTimeCheckEndDate()
Removes the end date.
|
void |
clearTimeCheckEvent()
Removes the event.
|
void |
clearTimeCheckStartDate()
Removes the start date.
|
CheckFormRecord |
getCheckFormRecord(Type checkRecordType)
Gets the
CheckFormRecord corresponding to the given
check record Type. |
Metadata |
getFailCheckMetadata()
Gets the metadata for making this a fail check.
|
Metadata |
getHoldCheckBlockMetadata()
Gets the metadata for making this a hold check and for the block.
|
Metadata |
getInquiryCheckAuditMetadata()
Gets the metadata for making this an inquiry check and for the audit.
|
Metadata |
getProcessCheckAgendaMetadata()
Gets the metadata for making this a process check and for the agenda.
|
Metadata |
getTimeCheckCyclicEventMetadata()
Gets the metadata for making this a time check and for the cyclic
event.
|
Metadata |
getTimeCheckEndDateMetadata()
Gets the metadata for making this a time check and for the end date.
|
Metadata |
getTimeCheckEventMetadata()
Gets the metadata for making this a time check and for the event.
|
Metadata |
getTimeCheckStartDateMetadata()
Gets the metadata for making this a time check and for the start date.
|
void |
setFailCheck()
Makes this check a fail check.
|
void |
setHoldCheckBlock(Id blockId)
Sets the block and make this a hold check,.
|
void |
setInqiiryCheckAudit(Id auditId)
Sets the audit and make this an inquiry check,.
|
void |
setProcessCheckAgenda(Id agendaId)
Sets the agenda and make this a process check,.
|
void |
setTimeCheckCyclicEvent(Id cyclicEventId)
Sets the cyclic event and make this a time check,.
|
void |
setTimeCheckEndDate(DateTime date)
Sets the end date and make this a time check,.
|
void |
setTimeCheckEvent(Id eventId)
Sets the event and make this a time check,.
|
void |
setTimeCheckStartDate(DateTime date)
Sets the start date and make this a time check,.
|
clearRule, getRuleMetadata, setRule
clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType
getRequiredRecordTypes
getRecordTypes, hasRecordType
getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale
getId, isCurrent
clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled
Metadata getFailCheckMetadata()
mandatory
- This method must be implemented. void setFailCheck()
NoAccessException
- Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. void clearFailCheck()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTimeCheckStartDateMetadata()
mandatory
- This method must be implemented. void setTimeCheckStartDate(DateTime date)
date
- the new start dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearTimeCheckStartDate()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTimeCheckEndDateMetadata()
mandatory
- This method must be implemented. void setTimeCheckEndDate(DateTime date)
date
- the new end dateInvalidArgumentException
- date
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- date
is
null
mandatory
- This method must be implemented. void clearTimeCheckEndDate()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTimeCheckEventMetadata()
mandatory
- This method must be implemented. void setTimeCheckEvent(Id eventId)
eventId
- the new eventInvalidArgumentException
- eventId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- eventId
is
null
mandatory
- This method must be implemented. void clearTimeCheckEvent()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getTimeCheckCyclicEventMetadata()
mandatory
- This method must be implemented. void setTimeCheckCyclicEvent(Id cyclicEventId)
cyclicEventId
- the new cyclic eventInvalidArgumentException
- cyclicEventId
is invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- cyclicEventId
is
null
mandatory
- This method must be implemented. void clearTimeCheckCyclicEvent()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getHoldCheckBlockMetadata()
mandatory
- This method must be implemented. void setHoldCheckBlock(Id blockId)
blockId
- the new blockInvalidArgumentException
- blockId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- blockId
is
null
mandatory
- This method must be implemented. void clearHoldCheckBlock()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getInquiryCheckAuditMetadata()
mandatory
- This method must be implemented. void setInqiiryCheckAudit(Id auditId)
auditId
- the new auditInvalidArgumentException
- auditId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- auditId
is
null
mandatory
- This method must be implemented. void clearInquiryCheckAudit()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. Metadata getProcessCheckAgendaMetadata()
mandatory
- This method must be implemented. void setProcessCheckAgenda(Id agendaId)
agendaId
- the new agendaInvalidArgumentException
- agendaId
is
invalidNoAccessException
- Metadata.isReadOnly()
is true
NullArgumentException
- agendaId
is
null
mandatory
- This method must be implemented. void clearProcessCheckAgenda()
NoAccessException
- Metadata.isRequired()
is true
or Metadata.isReadOnly()
is true
mandatory
- This method must be implemented. CheckFormRecord getCheckFormRecord(Type checkRecordType) throws OperationFailedException, PermissionDeniedException
CheckFormRecord
corresponding to the given
check record Type.
checkRecordType
- a check record typeNullArgumentException
- checkRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(checkRecordType)
is false
mandatory
- This method must be implemented.