OSID Logo
OSID Specifications
rules check package
Version 3.0.0
Release Candidate Preview
Interfaceosid.rules.check.CheckAdminSession
Implementsosid.OsidSession
Description

This session creates, updates, and deletes Checks. The data for create and update is provided by the consumer via the form object. OsidForms are requested for each create or update and may not be reused.

Create and update operations differ in their usage. To create a Check, a CheckForm is requested using getCheckFormForCreate() specifying the desired record Types or none if no record Types are needed. The returned CheckForm will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the CheckForm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each CheckForm corresponds to an attempted transaction.

For updates, CheckForms are requested to the Check Id that is to be updated using getCheckFormForUpdate(). Similarly, the CheckForm has metadata about the data that can be updated and it can perform validation before submitting the update. The CheckForm can only be used once for a successful update and cannot be reused.

The delete operations delete Checks. To unmap a Check from the current Engine, the CheckEngineAssignmentSession should be used. These delete operations attempt to remove the Check itself thus removing it from all known Engine catalogs.

This session includes an Id aliasing mechanism to assign an external Id to an internally assigned Id.

MethodgetEngineId
Description

Gets the Engine Id associated with this session.

Returnosid.id.Idthe Engine Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetEngine
Description

Gets the Engine associated with this session.

Returnosid.rules.Enginethe engine
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateChecks
Description

Tests if this user can create Checks. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a Check will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.

Returnboolean false if Check creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateCheckWithRecordTypes
Description

Tests if this user can create a single Check using the desired record types. While RulesCheckManager.getCheckRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific Check. Providing an empty array tests if a Check can be created with no records.

Parametersosid.type.Type[]checkRecordTypesarray of check record types
Returnboolean true if Check creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT checkRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodcreateCheck
Description

Creates a new Check.

Parametersosid.rules.check.CheckFormcheckFormthe form for this Check
Returnosid.rules.check.Checkthe new Check
ErrorsILLEGAL_STATE checkForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT checkForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED checkForm did not originat from getCheckFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateChecks
Description

Tests if this user can update Checks. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a Check will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.

Returnboolean false if Check modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetCheckFormForUpdate
Description

Gets the check form for updating an existing hold. A new check form should be requested for each update transaction.

Parametersosid.id.IdcheckIdthe Id of the Check
Returnosid.rules.check.CheckFormthe check form
ErrorsNOT_FOUND checkId is not found
NULL_ARGUMENT checkId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodupdateCheck
Description

Updates an existing hold.

Parametersosid.rules.check.CheckFormcheckFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE checkForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT checkId or checkForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED checkForm did not originat from getCheckFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteChecks
Description

Tests if this user can delete Checks. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a Check will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.

Returnboolean false if Check deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteCheck
Description

Deletes a Check.

Parametersosid.id.IdcheckIdthe Id of the Check to remove
ErrorsNOT_FOUND checkId not found
NULL_ARGUMENT checkId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageCheckAliases
Description

Tests if this user can manage Id aliases for Checks. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.

Returnboolean false if Check aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasCheck
Description

Adds an Id to a Check for the purpose of creating compatibility. The primary Id of the Check is determined by the provider. The new Id performs as an alias to the primary Id. If the alias is a pointer to another check, it is reassigned to the given check Id.

Parametersosid.id.IdcheckIdthe Id of a Check
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND checkId not found
NULL_ARGUMENT checkId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.