public interface ResultCatalogueAssignmentSession extends OsidSession
This session provides methods to re-assign Results
to
Bilings.
An Result
may map to multiple
Catalogues
and removing the last reference to an
Result
is the equivalent of deleting it. Each Catalogue
may have its own authorizations governing who is allowed to
operate on it.
Adding a reference of an Result
to another
Catalogue
is not a copy operation (eg: does not change its
Id
).
Modifier and Type | Method and Description |
---|---|
void |
assignResultToCatalogue(Id resultId,
Id catalogueId)
Adds an existing
Result to a Catalogue. |
boolean |
canAssignResults()
Tests if this user can alter result/catalogue mappings.
|
boolean |
canAssignResultsToCatalogue(Id catalogueId)
Tests if this user can alter result/catalogue mappings.
|
IdList |
getAssignableCatalogueIds(Id catalogueId)
Gets a list of catalogues including and under the given catalogue node
in which any result can be assigned.
|
IdList |
getAssignableCatalogueIdsForResult(Id catalogueId,
Id resultId)
Gets a list of catalogues including and under the given catalogue node
in which a specific result can be assigned.
|
void |
unassignResultFromCatalogue(Id resultId,
Id catalogueId)
Removes an
Result from a Catalogue. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
boolean canAssignResults()
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 canAssignResultsToCatalogue(Id catalogueId)
PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer assignment operations to
unauthorized users.catalogueId
- the Id
of the Catalogue
false
if mapping is not authorized, true
otherwiseNullArgumentException
- catalogueId
is
null
mandatory
- This method must be implemented. IdList getAssignableCatalogueIds(Id catalogueId) throws OperationFailedException
catalogueId
- the Id
of the Catalogue
Ids
NullArgumentException
- catalogueId
is
null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. IdList getAssignableCatalogueIdsForResult(Id catalogueId, Id resultId) throws OperationFailedException
catalogueId
- the Id
of the Catalogue
resultId
- the Id
of the Result
Ids
NullArgumentException
- catalogueId
or
resultId
is null
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. void assignResultToCatalogue(Id resultId, Id catalogueId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Result
to a Catalogue.
resultId
- the Id
of the Result
catalogueId
- the Id
of the Catalogue
AlreadyExistsException
- resultId
already assigned to catalogueId
NotFoundException
- resultId
or
catalogueId
not foundNullArgumentException
- resultId
or
catalogueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignResultFromCatalogue(Id resultId, Id catalogueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Result
from a Catalogue.
resultId
- the Id
of the Result
catalogueId
- the Id
of the Catalogue
NotFoundException
- resultId
or
catalogueId
not found or resultId
not
mapped to catalogueId
NullArgumentException
- resultId
or
catalogueId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.