OSID Logo
OSID Specifications
control rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.rules.InputEnablerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes input enablers. The data for create and update is provided via the InputEnablerForm.

MethodgetSystemId
Description

Gets the System Id associated with this session.

Returnosid.id.Idthe System Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetSystem
Description

Gets the System associated with this session.

Returnosid.control.Systemthe system
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateInputEnabler
Description

Tests if this user can create input enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an InputEnabler 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 InputEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateInputEnablerWithRecordTypes
Description

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

Parametersosid.type.Type[]inputEnablerRecordTypesarray of input enabler record types
Returnboolean true if InputEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT inputEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetInputEnablerFormForCreate
Description

Gets the input enabler form for creating new input enablers. A new form should be requested for each create transaction.

Parametersosid.type.Type[]inputEnablerRecordTypesarray of input enabler record types
Returnosid.control.rules.InputEnablerFormthe input enabler form
ErrorsNULL_ARGUMENT inputEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateInputEnabler
Description

Creates a new InputEnabler.

Parametersosid.control.rules.InputEnablerForminputEnablerFormthe form for this InputEnabler
Returnosid.control.rules.InputEnablerthe new InputEnabler
ErrorsILLEGAL_STATE inputEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT inputEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED inputEnablerForm did not originate from getInputEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateInputEnablers
Description

Tests if this user can update input enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an InputEnabler 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 InputEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetInputEnablerFormForUpdate
Description

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

Parametersosid.id.IdinputEnablerIdthe Id of the InputEnabler
Returnosid.control.rules.InputEnablerFormthe input enabler form
ErrorsNOT_FOUND inputEnablerId is not found
NULL_ARGUMENT inputEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateInputEnabler
Description

Updates an existing input enabler.

Parametersosid.control.rules.InputEnablerForminputEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE inputEnablerForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT inputEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED inputEnablerForm did not originate from getInputEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteInputEnablers
Description

Tests if this user can delete input enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an InputEnabler 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 InputEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteInputEnabler
Description

Deletes an InputEnabler.

Parametersosid.id.IdinputEnablerIdthe Id of the InputEnabler to remove
ErrorsNOT_FOUND inputEnablerId not found
NULL_ARGUMENT inputEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageInputEnablerAliases
Description

Tests if this user can manage Id aliases for input enablers. 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 InputEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasInputEnabler
Description

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

Parametersosid.id.IdinputEnablerIdthe Id of an InputEnabler
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND inputEnablerId not found
NULL_ARGUMENT inputEnablerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.