org.osid.room.construction

Interface ProjectCampusSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface ProjectCampusSession
extends OsidSession

This session provides methods to retrieve Project to Campus mappings. A Project 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

Methods

Modifier and Type	Method and Description
boolean	canLookupProjectCampusMappings() Tests if this user can perform lookups of project/campus mappings.
CampusList	getCampusesByProject(Id projectId) Gets the list of Campus objects mapped to a Project.
IdList	getCampusIdsByProject(Id projectId) Gets the list of Campus Ids mapped to a Project.
IdList	getProjectIdsByCampus(Id campusId) Gets the list of Project Ids associated with a Campus.
IdList	getProjectIdsByCampuses(IdList campusIds) Gets the list of Project Ids corresponding to a list of Campus objects.
ProjectList	getProjectsByCampus(Id campusId) Gets the list of Projects associated with a Campus.
ProjectList	getProjectsByCampuses(IdList campusIds) Gets the list of Projects 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 Project and Campus returns is desired.

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canLookupProjectCampusMappings

boolean canLookupProjectCampusMappings()

Tests if this user can perform lookups of project/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 Project 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.

getProjectIdsByCampus

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

Gets the list of Project Ids associated with a Campus.

Parameters:

campusId - Id of a Campus

Returns:

list of related project 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.

getProjectsByCampus

ProjectList getProjectsByCampus(Id campusId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets the list of Projects associated with a Campus.

Parameters:

campusId - Id of a Campus

Returns:

list of related projects

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.

getProjectIdsByCampuses

IdList getProjectIdsByCampuses(IdList campusIds)
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

campusIds - list of campus Ids

Returns:

list of project Ids

Throws:

NullArgumentException - campusIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProjectsByCampuses

ProjectList getProjectsByCampuses(IdList campusIds)
                                  throws OperationFailedException,
                                         PermissionDeniedException

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

Parameters:

campusIds - list of campus Ids

Returns:

list of projects

Throws:

NullArgumentException - campusIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCampusIdsByProject

IdList getCampusIdsByProject(Id projectId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Gets the list of Campus Ids mapped to a Project.

Parameters:

projectId - Id of a Project

Returns:

list of campus Ids

Throws:

NotFoundException - projectId is not found

NullArgumentException - projectId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCampusesByProject

CampusList getCampusesByProject(Id projectId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Gets the list of Campus objects mapped to a Project.

Parameters:

projectId - Id of a Project

Returns:

list of campuses

Throws:

NotFoundException - projectId is not found

NullArgumentException - projectId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.