Interface | osid.installation.SiteLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving 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 | ||
Method | canLookupSites | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeSiteView | ||
Description |
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. | |
Method | usePlenarySiteView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSite | ||
Description |
Gets the | ||
Parameters | osid.id.Id | siteId | Id of the Site |
Return | osid.installation.Site | the site | |
Errors | NOT_FOUND | siteId not found | |
NULL_ARGUMENT | siteId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getSites | ||
Description |
Gets all | ||
Return | osid.installation.SiteList | a SiteList | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |