org.osid.offering.rules

Interface CanonicalUnitProcessorEnablerCatalogueAssignmentSession

All Superinterfaces:

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

public interface CanonicalUnitProcessorEnablerCatalogueAssignmentSession
extends OsidSession

This session provides methods to re-assign CanonicalUnitProcessorEnabler to Catalogue mappings. A CanonicalUnitProcessorEnabler may appear in multiple Catalogue objects and removing the last reference to a CanonicalUnitProcessorEnabler 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 a CanonicalUnitProcessorEnabler to another Catalogue is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignCanonicalUnitProcessorEnablerToCatalogue(Id canonicalUnitProcessorEnablerId, Id catalogueId) Adds an existing CanonicalUnitProcessorEnabler to a Catalogue.
boolean	canAssignCanonicalUnitProcessorEnablers() Tests if this user can alter canonical unit processor enabler/catalogue mappings.
boolean	canAssignCanonicalUnitProcessorEnablersToCatalogue(Id catalogueId) Tests if this user can alter canonical unit processor enabler/catalogue mappings.
IdList	getAssignableCatalogueIds(Id catalogueId) Gets a list of catalogues including and under the given catalogue node in which any canonical unit processor enabler can be assigned.
IdList	getAssignableCatalogueIdsForCanonicalUnitProcessorEnabler(Id catalogueId, Id canonicalUnitProcessorEnablerId) Gets a list of catalogues including and under the given catalogue node in which a specific canonical unit processor enabler can be assigned.
void	reassignCanonicalUnitProcessorEnablerToCatalogue(Id canonicalUnitProcessorEnablerId, Id fromCatalogueId, Id toCatalogueId) Moves a CanonicalUnitProcessorEnabler from one Catalogue to another.
void	unassignCanonicalUnitProcessorEnablerFromCatalogue(Id canonicalUnitProcessorEnablerId, Id catalogueId) Removes a CanonicalUnitProcessorEnabler 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

canAssignCanonicalUnitProcessorEnablers

boolean canAssignCanonicalUnitProcessorEnablers()

Tests if this user can alter canonical unit processor enabler/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.

canAssignCanonicalUnitProcessorEnablersToCatalogue

boolean canAssignCanonicalUnitProcessorEnablersToCatalogue(Id catalogueId)

Tests if this user can alter canonical unit processor enabler/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.

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 canonical unit processor enabler 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.

getAssignableCatalogueIdsForCanonicalUnitProcessorEnabler

IdList getAssignableCatalogueIdsForCanonicalUnitProcessorEnabler(Id catalogueId,
                                                               Id canonicalUnitProcessorEnablerId)
                                                                 throws OperationFailedException

Gets a list of catalogues including and under the given catalogue node in which a specific canonical unit processor enabler can be assigned.

Parameters:

catalogueId - the Id of the Catalogue

canonicalUnitProcessorEnablerId - the Id of the CanonicalUnitProcessorEnabler

Returns:

list of assignable catalogue Ids

Throws:

NullArgumentException - catalogueId or canonicalUnitProcessorEnablerId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignCanonicalUnitProcessorEnablerToCatalogue

void assignCanonicalUnitProcessorEnablerToCatalogue(Id canonicalUnitProcessorEnablerId,
                                                  Id catalogueId)
                                                    throws AlreadyExistsException,
                                                           NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Adds an existing CanonicalUnitProcessorEnabler to a Catalogue.

Parameters:

canonicalUnitProcessorEnablerId - the Id of the CanonicalUnitProcessorEnabler

catalogueId - the Id of the Catalogue

Throws:

AlreadyExistsException - canonicalUnitProcessorEnablerId already assigned to catalogueId

NotFoundException - canonicalUnitProcessorEnablerId or catalogueId not found

NullArgumentException - canonicalUnitProcessorEnablerId or catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignCanonicalUnitProcessorEnablerFromCatalogue

void unassignCanonicalUnitProcessorEnablerFromCatalogue(Id canonicalUnitProcessorEnablerId,
                                                      Id catalogueId)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Removes a CanonicalUnitProcessorEnabler from a Catalogue.

Parameters:

canonicalUnitProcessorEnablerId - the Id of the CanonicalUnitProcessorEnabler

catalogueId - the Id of the Catalogue

Throws:

NotFoundException - canonicalUnitProcessorEnablerId or catalogueId not found or canonicalUnitProcessorEnablerId not assigned to catalogueId

NullArgumentException - canonicalUnitProcessorEnablerId or catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

reassignCanonicalUnitProcessorEnablerToCatalogue

void reassignCanonicalUnitProcessorEnablerToCatalogue(Id canonicalUnitProcessorEnablerId,
                                                    Id fromCatalogueId,
                                                    Id toCatalogueId)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

Moves a CanonicalUnitProcessorEnabler from one Catalogue to another. Mappings to other Catalogues are unaffected.

Parameters:

canonicalUnitProcessorEnablerId - the Id of the CanonicalUnitProcessorEnabler

fromCatalogueId - the Id of the current Catalogue

toCatalogueId - the Id of the destination Catalogue

Throws:

NotFoundException - canonicalUnitProcessorEnablerId, fromCatalogueId, or toCatalogueId not found or canonicalUnitProcessorEnablerId, not mapped to fromCatalogueId

NullArgumentException - canonicalUnitProcessorEnablerId, fromCatalogueId, or toCatalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.