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