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

Interface	osid.rules.check.CheckForm
Implements	`osid.OsidRuleForm`
Used By	`osid.rules.check.CheckAdminSession`
Description	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	getFailCheckMetadata
Description	Gets the metadata for making this a fail check.
Return	`osid.Metadata`		metadata for the competency
Compliance	`mandatory`		This method must be implemented.
Method	setFailCheck
Description	Makes this check a fail check.
Errors	NO_ACCESS		`Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	clearFailCheck
Description	Removes the fail check setting.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckStartDateMetadata
Description	Gets the metadata for making this a time check and for the start date.
Return	`osid.Metadata`		metadata for time check start date
Compliance	`mandatory`		This method must be implemented.
Method	setTimeCheckStartDate
Description	Sets the start date and make this a time check.
Parameters	`osid.calendaring.DateTime`	`date`	the new start date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeCheckStartDate
Description	Removes the start date.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckEndDateMetadata
Description	Gets the metadata for making this a time check and for the end date.
Return	`osid.Metadata`		metadata for time check end date
Compliance	`mandatory`		This method must be implemented.
Method	setTimeCheckEndDate
Description	Sets the end date and make this a time check.
Parameters	`osid.calendaring.DateTime`	`date`	the new end date
Errors	INVALID_ARGUMENT		`date` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`date` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeCheckEndDate
Description	Removes the end date.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckEventMetadata
Description	Gets the metadata for making this a time check and for the event.
Return	`osid.Metadata`		metadata for time check event
Compliance	`mandatory`		This method must be implemented.
Method	setTimeCheckEvent
Description	Sets the event and make this a time check.
Parameters	`osid.id.Id`	`eventId`	the new event
Errors	INVALID_ARGUMENT		`eventId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`eventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeCheckEvent
Description	Removes the event.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getTimeCheckCyclicEventMetadata
Description	Gets the metadata for making this a time check and for the cyclic event.
Return	`osid.Metadata`		metadata for time check cyclic event
Compliance	`mandatory`		This method must be implemented.
Method	setTimeCheckCyclicEvent
Description	Sets the cyclic event and make this a time check.
Parameters	`osid.id.Id`	`cyclicEventId`	the new cyclic event
Errors	INVALID_ARGUMENT		`cyclicEventId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`cyclicEventId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearTimeCheckCyclicEvent
Description	Removes the cyclic event.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getHoldCheckBlockMetadata
Description	Gets the metadata for making this a hold check and for the block.
Return	`osid.Metadata`		metadata for hold check block
Compliance	`mandatory`		This method must be implemented.
Method	setHoldCheckBlock
Description	Sets the block and make this a hold check.
Parameters	`osid.id.Id`	`blockId`	the new block
Errors	INVALID_ARGUMENT		`blockId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`blockId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearHoldCheckBlock
Description	Removes the block.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getAuthorizationCheckFunctionMetadata
Description	Gets the metadata for making this an authorization check and for the function.
Return	`osid.Metadata`		metadata for authorization check function
Compliance	`mandatory`		This method must be implemented.
Method	setAuthorizationCheckFunction
Description	Sets the function and make this an authorization check.
Parameters	`osid.id.Id`	`functionId`	the new function
Errors	INVALID_ARGUMENT		`fiunctionId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`functionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAuthorizationCheckFunction
Description	Removes the function.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getInquiryCheckAuditMetadata
Description	Gets the metadata for making this an inquiry check and for the audit.
Return	`osid.Metadata`		metadata for inquiry check audit
Compliance	`mandatory`		This method must be implemented.
Method	setInqiiryCheckAudit
Description	Sets the audit and make this an inquiry check.
Parameters	`osid.id.Id`	`auditId`	the new audit
Errors	INVALID_ARGUMENT		`auditId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`auditId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearInquiryCheckAudit
Description	Removes the audit.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessCheckAgendaMetadata
Description	Gets the metadata for making this a process check and for the agenda.
Return	`osid.Metadata`		metadata for process check agenda
Compliance	`mandatory`		This method must be implemented.
Method	setProcessCheckAgenda
Description	Sets the agenda and make this a process check.
Parameters	`osid.id.Id`	`agendaId`	the new agenda
Errors	INVALID_ARGUMENT		`agendaId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`agendaId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearProcessCheckAgenda
Description	Removes the agenda.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getLoggingCheckTextMetadata
Description	Gets the metadata for making this a logging check and for the text.
Return	`osid.Metadata`		metadata for logging check text
Compliance	`mandatory`		This method must be implemented.
Method	setLoggingCheckText
Description	Sets the text and make this a logging check.
Parameters	`osid.id.Id`	`textId`	the new text
Errors	INVALID_ARGUMENT		`textId` is invalid
	NO_ACCESS		`Metadata.isReadOnly()` is `true`
	NULL_ARGUMENT		`textId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearLoggingCheckText
Description	Removes the text.
Errors	NO_ACCESS		`Metadata.isRequired()` is `true` or `Metadata.isReadOnly()` is `true`
Compliance	`mandatory`		This method must be implemented.
Method	getCheckFormRecord
Description	Gets the `CheckFormRecord` corresponding to the given check record `Type`.
Parameters	`osid.type.Type`	`checkRecordType`	a check record type
Return	`osid.rules.check.records.CheckFormRecord`		the check form 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.