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