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

This session provides methods to re-assign ActionGroups to System mappings. An ActionGroup may appear in multiple System objects and removing the last reference to an ActionGroup 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 ActionGroup to another System is not a copy operation (eg: does not change its Id ).

MethodcanAssignActionGroups
Description

Tests if this user can alter action group/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 assignment operations to unauthorized users.

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

Tests if this user can alter action group/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 assignment 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 group 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.
MethodgetAssignableSystemIdsForActionGroup
Description

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

Parametersosid.id.IdsystemIdthe Id of the System
osid.id.IdactionGroupIdthe Id of the ActionGroup
Returnosid.id.IdListlist of assignable system Ids
ErrorsNULL_ARGUMENT systemId or actionGroupId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignActionGroupToSystem
Description

Adds an existing ActionGroup to a System.

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

Removes an ActionGroup from a System.

Parametersosid.id.IdactionGroupIdthe Id of the ActionGroup
osid.id.IdsystemIdthe Id of the System
ErrorsNOT_FOUND actionGroupId or systemId not found or actionGroupId not assigned to systemId
NULL_ARGUMENT actionGroupId or systemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignActionGroupToSystem
Description

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

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