org.osid.offering

Interface OfferingCatalogueAssignmentSession

All Superinterfaces:

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

public interface OfferingCatalogueAssignmentSession
extends OsidSession

This session provides methods to re-assign Offerings to Bilings. An Offering may map to multiple Catalogues and removing the last reference to an Offering 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 Offering to another Catalogue is not a copy operation (eg: does not change its Id ).

Method Summary

Methods

Modifier and Type	Method and Description
void	assignOfferingToCatalogue(Id offeringId, Id catalogueId) Adds an existing Offering to a Catalogue.
boolean	canAssignOfferings() Tests if this user can alter offering/catalogue mappings.
boolean	canAssignOfferingsToCatalogue(Id catalogueId) Tests if this user can alter offering/catalogue mappings.
IdList	getAssignableCatalogueIds(Id catalogueId) Gets a list of catalogues including and under the given catalogue node in which any offering can be assigned.
IdList	getAssignableCatalogueIdsForOffering(Id catalogueId, Id offeringId) Gets a list of catalogues including and under the given catalogue node in which a specific offering can be assigned.
void	unassignOfferingFromCatalogue(Id offeringId, Id catalogueId) Removes an Offering 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

canAssignOfferings

boolean canAssignOfferings()

Tests if this user can alter offering/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.

canAssignOfferingsToCatalogue

boolean canAssignOfferingsToCatalogue(Id catalogueId)

Tests if this user can alter offering/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 offering 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.

getAssignableCatalogueIdsForOffering

IdList getAssignableCatalogueIdsForOffering(Id catalogueId,
                                          Id offeringId)
                                            throws OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

offeringId - the Id of the Offering

Returns:

list of assignable catalogue Ids

Throws:

NullArgumentException - catalogueId or offeringId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignOfferingToCatalogue

void assignOfferingToCatalogue(Id offeringId,
                             Id catalogueId)
                               throws AlreadyExistsException,
                                      NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Adds an existing Offering to a Catalogue.

Parameters:

offeringId - the Id of the Offering

catalogueId - the Id of the Catalogue

Throws:

AlreadyExistsException - offeringId already assigned to catalogueId

NotFoundException - offeringId or catalogueId not found

NullArgumentException - offeringId or catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignOfferingFromCatalogue

void unassignOfferingFromCatalogue(Id offeringId,
                                 Id catalogueId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Removes an Offering from a Catalogue.

Parameters:

offeringId - the Id of the Offering

catalogueId - the Id of the Catalogue

Throws:

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

NullArgumentException - offeringId or catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.