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