public interface StepOfficeAssignmentSession extends OsidSession
This session provides methods to re-assign Step
to
Office
mappings. A Step
may appear in
multiple Office
objects and removing the last reference to
a Step
is the equivalent of deleting it. Each Office
may have its own authorizations governing who is allowed to
operate on it.
Adding a reference of a Step
to another Office
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignStepToOffice(Id stepId,
Id officeId)
Adds an existing
Step to a Office. |
boolean |
canAssignStepes()
Tests if this user can alter step/office mappings.
|
boolean |
canAssignStepesToOffice(Id officeId)
Tests if this user can alter step/office mappings.
|
IdList |
getAssignableOfficeIds(Id officeId)
Gets a list of offices including and under the given office node in
which any step can be assigned.
|
IdList |
getAssignableOfficeIdsForStep(Id officeId,
Id stepId)
Gets a list of offices including and under the given office node in
which a specific step can be assigned.
|
void |
unassignStepFromOffice(Id stepId,
Id officeId)
Removes a
Step from a Office. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignStepes()
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 canAssignStepesToOffice(Id officeId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.officeId
- the Id
of the Office
false
if mapping is not authorized, true
otherwiseNullArgumentException
- officeId
is
null
mandatory
- This method must be implemented. IdList getAssignableOfficeIds(Id officeId) throws OperationFailedException
officeId
- the Id
of the Office
Ids
NullArgumentException
- officeId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableOfficeIdsForStep(Id officeId, Id stepId) throws OperationFailedException
officeId
- the Id
of the Office
stepId
- the Id
of the Step
Ids
NullArgumentException
- officeId
or
stepId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignStepToOffice(Id stepId, Id officeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Step
to a Office.
stepId
- the Id
of the Step
officeId
- the Id
of the Office
AlreadyExistsException
- stepId
is
already assigned to officeId
NotFoundException
- stepId
or
officeId
not foundNullArgumentException
- stepId
or
officeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignStepFromOffice(Id stepId, Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Step
from a Office.
stepId
- the Id
of the Step
officeId
- the Id
of the Office
NotFoundException
- stepId
or
officeId
not found or stepId
is not
assigned to officeId
NullArgumentException
- stepId
or
officeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.