Interface CheckForm

All Superinterfaces:

Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, Suppliable

public interface CheckForm
extends OsidRuleForm

This is the form for creating and updating Checks . Like all OsidForms , 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

• Fail Check
• Time Check By Date
• Time Check by Event
• Time Check By Cyclic Event
• Hold Check
• Authorization Check
• Inquiry Check
• Process Check
• Logging Check

is determined based on what data is set. If multiple fields are set, the provider will pick one at random.

Method Summary

Modifier and Type	Method	Description
void	clearAuthorizationCheckFunction()	Removes the function.
void	clearFailCheck()	Removes the fail check setting.
void	clearHoldCheckBlock()	Removes the block.
void	clearInquiryCheckAudit()	Removes the audit.
void	clearLoggingCheckText()	Removes the text.
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.
Metadata	getAuthorizationCheckFunctionMetadata()	Gets the metadata for making this an authorization check and for the function.
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	getLoggingCheckTextMetadata()	Gets the metadata for making this a logging check and for the text.
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	setAuthorizationCheckFunction(Id functionId)	Sets the function and make this an authorization check.
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	setLoggingCheckText(Id textId)	Sets the text and make this a logging 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.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidExtensibleForm

getRequiredRecordTypes

Modifier and Type	Method	Description
TypeList	getRequiredRecordTypes()	Gets the minimum required record types for successful submission of this OsidForm .

Methods inherited from interface OsidForm

getDefaultLocale, getInvalidMetadata, getJournalCommentMetadata, getLocales, getValidationMessages, isForUpdate, isValid, setJournalComment, setLocale

Modifier and Type	Method	Description
Locale	getDefaultLocale()	Gets a default locale for the form.
Metadata[]	getInvalidMetadata()	Gets a list of metadata for the elements in this form which are not valid.
Metadata	getJournalCommentMetadata()	Gets the metadata for the comment corresponding to this form submission.
LocaleList	getLocales()	Gets the locales available for this form.
DisplayText[]	getValidationMessages()	Gets text messages corresponding to additional instructions to pass form validation.
boolean	isForUpdate()	Tests if this form is for an update operation.
boolean	isValid()	Tests if this form is in a valid state for submission.
void	setJournalComment(String comment)	Sets a comment.
void	setLocale(Type languageType, Type scriptType)	Specifies a language and script type for the form.

Methods inherited from interface OsidObjectForm

clearDescription, clearDisplayName, clearGenusType, getDescriptionMetadata, getDisplayNameMetadata, getGenusTypeMetadata, setDescription, setDisplayName, setGenusType

Modifier and Type	Method	Description
void	clearDescription()	Clears the description.
void	clearDisplayName()	Clears the display name.
void	clearGenusType()	Clears the genus type.
Metadata	getDescriptionMetadata()	Gets the metadata for a description.
Metadata	getDisplayNameMetadata()	Gets the metadata for a display name.
Metadata	getGenusTypeMetadata()	Gets the metadata for a genus type.
void	setDescription(String description)	Sets a description.
void	setDisplayName(String displayName)	Sets a display name.
void	setGenusType(Type genusType)	Sets a genus.

Methods inherited from interface OsidOperableForm

clearDisabled, clearEnabled, getDisabledMetadata, getEnabledMetadata, setDisabled, setEnabled

Modifier and Type	Method	Description
void	clearDisabled()	Removes the administratively disabled flag.
void	clearEnabled()	Removes the administratively enabled flag.
Metadata	getDisabledMetadata()	Gets the metadata for the disabled flag.
Metadata	getEnabledMetadata()	Gets the metadata for the enabled flag.
void	setDisabled(boolean disabled)	Sets the administratively disabled flag.
void	setEnabled(boolean enabled)	Sets the administratively enabled flag.

Methods inherited from interface OsidRuleForm

clearConditionRecordTypes, clearRule, getConditionRecordTypesMetadata, getRuleMetadata, setConditionRecordTypes, setRule

Modifier and Type	Method	Description
void	clearConditionRecordTypes()	Clears the condition record types.
void	clearRule()	Removes the rule.
Metadata	getConditionRecordTypesMetadata()	Gets the metadata for the condition record types.
Metadata	getRuleMetadata()	Gets the metadata for an associated rule.
void	setConditionRecordTypes(Type[] conditionRecordTypes)	Sets the condition record types.
void	setRule(Id ruleId)	Sets a rule.

Method Details

getFailCheckMetadata

Metadata getFailCheckMetadata()

Gets the metadata for making this a fail check.

Returns:

metadata for the competency

Compliance:

mandatory - This method must be implemented.

setFailCheck

void setFailCheck()

Makes this check a fail check.

Throws:

NoAccessException - Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

clearFailCheck

void clearFailCheck()

Removes the fail check setting.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTimeCheckStartDateMetadata

Metadata getTimeCheckStartDateMetadata()

Gets the metadata for making this a time check and for the start date.

Returns:

metadata for time check start date

Compliance:

mandatory - This method must be implemented.

setTimeCheckStartDate

void setTimeCheckStartDate(DateTime date)

Sets the start date and make this a time check.

Parameters:

date - the new start date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearTimeCheckStartDate

void clearTimeCheckStartDate()

Removes the start date.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTimeCheckEndDateMetadata

Metadata getTimeCheckEndDateMetadata()

