org.osid.room

Interface FloorCampusAssignmentSession

All Superinterfaces:

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

public interface FloorCampusAssignmentSession
extends OsidSession

This session provides methods to re-assign Floors to Campuses. A Floor may map to multiple Campuses and removing the last reference to a Floor is the equivalent of deleting it. Each Campus may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Floor to another Campus is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignFloorToCampus(Id floorId, Id campusId) Adds an existing Floor to a Campus.
boolean	canAssignFloors() Tests if this user can alter floor/campus mappings.
boolean	canAssignFloorsToCampus(Id campusId) Tests if this user can alter floor/campus mappings.
IdList	getAssignableCampusIds(Id campusId) Gets a list of campuses including and under the given campus node in which any floor can be assigned.
IdList	getAssignableCampusIdsForFloor(Id campusId, Id floorId) Gets a list of campuses including and under the given campus node in which a specific floor can be assigned.
void	unassignFloorFromCampus(Id floorId, Id campusId) Removes a Floor from a Campus.

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

canAssignFloors

boolean canAssignFloors()

Tests if this user can alter floor/campus mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignFloorsToCampus

boolean canAssignFloorsToCampus(Id campusId)

Tests if this user can alter floor/campus mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Parameters:

campusId - the Id of the Campus

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - campusId is null

Compliance:

mandatory - This method must be implemented.

getAssignableCampusIds

IdList getAssignableCampusIds(Id campusId)
                              throws OperationFailedException

Gets a list of campuses including and under the given campus node in which any floor can be assigned.

Parameters:

campusId - the Id of the Campus

Returns:

list of assignable campus Ids

Throws:

NullArgumentException - campusId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableCampusIdsForFloor

IdList getAssignableCampusIdsForFloor(Id campusId,
                                    Id floorId)
                                      throws OperationFailedException

Gets a list of campuses including and under the given campus node in which a specific floor can be assigned.

Parameters:

campusId - the Id of the Campus

floorId - the Id of the Floor

Returns:

list of assignable campus Ids

Throws:

NullArgumentException - campusId or floorId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignFloorToCampus

void assignFloorToCampus(Id floorId,
                       Id campusId)
                         throws AlreadyExistsException,
                                NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

Adds an existing Floor to a Campus.

Parameters:

floorId - the Id of the Floor

campusId - the Id of the Campus

Throws:

AlreadyExistsException - floorId is already assigned to campusId

NotFoundException - floorId or campusId not found

NullArgumentException - floorId or campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignFloorFromCampus

void unassignFloorFromCampus(Id floorId,
                           Id campusId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Removes a Floor from a Campus.

Parameters:

floorId - the Id of the Floor

campusId - the Id of the Campus

Throws:

NotFoundException - floorId or campusId not found or floorId not assigned to campusId

NullArgumentException - floorId or campusId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.