OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Interfaceosid.personnel.PositionRealmAssignmentSession
Implementsosid.OsidSession
Used Byosid.personnel.PersonnelManager
osid.personnel.PersonnelProxyManager
Description

This session provides methods to re-assign Positions to Bilings . A Position may map to multiple Realms and removing the last reference to a Position is the equivalent of deleting it. Each Realm may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Position to another Realm is not a copy operation (eg: does not change its Id ).

MethodcanAssignPositions
Description

Tests if this user can alter position/realm 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.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignPositionsToRealm
Description

Tests if this user can alter position/realm 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.IdrealmIdthe Id of the Realm
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTrealmId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableRealmIds
Description

Gets a list of realms including and under the given realm node in which any position can be assigned.

Parametersosid.id.IdrealmIdthe Id of the Realm
Returnosid.id.IdListlist of assignable realm Ids
ErrorsNULL_ARGUMENTrealmId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableRealmIdsForPosition
Description

Gets a list of realms including and under the given realm node in which a specific position can be assigned.

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.id.IdpositionIdthe Id of the Position
Returnosid.id.IdListlist of assignable realm Ids
ErrorsNULL_ARGUMENTrealmId or positionId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignPositionToRealm
Description

Adds an existing Position to a Realm .

Parametersosid.id.IdpositionIdthe Id of the Position
osid.id.IdrealmIdthe Id of the Realm
ErrorsALREADY_EXISTSpositionId already assigned to realmId
NOT_FOUNDpositionId or realmId not found
NULL_ARGUMENTpositionId or realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignPositionFromRealm
Description

Removes a Position from a Realm .

Parametersosid.id.IdpositionIdthe Id of the Position
osid.id.IdrealmIdthe Id of the Realm
ErrorsNOT_FOUNDpositionId or realmId not found or positionId not mapped to realmId
NULL_ARGUMENTpositionId or realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignPositionToRealm
Description

Moves a Position from one Realm to another. Mappings to other Realms are unaffected.

Parametersosid.id.IdpositionIdthe Id of the Position
osid.id.IdfromRealmIdthe Id of the current Realm
osid.id.IdtoRealmIdthe Id of the destination Realm
ErrorsALREADY_EXISTSpositionId already assigned to toRealmId
NOT_FOUNDpositionId, fromRealmId , or toRealmId not found or positionId not mapped to fromRealmId
NULL_ARGUMENTpositionId, fromRealmId , or toRealmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.