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:
Modifier and Type | Method and 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupPersonRealmMappings()
PERMISSION_DENIED.
This is intendedas
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeRealmView()
mandatory
- This method is must be implemented. void usePlenaryRealmView()
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.mandatory
- This method is must be implemented. IdList getPersonIdsByRealm(Id realmId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Realm.
realmId
- Id
of a Realms.
Ids
NotFoundException
- realmId
is not foundNullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PersonList getPersonsByRealm(Id realmId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Persons
associated with a
Realm.
realmId
- Id
of a Realm
NotFoundException
- realmId
is not foundNullArgumentException
- realmId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getPersonIdsByRealms(IdList realmIds) throws OperationFailedException, PermissionDeniedException
Person Ids
corresponding to a list of
Realm
objects.realmIds
- list of realm Ids
Ids
NullArgumentException
- realmIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. PersonList getPersonsByRealms(IdList realmIds) throws OperationFailedException, PermissionDeniedException
Persons
corresponding to a list of
Realms.
realmIds
- list of realm Ids
NullArgumentException
- realmIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getRealmIdsByPerson(Id personId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Realm
Ids
mapped to a
Person.
personId
- Id
of a Person
Ids
NotFoundException
- personId
is not
foundNullArgumentException
- personId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RealmList getRealmsByPerson(Id personId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Realm
objects mapped to a
Person.
personId
- Id
of a Person
NotFoundException
- personId
is not
foundNullArgumentException
- personId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.