public interface IssueFrontOfficeAssignmentSession extends OsidSession
This session provides methods to re-assign Issues
to
FrontOffice
objects. An Issue
may appear in
multiple FrontOffice
objects and removing the last
reference to an Issue
is the equivalent of deleting it.
Each FrontOffice
may have its own authorizations governing
who is allowed to operate on it.
Adding a reference of an Issue
to another
FrontOffice
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignIssueToFrontOffice(Id issueId,
Id frontOfficeId)
Adds an existing
Issue to a FrontOffice. |
boolean |
canAssignIssues()
Tests if this user can alter issue/front office mappings.
|
boolean |
canAssignIssuesToFrontOffice(Id frontOfficeId)
Tests if this user can alter issue/front office mappings.
|
IdList |
getAssignableFrontOfficeIds(Id frontOfficeId)
Gets a list of front offices including and under the given front
office node in which any issue can be assigned.
|
IdList |
getAssignableFrontOfficeIdsForIssue(Id frontOfficeId,
Id issueId)
Gets a list of front offices including and under the given front
office node in which a specific issue can be assigned.
|
void |
unassignIssueFromFrontOffice(Id issueId,
Id frontOfficeId)
Removes an
Issue from a FrontOffice. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignIssues()
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 canAssignIssuesToFrontOffice(Id frontOfficeId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.frontOfficeId
- the Id
of the FrontOffice
false
if mapping is not authorized, true
otherwiseNullArgumentException
- frontOfficeId
is
null
mandatory
- This method must be implemented. IdList getAssignableFrontOfficeIds(Id frontOfficeId) throws OperationFailedException
frontOfficeId
- the Id
of the FrontOffice
Ids
NullArgumentException
- frontOfficeId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableFrontOfficeIdsForIssue(Id frontOfficeId, Id issueId) throws OperationFailedException
frontOfficeId
- the Id
of the FrontOffice
issueId
- the Id
of the Issue
Ids
NullArgumentException
- frontOfficeId
or
issueId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignIssueToFrontOffice(Id issueId, Id frontOfficeId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Issue
to a FrontOffice.
issueId
- the Id
of the Issue
frontOfficeId
- the Id
of the FrontOffice
AlreadyExistsException
- issueId
is
already assigned to frontOfficeId
NotFoundException
- issueId
or
frontOfficeId
not foundNullArgumentException
- issueId
or
frontOfficeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignIssueFromFrontOffice(Id issueId, Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Issue
from a FrontOffice.
issueId
- the Id
of the Issue
frontOfficeId
- the Id
of the FrontOffice
NotFoundException
- issueId
or
frontOfficeId
not found or issueId
not
assigned to frontOfficeId
NullArgumentException
- issueId
or
frontOfficeId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.