public interface RoomCampusAssignmentSession extends OsidSession
This session provides methods to re-assign Rooms
to
Campuses.
A Room
may map to multiple
Campuses
and removing the last reference to a Room
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 Room
to another Campus
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignRoomToCampus(Id roomId,
Id campusId)
Adds an existing
Room to a Campus. |
boolean |
canAssignRooms()
Tests if this user can alter room/campus mappings.
|
boolean |
canAssignRoomsToCampus(Id campusId)
Tests if this user can alter room/campus mappings.
|
IdList |
getAssignableCampusIds(Id campusId)
Gets a list of campuses including and under the given campus node in
which any room can be assigned.
|
IdList |
getAssignableCampusIdsForRoom(Id campusId,
Id roomId)
Gets a list of campuses including and under the given campus node in
which a specific room can be assigned.
|
void |
unassignRoomFromCampus(Id roomId,
Id campusId)
Removes a
Room from a Campus. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignRooms()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignRoomsToCampus(Id campusId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.campusId
- the Id
of the Campus
false
if mapping is not authorized, true
otherwiseNullArgumentException
- campusId
is
null
mandatory
- This method must be implemented. IdList getAssignableCampusIds(Id campusId) throws OperationFailedException
campusId
- the Id
of the Campus
Ids
NullArgumentException
- campusId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableCampusIdsForRoom(Id campusId, Id roomId) throws OperationFailedException
campusId
- the Id
of the Campus
roomId
- the Id
of the Room
Ids
NullArgumentException
- campusId
or
roomId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignRoomToCampus(Id roomId, Id campusId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Room
to a Campus.
roomId
- the Id
of the Room
campusId
- the Id
of the Campus
AlreadyExistsException
- roomId
is
already assigned to campusId
NotFoundException
- roomId
or
campusId
not foundNullArgumentException
- roomId
or
campusId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignRoomFromCampus(Id roomId, Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Room
from a Campus.
roomId
- the Id
of the Room
campusId
- the Id
of the Campus
NotFoundException
- roomId
or
campusId
not found or roomId
not
assigned to campusId
NullArgumentException
- roomId
or
campusId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.