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

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

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.
MethodcanCreateActionEnabler
Description

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

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

Parametersosid.type.Type[]actionEnablerRecordTypesarray of action enabler record types
Returnboolean true if ActionEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT actionEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetActionEnablerFormForCreate
Description

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

Parametersosid.type.Type[]actionEnablerRecordTypesarray of action enabler record types
Returnosid.control.rules.ActionEnablerFormthe action enabler form
ErrorsNULL_ARGUMENT actionEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateActionEnabler
Description

Creates a new ActionEnabler.

Parametersosid.control.rules.ActionEnablerFormactionEnablerFormthe form for this ActionEnabler
Returnosid.control.rules.ActionEnablerthe new ActionEnabler
ErrorsILLEGAL_STATE actionEnablerForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT actionEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED actionEnablerForm did not originate from getActionEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateActionEnablers
Description

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

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

Parametersosid.id.IdactionEnablerIdthe Id of the ActionEnabler
Returnosid.control.rules.ActionEnablerFormthe action enabler form
ErrorsNOT_FOUND actionEnablerId is not found
NULL_ARGUMENT actionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateActionEnabler
Description

Updates an existing action enabler.

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

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

Deletes an ActionEnabler.

Parametersosid.id.IdactionEnablerIdthe Id of the ActionEnabler to remove
ErrorsNOT_FOUND actionEnablerId not found
NULL_ARGUMENT actionEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageActionEnablerAliases
Description

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

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

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