OSID Logo
OSID Specifications
personnel package
Version 3.0.0
Release Candidate Preview
Interfaceosid.personnel.PersonRealmAssignmentSession
Implementsosid.OsidSession
Description

This session provides methods to re-assign Persons to Bilings. A Person may map to multiple Realms and removing the last reference to a Person 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 Person to another Realm is not a copy operation (eg: does not change its Id ).

MethodcanAssignPersons
Description

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

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

Tests if this user can alter person/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
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT realmId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableRealmIds
Description

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

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

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

Parametersosid.id.IdrealmIdthe Id of the Realm
osid.id.IdpersonIdthe Id of the Person
Returnosid.id.IdListlist of assignable realm Ids
ErrorsNULL_ARGUMENT realmId or personId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignPersonToRealm
Description

Adds an existing Person to a Realm.

Parametersosid.id.IdpersonIdthe Id of the Person
osid.id.IdrealmIdthe Id of the Realm
ErrorsALREADY_EXISTS personId already assigned to realmId
NOT_FOUND personId or realmId not found
NULL_ARGUMENT personId or realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignPersonFromRealm
Description

Removes a Person from a Realm.

Parametersosid.id.IdpersonIdthe Id of the Person
osid.id.IdrealmIdthe Id of the Realm
ErrorsNOT_FOUND personId or realmId not found or personId not mapped to realmId
NULL_ARGUMENT personId or realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.