Interface PersonRealmSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PersonRealmSession
extends OsidSession

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupPersonRealmMappings()	Tests if this user can perform lookups of person/realm mappings.
IdList	getPersonIdsByRealm(Id realmId)	Gets the list of Person Ids associated with a Realm .
IdList	getPersonIdsByRealms(IdList realmIds)	Gets the list of Person Ids corresponding to a list of Realm objects.
PersonList	getPersonsByRealm(Id realmId)	Gets the list of Persons associated with a Realm .
PersonList	getPersonsByRealms(IdList realmIds)	Gets the list of Persons corresponding to a list of Realms .
IdList	getRealmIdsByPerson(Id personId)	Gets the list of Realm Ids mapped to a Person .
RealmList	getRealmsByPerson(Id personId)	Gets the list of Realm objects mapped to a Person .
void	useComparativeRealmView()	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryRealmView()	A complete view of the Person and Realm returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupPersonRealmMappings

boolean canLookupPersonRealmMappings()

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.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeRealmView

void useComparativeRealmView()

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.

Compliance:

mandatory - This method is must be implemented.

usePlenaryRealmView

void usePlenaryRealmView()

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.

Compliance:

mandatory - This method is must be implemented.

getPersonIdsByRealm

IdList getPersonIdsByRealm(Id realmId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Person Ids associated with a Realm .

Parameters:

realmId - Id of a Realms .

Returns:

list of related person Ids

Throws:

NotFoundException - realmId is not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPersonsByRealm

PersonList getPersonsByRealm(Id realmId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Persons associated with a Realm .

Parameters:

realmId - Id of a Realm

Returns:

list of related persons

Throws:

NotFoundException - realmId is not found

NullArgumentException - realmId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPersonIdsByRealms

IdList getPersonIdsByRealms(IdList realmIds)
                     throws OperationFailedException,
PermissionDeniedException

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

Parameters:

realmIds - list of realm Ids

Returns:

list of person Ids

Throws:

NullArgumentException - realmIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPersonsByRealms

PersonList getPersonsByRealms(IdList realmIds)
                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

realmIds - list of realm Ids

Returns:

list of persons

Throws:

NullArgumentException - realmIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRealmIdsByPerson

IdList getRealmIdsByPerson(Id personId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Realm Ids mapped to a Person .

Parameters:

personId - Id of a Person

Returns:

list of realm Ids

Throws:

NotFoundException - personId is not found

NullArgumentException - personId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRealmsByPerson

RealmList getRealmsByPerson(Id personId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Realm objects mapped to a Person .

Parameters:

personId - Id of a Person

Returns:

list of realms

Throws:

NotFoundException - personId is not found

NullArgumentException - personId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.