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

This session provides methods to retrieve Person to Realm mappings. A Person may appear in multiple Realms. Each Realm may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupPersonRealmMappings
Description

Tests if this user can perform lookups of person/realm mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeRealmView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryRealmView
Description

A complete view of the Person and Realm returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

CompliancemandatoryThis method is must be implemented.
MethodgetPersonIdsByRealm
Description

Gets the list of Person Ids associated with a Realm.

Parametersosid.id.IdrealmId Id of a Realms.
Returnosid.id.IdListlist of related person Ids
ErrorsNOT_FOUND realmId is not found
NULL_ARGUMENT realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPersonsByRealm
Description

Gets the list of Persons associated with a Realm.

Parametersosid.id.IdrealmId Id of a Realm
Returnosid.personnel.PersonListlist of related persons
ErrorsNOT_FOUND realmId is not found
NULL_ARGUMENT realmId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPersonIdsByRealms
Description

Gets the list of Person Ids corresponding to a list of Realm objects.

Parametersosid.id.IdListrealmIdslist of realm Ids
Returnosid.id.IdListlist of person Ids
ErrorsNULL_ARGUMENT realmIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetPersonsByRealms
Description

Gets the list of Persons corresponding to a list of Realms.

Parametersosid.id.IdListrealmIdslist of realm Ids
Returnosid.personnel.PersonListlist of persons
ErrorsNULL_ARGUMENT realmIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRealmIdsByPerson
Description

Gets the list of Realm Ids mapped to a Person.

Parametersosid.id.IdpersonId Id of a Person
Returnosid.id.IdListlist of realm Ids
ErrorsNOT_FOUND personId is not found
NULL_ARGUMENT personId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetRealmsByPerson
Description

Gets the list of Realm objects mapped to a Person.

Parametersosid.id.IdpersonId Id of a Person
Returnosid.personnel.RealmListlist of realms
ErrorsNOT_FOUND personId is not found
NULL_ARGUMENT personId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.