public interface OrganizationRealmSession extends OsidSession
This session provides methods to retrieve Organization
to Realm
mappings. An Organization
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 |
canLookupOrganizationRealmMappings()
Tests if this user can perform lookups of organization/realm mappings.
|
IdList |
getOrganizationIdsByRealm(Id realmId)
Gets the list of Organization Ids associated with a
Realm. |
IdList |
getOrganizationIdsByRealms(IdList realmIds)
Gets the list of
Organization Ids corresponding to a
list of Realm objects. |
OrganizationList |
getOrganizationsByRealm(Id realmId)
Gets the list of
Organizations associated with a
Realm. |
OrganizationList |
getOrganizationsByRealms(IdList realmIds)
Gets the list of
Organizations corresponding to a list
of Realms. |
IdList |
getRealmIdsByOrganization(Id organizationId)
Gets the list of
Realm Ids mapped to an
Organization. |
RealmList |
getRealmsByOrganization(Id organizationId)
Gets the list of
Realm objects mapped to an
Organization. |
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
Organization and Realm
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupOrganizationRealmMappings()
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()
Organization
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 getOrganizationIdsByRealm(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. OrganizationList getOrganizationsByRealm(Id realmId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Organizations
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 getOrganizationIdsByRealms(IdList realmIds) throws OperationFailedException, PermissionDeniedException
Organization 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. OrganizationList getOrganizationsByRealms(IdList realmIds) throws OperationFailedException, PermissionDeniedException
Organizations
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 getRealmIdsByOrganization(Id organizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Realm
Ids
mapped to an
Organization.
organizationId
- Id
of an Organization
Ids
NotFoundException
- organizationId
is
not foundNullArgumentException
- organizationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. RealmList getRealmsByOrganization(Id organizationId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Realm
objects mapped to an
Organization.
organizationId
- Id
of an Organization
NotFoundException
- organizationId
is
not foundNullArgumentException
- organizationId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.