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

This session provides methods to re-assign ActionEnabler to System mappings. An ActionEnabler may appear in multiple System objects and removing the last reference to an ActionEnabler is the equivalent of deleting it. Each System may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an ActionEnabler to another System is not a copy operation (eg: does not change its Id ).

MethodcanAssignActionEnablers
Description

Tests if this user can alter action enabler/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignActionEnablersToSystem
Description

Tests if this user can alter action enabler/system mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parametersosid.id.IdsystemIdthe Id of the System
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT systemId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableSystemIds
Description

Gets a list of systems including and under the given system node in which any action enabler can be assigned.

Parametersosid.id.IdsystemIdthe Id of the System
Returnosid.id.IdListlist of assignable system Ids
ErrorsNULL_ARGUMENT systemId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableSystemIdsForActionEnabler
Description

Gets a list of systems including and under the given system node in which a specific action enabler can be assigned.

Parametersosid.id.IdsystemIdthe Id of the System
osid.id.IdactionEnablerIdthe Id of the ActionEnabler
Returnosid.id.IdListlist of assignable system Ids
ErrorsNULL_ARGUMENT systemId or actionEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignActionEnablerToSystem
Description

Adds an existing ActionEnabler to a System.

Parametersosid.id.IdactionEnablerIdthe Id of the ActionEnabler
osid.id.IdsystemIdthe Id of the System
ErrorsALREADY_EXISTS actionEnablerId already assigned to systemId
NOT_FOUND actionEnablerId or systemId not found
NULL_ARGUMENT actionEnablerId or systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignActionEnablerFromSystem
Description

Removes an ActionEnabler from a System.

Parametersosid.id.IdactionEnablerIdthe Id of the ActionEnabler
osid.id.IdsystemIdthe Id of the System
ErrorsNOT_FOUND actionEnablerId or systemId not found or actionEnablerId already assigned to systemId
NULL_ARGUMENT actionEnablerId or systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignActionEnablerToSystem
Description

Moves an ActionEnabler from one System to another. Mappings to other Systems are unaffected.

Parametersosid.id.IdactionEnablerIdthe Id of the ActionEnabler
osid.id.IdfromSystemIdthe Id of the current System
osid.id.IdtoSystemIdthe Id of the destination System
ErrorsNOT_FOUND actionEnablerId, fromSystemId, or toSystemId not found or actionEnablerId not mapped to fromSystemId
NULL_ARGUMENT actionEnablerId, fromSystemId, or toSystemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.