org.osid.offering

Interface ResultCatalogueAssignmentSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

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 ).

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

canAssignResults

boolean canAssignResults()

Tests if this user can alter result/catalogue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if mapping is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canAssignResultsToCatalogue

boolean canAssignResultsToCatalogue(Id catalogueId)

Tests if this user can alter result/catalogue mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parameters:

catalogueId - the Id of the Catalogue

Returns:

false if mapping is not authorized, true otherwise

Throws:

NullArgumentException - catalogueId is null

Compliance:

mandatory - This method must be implemented.

getAssignableCatalogueIds

IdList getAssignableCatalogueIds(Id catalogueId)
                                 throws OperationFailedException

Gets a list of catalogues including and under the given catalogue node in which any result can be assigned.

Parameters:

catalogueId - the Id of the Catalogue

Returns:

list of assignable catalogue Ids

Throws:

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getAssignableCatalogueIdsForResult

IdList getAssignableCatalogueIdsForResult(Id catalogueId,
                                        Id resultId)
                                          throws OperationFailedException

Gets a list of catalogues including and under the given catalogue node in which a specific result can be assigned.

Parameters:

catalogueId - the Id of the Catalogue

resultId - the Id of the Result

Returns:

list of assignable catalogue Ids

Throws:

NullArgumentException - catalogueId or resultId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignResultToCatalogue

void assignResultToCatalogue(Id resultId,
                           Id catalogueId)
                             throws AlreadyExistsException,
                                    NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

Adds an existing Result to a Catalogue.

Parameters:

resultId - the Id of the Result

catalogueId - the Id of the Catalogue

Throws:

AlreadyExistsException - resultId already assigned to catalogueId

NotFoundException - resultId or catalogueId not found

NullArgumentException - resultId or catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignResultFromCatalogue

void unassignResultFromCatalogue(Id resultId,
                               Id catalogueId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Removes an Result from a Catalogue.

Parameters:

resultId - the Id of the Result

catalogueId - the Id of the Catalogue

Throws:

NotFoundException - resultId or catalogueId not found or resultId not mapped to catalogueId

NullArgumentException - resultId or catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.