Interface LeaseCampusSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface LeaseCampusSession
extends OsidSession

This session provides methods to retrieve Lease to Campus mappings. A Lease may appear in multiple Campuses . Each Campus may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupLeaseCampusMappings()	Tests if this user can perform lookups of lease/campus mappings.
CampusList	getCampusesByLease(Id leaseId)	Gets the list of Campus objects mapped to a Lease .
IdList	getCampusIdsByLease(Id leaseId)	Gets the list of Campus Ids mapped to a Lease .
IdList	getLeaseIdsByCampus(Id campusId)	Gets the list of Lease Ids associated with a Campus .
IdList	getLeaseIdsByCampuses(IdList campusIds)	Gets the list of Lease Ids corresponding to a list of Campus objects.
LeaseList	getLeasesByCampus(Id campusId)	Gets the list of Leases associated with a Campus .
LeaseList	getLeasesByCampuses(IdList campusIds)	Gets the list of Leases corresponding to a list of Campuses .
void	useComparativeCampusView()	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	usePlenaryCampusView()	A complete view of the Lease and Campus returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupLeaseCampusMappings

boolean canLookupLeaseCampusMappings()

Tests if this user can perform lookups of lease/campus mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intendedas a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeCampusView

void useComparativeCampusView()

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.

usePlenaryCampusView

void usePlenaryCampusView()

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

Compliance:

mandatory - This method is must be implemented.

getLeaseIdsByCampus

IdList getLeaseIdsByCampus(Id campusId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Lease Ids associated with a Campus .

Parameters:

campusId - Id of a Campus

Returns:

list of related lease Ids

Throws:

NotFoundException - campusId is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLeasesByCampus

LeaseList getLeasesByCampus(Id campusId)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Leases associated with a Campus .

Parameters:

campusId - Id of a Campus

Returns:

list of related leases

Throws:

NotFoundException - campusId is not found

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLeaseIdsByCampuses

IdList getLeaseIdsByCampuses(IdList campusIds)
                      throws OperationFailedException,
PermissionDeniedException

Gets the list of Lease Ids corresponding to a list of Campus objects.

Parameters:

campusIds - list of campus Ids

Returns:

list of lease Ids

Throws:

NullArgumentException - campusIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getLeasesByCampuses

LeaseList getLeasesByCampuses(IdList campusIds)
                       throws OperationFailedException,
PermissionDeniedException

Gets the list of Leases corresponding to a list of Campuses .

Parameters:

campusIds - list of campus Ids

Returns:

list of leases

Throws:

NullArgumentException - campusIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCampusIdsByLease

IdList getCampusIdsByLease(Id leaseId)
                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Campus Ids mapped to a Lease .

Parameters:

leaseId - Id of a Lease

Returns:

list of campus Ids

Throws:

NotFoundException - leaseId is not found

NullArgumentException - leaseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCampusesByLease

CampusList getCampusesByLease(Id leaseId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of Campus objects mapped to a Lease .

Parameters:

leaseId - Id of a Lease

Returns:

list of campuses

Throws:

NotFoundException - leaseId is not found

NullArgumentException - leaseId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.