public interface StepProcessorEnablerOfficeAssignmentSession extends OsidSession
This session provides methods to re-assign StepProcessorEnabler
to Office
mappings. A StepProcessorEnabler
may appear in multiple Office
objects and removing
the last reference to a StepProcessorEnabler
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 StepProcessorEnabler
to another
Office
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignStepProcessorEnablerToOffice(Id stepProcessorEnablerId,
Id officeId)
Adds an existing
StepProcessorEnabler to an
Office. |
boolean |
canAssignStepProcessorEnablers()
Tests if this user can alter step processor enabler/office mappings.
|
boolean |
canAssignStepProcessorEnablersToOffice(Id officeId)
Tests if this user can alter step processor enabler/office mappings.
|
IdList |
getAssignableOfficeIds(Id officeId)
Gets a list of office including and under the given office node in
which any step processor enabler can be assigned.
|
IdList |
getAssignableOfficeIdsForStepProcessorEnabler(Id officeId,
Id stepProcessorEnablerId)
Gets a list of office including and under the given office node in
which a specific step processor enabler can be assigned.
|
void |
reassignStepProcessorEnablerToOffice(Id stepProcessorEnablerId,
Id fromOfficeId,
Id toOfficeId)
Moves a
StepProcessorEnabler from one Office
to another. |
void |
unassignStepProcessorEnablerFromOffice(Id stepProcessorEnablerId,
Id officeId)
Removes a
StepProcessorEnabler from an Office. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignStepProcessorEnablers()
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 canAssignStepProcessorEnablersToOffice(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 getAssignableOfficeIdsForStepProcessorEnabler(Id officeId, Id stepProcessorEnablerId) throws OperationFailedException
officeId
- the Id
of the Office
stepProcessorEnablerId
- the Id
of the
StepProcessorEnabler
Ids
NullArgumentException
- officeId
or
stepProcessorEnablerId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignStepProcessorEnablerToOffice(Id stepProcessorEnablerId, Id officeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessorEnabler
to an
Office.
stepProcessorEnablerId
- the Id
of the
StepProcessorEnabler
officeId
- the Id
of the Office
AlreadyExistsException
- stepProcessorEnablerId
is already assigned to officeId
NotFoundException
- stepProcessorEnablerId
or officeId
not foundNullArgumentException
- stepProcessorEnablerId
or officeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignStepProcessorEnablerFromOffice(Id stepProcessorEnablerId, Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessorEnabler
from an Office.
stepProcessorEnablerId
- the Id
of the
StepProcessorEnabler
officeId
- the Id
of the Office
NotFoundException
- stepProcessorEnablerId
or officeId
not found or
stepProcessorEnablerId
not assigned to officeId
NullArgumentException
- stepProcessorEnablerId
or officeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void reassignStepProcessorEnablerToOffice(Id stepProcessorEnablerId, Id fromOfficeId, Id toOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
StepProcessorEnabler
from one Office
to another. Mappings to other Offices
are
unaffected.stepProcessorEnablerId
- the Id
of the
StepProcessorEnabler
fromOfficeId
- the Id
of the current
Office
toOfficeId
- the Id
of the destination
Office
NotFoundException
- stepProcessorEnablerId,
fromOfficeId,
or toOfficeId
not found
or stepProcessorEnablerId
not mapped to
fromOfficeId
NullArgumentException
- stepProcessorEnablerId,
fromOfficeId,
or toOfficeId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.