public interface DeedCampusAssignmentSession extends OsidSession
This session provides methods to re-assign Deeds
to
Campuses.
A Deed
may map to multiple
Campuses
and removing the last reference to a Deed
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 Deed
to another Campus
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignDeedToCampus(Id deedId,
Id campusId)
Adds an existing
Deed to a Campus. |
boolean |
canAssignDeeds()
Tests if this user can alter deed/campus mappings.
|
boolean |
canAssignDeedsToCampus(Id campusId)
Tests if this user can alter deed/campus mappings.
|
IdList |
getAssignableCampusIds(Id campusId)
Gets a list of campuses including and under the given campus node in
which any deed can be assigned.
|
IdList |
getAssignableCampusIdsForDeed(Id campusId,
Id deedId)
Gets a list of campuses including and under the given campus node in
which a specific deed can be assigned.
|
void |
unassignDeedFromCampus(Id deedId,
Id campusId)
Removes a
Deed from a Campus. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignDeeds()
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 canAssignDeedsToCampus(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 getAssignableCampusIdsForDeed(Id campusId, Id deedId) throws OperationFailedException
campusId
- the Id
of the Campus
deedId
- the Id
of the Deed
Ids
NullArgumentException
- campusId
or
deedId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignDeedToCampus(Id deedId, Id campusId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Deed
to a Campus.
deedId
- the Id
of the Deed
campusId
- the Id
of the Campus
AlreadyExistsException
- deedId
is
already assigned to campusId
NotFoundException
- deedId
or
campusId
not foundNullArgumentException
- deedId
or
campusId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignDeedFromCampus(Id deedId, Id campusId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Deed
from a Campus.
deedId
- the Id
of the Deed
campusId
- the Id
of the Campus
NotFoundException
- deedId
or
campusId
not found or deedId
not
assigned to campusId
NullArgumentException
- deedId
or
campusId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.