public interface ProcessOfficeAssignmentSession extends OsidSession
This session provides methods to re-assign Process
to
Office
mappings. A Process
may appear in
multiple Office
objects and removing the last reference to
a Process
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 Process
to another
Office
is not a copy operation (eg: does not change its Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignProcessToOffice(Id processId,
Id officeId)
Adds an existing
Process to a Office. |
boolean |
canAssignProcesses()
Tests if this user can alter process/office mappings.
|
boolean |
canAssignProcessesToOffice(Id officeId)
Tests if this user can alter process/office mappings.
|
IdList |
getAssignableOfficeIds(Id officeId)
Gets a list of offices including and under the given office node in
which any process can be assigned.
|
IdList |
getAssignableOfficeIdsForProcess(Id officeId,
Id processId)
Gets a list of offices including and under the given office node in
which a specific process can be assigned.
|
void |
unassignProcessFromOffice(Id processId,
Id officeId)
Removes a
Process from a Office. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignProcesses()
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 canAssignProcessesToOffice(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 getAssignableOfficeIdsForProcess(Id officeId, Id processId) throws OperationFailedException
officeId
- the Id
of the Office
processId
- the Id
of the Process
Ids
NullArgumentException
- officeId
or
processId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignProcessToOffice(Id processId, Id officeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Process
to a Office.
processId
- the Id
of the Process
officeId
- the Id
of the Office
AlreadyExistsException
- processId
is
already assigned to officeId
NotFoundException
- processId
or
officeId
not foundNullArgumentException
- processId
or
officeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignProcessFromOffice(Id processId, Id officeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Process
from a Office.
processId
- the Id
of the Process
officeId
- the Id
of the Office
NotFoundException
- processId
or
officeId
not found or processId
is not
assigned to officeId
NullArgumentException
- processId
or
officeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.