org.osid.offering

Interface ParticipantCatalogueAssignmentSession

All Superinterfaces:

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

public interface ParticipantCatalogueAssignmentSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	assignParticipantToCatalogue(Id participantId, Id catalogueId) Adds an existing Participant to a Catalogue.
boolean	canAssignParticipants() Tests if this user can alter participant/catalogue mappings.
boolean	canAssignParticipantsToCatalogue(Id catalogueId) Tests if this user can alter participant/catalogue mappings.
IdList	getAssignableCatalogueIds(Id catalogueId) Gets a list of catalogues including and under the given catalogue node in which any participant can be assigned.
IdList	getAssignableCatalogueIdsForParticipant(Id catalogueId, Id participantId) Gets a list of catalogues including and under the given catalogue node in which a specific participant can be assigned.
void	unassignParticipantFromCatalogue(Id participantId, Id catalogueId) Removes a Participant 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

canAssignParticipants

boolean canAssignParticipants()

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

canAssignParticipantsToCatalogue

boolean canAssignParticipantsToCatalogue(Id catalogueId)

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

getAssignableCatalogueIdsForParticipant

IdList getAssignableCatalogueIdsForParticipant(Id catalogueId,
                                             Id participantId)
                                               throws OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

participantId - the Id of the Participant

Returns:

list of assignable catalogue Ids

Throws:

NullArgumentException - catalogueId or participantId is null

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

assignParticipantToCatalogue

void assignParticipantToCatalogue(Id participantId,
                                Id catalogueId)
                                  throws AlreadyExistsException,
                                         NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Adds an existing Participant to a Catalogue.

Parameters:

participantId - the Id of the Participant

catalogueId - the Id of the Catalogue

Throws:

AlreadyExistsException - participantId already assigned to catalogueId

NotFoundException - participantId or catalogueId not found

NullArgumentException - participantId or catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignParticipantFromCatalogue

void unassignParticipantFromCatalogue(Id participantId,
                                    Id catalogueId)
                                      throws NotFoundException,
                                             OperationFailedException,
                                             PermissionDeniedException

Removes a Participant from a Catalogue.

Parameters:

participantId - the Id of the Participant

catalogueId - the Id of the Catalogue

Throws:

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

NullArgumentException - participantId or catalogueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.