OSID Logo
OSID Specifications
installation package
Version 3.0.0
Release Candidate Preview
Interfaceosid.installation.SiteLookupSession
Implementsosid.OsidSession
Description

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.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition

Sites may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Site.

MethodcanLookupSites
Description

Tests if this user can perform 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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeSiteView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenarySiteView
Description

A complete view of the 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.

CompliancemandatoryThis method is must be implemented.
MethodgetSite
Description

Gets the 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.

Parametersosid.id.IdsiteId Id of the Site
Returnosid.installation.Sitethe site
ErrorsNOT_FOUND siteId not found
NULL_ARGUMENT siteId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method is must be implemented.
MethodgetSites
Description

Gets all 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.

Returnosid.installation.SiteLista SiteList
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.