public interface StepProcessorOfficeAssignmentSession extends OsidSession
This session provides methods to re-assign StepProcessor
to Office
mappings. a StepProcessor
may
appear in multiple Office
objects and removing the last
reference to a StepProcessor
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 StepProcessor
to another
Office
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignStepProcessorToOffice(Id stepProcessorId,
Id officeId)
Adds an existing
StepProcessor to an Office. |
boolean |
canAssignStepProcessors()
Tests if this user can alter step processor/office mappings.
|
boolean |
canAssignStepProcessorsToOffice(Id officeId)
Tests if this user can alter step processor/office mappings.
|
IdList |
getAssignableOfficeIds(Id officeId)
Gets a list of office including and under the given office node in
which any step processor can be assigned.
|
IdList |
getAssignableOfficeIdsForStepProcessor(Id officeId,
Id stepProcessorId)
Gets a list of office including and under the given office node in
which a specific step processor can be assigned.
|
void |
unassignStepProcessorFromOffice(Id stepProcessorId,
Id officeId)
Removes a
StepProcessor from an Office. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignStepProcessors()
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup operations to
unauthorized users. false
if mapping is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canAssignStepProcessorsToOffice(Id officeId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer lookup 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 getAssignableOfficeIdsForStepProcessor(Id officeId, Id stepProcessorId) throws OperationFailedException
officeId
- the Id
of the Office
stepProcessorId
- the Id
of the
StepProcessor
Ids
NullArgumentException
- officeId
or
stepProcessorId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignStepProcessorToOffice(Id stepProcessorId, Id officeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessor
to an Office.
stepProcessorId
- the Id
of the
StepProcessor
officeId
- the Id
of the Office
AlreadyExistsException
- stepProcessorId
is already assigned to officeId
NotFoundException
- stepProcessorId
or
officeId
not foundNullArgumentException
- stepProcessorId
or officeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignStepProcessorFromOffice(Id stepProcessorId, Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessor
from an Office.
stepProcessorId
- the Id
of the
StepProcessor
officeId
- the Id
of the Office
NotFoundException
- stepProcessorId
or
officeId
not found or stepProcessorId
not assigned to officeId
NullArgumentException
- stepProcessorId
or officeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.