Interface PositionRealmSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface PositionRealmSession
extends OsidSession

This session provides methods to retrieve Position to Realm mappings. A Position 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	canLookupPositionRealmMappings()	Tests if this user can perform lookups of position/realm mappings.
IdList	getPositionIdsByRealm(Id realmId)	Gets the list of Position Ids associated with a Realm .
IdList	getPositionIdsByRealms(IdList realmIds)	Gets the list of Position Ids corresponding to a list of Realm objects.
PositionList	getPositionsByRealm(Id realmId)	Gets the list of Positions associated with a Realm .
PositionList	getPositionsByRealms(IdList realmIds)	Gets the list of Positions corresponding to a list of Realms .
IdList	getRealmIdsByPosition(Id positionId)	Gets the list of Realm Ids mapped to a Position .
RealmList	getRealmsByPosition(Id positionId)	Gets the list of Realm objects mapped to a Position .
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 Position 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

canLookupPositionRealmMappings

boolean canLookupPositionRealmMappings()

Tests if this user can perform lookups of position/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 Position 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.

getPositionIdsByRealm

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

Gets the list of Position Ids associated with a Realm .

Parameters:

realmId - Id of a Realms .

Returns:

list of related position 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.

getPositionsByRealm

PositionList getPositionsByRealm(Id realmId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Positions associated with a Realm .

Parameters:

realmId - Id of a Realm

Returns:

list of related positions

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.

getPositionIdsByRealms

IdList getPositionIdsByRealms(IdList realmIds)
                       throws OperationFailedException,
PermissionDeniedException

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

Parameters:

realmIds - list of realm Ids

Returns:

list of position Ids

Throws:

NullArgumentException - realmIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getPositionsByRealms

PositionList getPositionsByRealms(IdList realmIds)
                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

realmIds - list of realm Ids

Returns:

list of positions

Throws:

NullArgumentException - realmIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRealmIdsByPosition

IdList getRealmIdsByPosition(Id positionId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Realm Ids mapped to a Position .

Parameters:

positionId - Id of a Position

Returns:

list of realm Ids

Throws:

NotFoundException - positionId is not found

NullArgumentException - positionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRealmsByPosition

RealmList getRealmsByPosition(Id positionId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Realm objects mapped to a Position .

Parameters:

positionId - Id of a Position

Returns:

list of realms

Throws:

NotFoundException - positionId is not found

NullArgumentException - positionId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.