public interface SiteLookupSession extends OsidSession
This session provides methods for retrieving Site
objects. The Site
represents a collection of
Installations.
This session defines views that offer differing behaviors when retrieving multiple objects.
Sites may have an additional records indicated by their respective
record types. The record may not be accessed through a cast of the
Site.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupSites()
Tests if this user can perform
Site lookups. |
Site |
getSite(Id siteId)
Gets the
Site specified by its Id. |
SiteList |
getSites()
Gets all
Sites. |
void |
useComparativeSiteView()
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 |
usePlenarySiteView()
A complete view of the
Site returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canLookupSites()
Site
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeSiteView()
mandatory
- This method is must be implemented. void usePlenarySiteView()
Site
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. Site getSite(Id siteId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Site
specified by its Id.
In
plenary mode, the exact Id
is found or a
NOT_FOUND
results. Otherwise, the returned Site
may have a different Id
than requested, such as the
case where a duplicate Id
was assigned to a Site
and retained for compatibility.siteId
- Id
of the Site
NotFoundException
- siteId
not foundNullArgumentException
- siteId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method is must be implemented. SiteList getSites() throws OperationFailedException, PermissionDeniedException
Sites.
In plenary mode, the returned list
contains all known sites or an error results. Otherwise, the returned
list may contain only those sites that are accessible through this
session. SiteList
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.