Gets the metadata for making this a time check and for the end date.

Returns:

metadata for time check end date

Compliance:

mandatory - This method must be implemented.

setTimeCheckEndDate

void setTimeCheckEndDate(DateTime date)

Sets the end date and make this a time check.

Parameters:

date - the new end date

Throws:

InvalidArgumentException - date is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - date is null

Compliance:

mandatory - This method must be implemented.

clearTimeCheckEndDate

void clearTimeCheckEndDate()

Removes the end date.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTimeCheckEventMetadata

Metadata getTimeCheckEventMetadata()

Gets the metadata for making this a time check and for the event.

Returns:

metadata for time check event

Compliance:

mandatory - This method must be implemented.

setTimeCheckEvent

void setTimeCheckEvent(Id eventId)

Sets the event and make this a time check.

Parameters:

eventId - the new event

Throws:

InvalidArgumentException - eventId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - eventId is null

Compliance:

mandatory - This method must be implemented.

clearTimeCheckEvent

void clearTimeCheckEvent()

Removes the event.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getTimeCheckCyclicEventMetadata

Metadata getTimeCheckCyclicEventMetadata()

Gets the metadata for making this a time check and for the cyclic event.

Returns:

metadata for time check cyclic event

Compliance:

mandatory - This method must be implemented.

setTimeCheckCyclicEvent

void setTimeCheckCyclicEvent(Id cyclicEventId)

Sets the cyclic event and make this a time check.

Parameters:

cyclicEventId - the new cyclic event

Throws:

InvalidArgumentException - cyclicEventId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - cyclicEventId is null

Compliance:

mandatory - This method must be implemented.

clearTimeCheckCyclicEvent

void clearTimeCheckCyclicEvent()

Removes the cyclic event.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getHoldCheckBlockMetadata

Metadata getHoldCheckBlockMetadata()

Gets the metadata for making this a hold check and for the block.

Returns:

metadata for hold check block

Compliance:

mandatory - This method must be implemented.

setHoldCheckBlock

void setHoldCheckBlock(Id blockId)

Sets the block and make this a hold check.

Parameters:

blockId - the new block

Throws:

InvalidArgumentException - blockId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - blockId is null

Compliance:

mandatory - This method must be implemented.

clearHoldCheckBlock

void clearHoldCheckBlock()

Removes the block.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getAuthorizationCheckFunctionMetadata

Metadata getAuthorizationCheckFunctionMetadata()

Gets the metadata for making this an authorization check and for the function.

Returns:

metadata for authorization check function

Compliance:

mandatory - This method must be implemented.

setAuthorizationCheckFunction

void setAuthorizationCheckFunction(Id functionId)

Sets the function and make this an authorization check.

Parameters:

functionId - the new function

Throws:

InvalidArgumentException - fiunctionId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - functionId is null

Compliance:

mandatory - This method must be implemented.

clearAuthorizationCheckFunction

void clearAuthorizationCheckFunction()

Removes the function.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getInquiryCheckAuditMetadata

Metadata getInquiryCheckAuditMetadata()

Gets the metadata for making this an inquiry check and for the audit.

Returns:

metadata for inquiry check audit

Compliance:

mandatory - This method must be implemented.

setInqiiryCheckAudit

void setInqiiryCheckAudit(Id auditId)

Sets the audit and make this an inquiry check.

Parameters:

auditId - the new audit

Throws:

InvalidArgumentException - auditId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - auditId is null

Compliance:

mandatory - This method must be implemented.

clearInquiryCheckAudit

void clearInquiryCheckAudit()

Removes the audit.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getProcessCheckAgendaMetadata

Metadata getProcessCheckAgendaMetadata()

Gets the metadata for making this a process check and for the agenda.

Returns:

metadata for process check agenda

Compliance:

mandatory - This method must be implemented.

setProcessCheckAgenda

void setProcessCheckAgenda(Id agendaId)

Sets the agenda and make this a process check.

Parameters:

agendaId - the new agenda

Throws:

InvalidArgumentException - agendaId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - agendaId is null

Compliance:

mandatory - This method must be implemented.

clearProcessCheckAgenda

void clearProcessCheckAgenda()

Removes the agenda.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getLoggingCheckTextMetadata

Metadata getLoggingCheckTextMetadata()

Gets the metadata for making this a logging check and for the text.

Returns:

metadata for logging check text

Compliance:

mandatory - This method must be implemented.

setLoggingCheckText

void setLoggingCheckText(Id textId)

Sets the text and make this a logging check.

Parameters:

textId - the new text

Throws:

InvalidArgumentException - textId is invalid

NoAccessException - Metadata.isReadOnly() is true

NullArgumentException - textId is null

Compliance:

mandatory - This method must be implemented.

clearLoggingCheckText

void clearLoggingCheckText()

Removes the text.

Throws:

NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true

Compliance:

mandatory - This method must be implemented.

getCheckFormRecord

CheckFormRecord getCheckFormRecord(Type checkRecordType)
                            throws OperationFailedException,
PermissionDeniedException

Gets the CheckFormRecord corresponding to the given check record Type .

Parameters:

checkRecordType - a check record type

Returns:

the check form record

Throws:

NullArgumentException - checkRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(checkRecordType) is false

Compliance:

mandatory - This method must be implemented.