| Interface | osid.offering.ParticipantCatalogueAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Description | This session provides methods to re-assign   Adding a reference of a  | ||
| Method | canAssignParticipants | ||
| Description | 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 
                     | ||
| Return | boolean |  false if mapping is not authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignParticipantsToCatalogue | ||
| Description | 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 
                     | ||
| Parameters | osid.id.Id | catalogueId | the  Id of the Catalogue  | 
| Return | boolean |  false if mapping is not authorized, true otherwise | |
| Errors | NULL_ARGUMENT |  catalogueId is null  | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCatalogueIds | ||
| Description | Gets a list of catalogues including and under the given catalogue node in which any participant can be assigned. | ||
| Parameters | osid.id.Id | catalogueId | the  Id of the Catalogue  | 
| Return | osid.id.IdList | list of assignable catalogue  Ids  | |
| Errors | NULL_ARGUMENT |  catalogueId is null  | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getAssignableCatalogueIdsForParticipant | ||
| Description | Gets a list of catalogues including and under the given catalogue node in which a specific participant can be assigned. | ||
| Parameters | osid.id.Id | catalogueId | the  Id of the Catalogue  | 
| osid.id.Id | participantId | the  Id of the Participant  | |
| Return | osid.id.IdList | list of assignable catalogue  Ids  | |
| Errors | NULL_ARGUMENT |  catalogueId or participantId is null 
 | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignParticipantToCatalogue | ||
| Description | Adds an existing  | ||
| Parameters | osid.id.Id | participantId | the  Id of the Participant  | 
| osid.id.Id | catalogueId | the  Id of the Catalogue  | |
| Errors | ALREADY_EXISTS |  participantId already assigned to catalogueId  | |
| NOT_FOUND |  participantId or catalogueId not found | ||
| NULL_ARGUMENT |  participantId or catalogueId is null 
 | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignParticipantFromCatalogue | ||
| Description | Removes a  | ||
| Parameters | osid.id.Id | participantId | the  Id of the Participant  | 
| osid.id.Id | catalogueId | the  Id of the Catalogue  | |
| Errors | NOT_FOUND |  participantId or catalogueId not found or participantId not mapped to catalogueId  | |
| NULL_ARGUMENT |  participantId or catalogueId is null 
 | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |