Interface | osid.offering.OfferingManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.offering.OfferingProfile | |||
Description |
The offering manager provides access to offering sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
The offering manager also provides a profile for determing the supported search types supported by this service. | ||
Method | getCanonicalUnitLookupSession | ||
Description |
Gets the | ||
Return | osid.offering.CanonicalUnitLookupSession | a CanonicalUnitLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCanonicalUnitLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCanonicalUnitLookup()
is true. | |
Method | getCanonicalUnitLookupSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.CanonicalUnitLookupSession | a CanonicalUnitLookupSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCanonicalUnitLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCanonicalUnitLookup()
and supportsVisibleFederation() are true | |
Method | getCanonicalUnitQuerySession | ||
Description |
Gets the | ||
Return | osid.offering.CanonicalUnitQuerySession | a CanonicalUnitQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCanonicalUnitQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCanonicalUnitQuery()
is true. | |
Method | getCanonicalUnitQuerySessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.CanonicalUnitQuerySession | a CanonicalUnitQuerySession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCanonicalUnitQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCanonicalUnitQuery()
and supportsVisibleFederation() are true | |
Method | getCanonicalUnitSearchSession | ||
Description |
Gets the | ||
Return | osid.offering.CanonicalUnitSearchSession | a CanonicalUnitSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCanonicalUnitSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCanonicalUnitSearch()
is true. | |
Method | getCanonicalUnitSearchSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.CanonicalUnitSearchSession | a CanonicalUnitSearchSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCanonicalUnitSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCanonicalUnitSearch()
and supportsVisibleFederation() are true | |
Method | getCanonicalUnitAdminSession | ||
Description |
Gets the | ||
Return | osid.offering.CanonicalUnitAdminSession | a CanonicalUnitAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCanonicalUnitAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCanonicalUnitAdmin()
is true. | |
Method | getCanonicalUnitAdminSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.CanonicalUnitAdminSession | a CanonicalUnitAdminSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCanonicalUnitAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsCanonicalUnitAdmin()
and supportsVisibleFederation() are true | |
Method | getCanonicalUnitNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.offering.CanonicalUnitReceiver | canonicalUnitReceiver | the receiver |
Return | osid.offering.CanonicalUnitNotificationSession | a CanonicalUnitNotificationSession | |
Errors | NULL_ARGUMENT | canonicalUnitReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCanonicalUnitNotification() is false | ||
Compliance | optional | This method must be implemented if
supportsCanonicalUnitNotification() is true. | |
Method | getCanonicalUnitNotificationSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.offering.CanonicalUnitReceiver | canonicalUnitReceiver | the receiver |
osid.id.Id | catalogueId | the Id of the Catalogue | |
Return | osid.offering.CanonicalUnitNotificationSession | a CanonicalUnitNotificationSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | canonicalUnitReceiver or catalogueId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCanonicalUnitNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if
supportsCanonicalUnitNotification() and
supportsVisibleFederation() are true | |
Method | getCanonicalUnitCatalogueSession | ||
Description |
Gets the session for retrieving canonical unit to catalogue mappings. | ||
Return | osid.offering.CanonicalUnitCatalogueSession | a CanonicalUnitCatalogueSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCanonicalUnitCatalogue() is false | ||
Compliance | optional | This method must be implemented if supportsCanonicalUnitCatalogue()
is true. | |
Method | getCanonicalUnitCatalogueAssignmentSession | ||
Description |
Gets the session for assigning canonical unit to catalogue mappings. | ||
Return | osid.offering.CanonicalUnitCatalogueAssignmentSession | a CanonicalUnitCatalogueAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCanonicalUnitCatalogueAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsCanonicalUnitCatalogueAssignment() is true. | |
Method | getCanonicalUnitSmartCatalogueSession | ||
Description |
Gets the session associated with the canonical unit smart catalogue for the given catalogue. | ||
Parameters | osid.id.Id | catalogueId | the Id of the catalogue |
Return | osid.offering.CanonicalUnitSmartCatalogueSession | a CanonicalUnitSmartCatalogueSession | |
Errors | NOT_FOUND | catalogueId not found | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCanonicalUnitSmartCatalogue() is false
| ||
Compliance | optional | This method must be implemented if
supportsCanonicalUnitSmartCatalogue() is true. | |
Method | getOfferingLookupSession | ||
Description |
Gets the | ||
Return | osid.offering.OfferingLookupSession | an OfferingLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfferingLookup() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingLookup()
is true. | |
Method | getOfferingLookupSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.OfferingLookupSession | an OfferingLookupSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOfferingLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingLookup()
and supportsVisibleFederation() are true | |
Method | getOfferingQuerySession | ||
Description |
Gets the | ||
Return | osid.offering.OfferingQuerySession | an OfferingQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfferingQuery() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingQuery()
is true. | |
Method | getOfferingQuerySessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.OfferingQuerySession | an OfferingQuerySession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOfferingQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingQuery()
and supportsVisibleFederation() are true | |
Method | getOfferingSearchSession | ||
Description |
Gets the | ||
Return | osid.offering.OfferingSearchSession | an OfferingSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfferingSearch() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingSearch()
is true. | |
Method | getOfferingSearchSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.OfferingSearchSession | an OfferingSearchSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOfferingSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingSearch()
and supportsVisibleFederation() are true | |
Method | getOfferingAdminSession | ||
Description |
Gets the | ||
Return | osid.offering.OfferingAdminSession | an OfferingAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfferingAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingAdmin()
is true. | |
Method | getOfferingAdminSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.OfferingAdminSession | an OfferingAdminSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOfferingAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingAdmin()
and supportsVisibleFederation() are true | |
Method | getOfferingNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.offering.OfferingReceiver | offeringReceiver | the receiver |
Return | osid.offering.OfferingNotificationSession | an OfferingNotificationSession | |
Errors | NULL_ARGUMENT | offeringReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOfferingNotification() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingNotification()
is true. | |
Method | getOfferingNotificationSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.offering.OfferingReceiver | offeringReceiver | the receiver |
osid.id.Id | catalogueId | the Id of the Catalogue | |
Return | osid.offering.OfferingNotificationSession | an OfferingNotificationSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | offeringReceiver or catalogueId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOfferingNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingNotification()
and supportsVisibleFederation() are true | |
Method | getOfferingCatalogueSession | ||
Description |
Gets the session for retrieving offering to catalogue mappings. | ||
Return | osid.offering.OfferingCatalogueSession | an OfferingCatalogueSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfferingCatalogue() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingCatalogue()
is true. | |
Method | getOfferingCatalogueAssignmentSession | ||
Description |
Gets the session for assigning offering to catalogue mappings. | ||
Return | osid.offering.OfferingCatalogueAssignmentSession | an OfferingCatalogueAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfferingCatalogueAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsOfferingCatalogueAssignment() is true. | |
Method | getOfferingSmartCatalogueSession | ||
Description |
Gets the session associated with the offering smart catalogue for the given catalogue. | ||
Parameters | osid.id.Id | catalogueId | the Id of the catalogue |
Return | osid.offering.OfferingSmartCatalogueSession | an OfferingSmartCatalogueSession | |
Errors | NOT_FOUND | catalogueId not found | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsOfferingSmartCatalogue() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingSmartCatalogue()
is true. | |
Method | getParticipantLookupSession | ||
Description |
Gets the | ||
Return | osid.offering.ParticipantLookupSession | a ParticipantLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsParticipantLookup() is false | ||
Compliance | optional | This method must be implemented if supportsParticipantLookup()
is true. | |
Method | getParticipantLookupSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.ParticipantLookupSession | a ParticipantLookupSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsParticipantLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsParticipantLookup()
and supportsVisibleFederation() are true | |
Method | getParticipantQuerySession | ||
Description |
Gets the | ||
Return | osid.offering.ParticipantQuerySession | a ParticipantQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsParticipantQuery() is false | ||
Compliance | optional | This method must be implemented if supportsParticipantQuery()
is true. | |
Method | getParticipantQuerySessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.ParticipantQuerySession | a ParticipantQuerySession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsParticipantQuery() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsParticipantQuery()
and supportsVisibleFederation() are true | |
Method | getParticipantSearchSession | ||
Description |
Gets the | ||
Return | osid.offering.ParticipantSearchSession | a ParticipantSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsParticipantSearch() is false | ||
Compliance | optional | This method must be implemented if supportsParticipantSearch()
is true. | |
Method | getParticipantSearchSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.ParticipantSearchSession | a ParticipantSearchSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsParticipantSearch() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsParticipantSearch()
and supportsVisibleFederation() are true | |
Method | getParticipantAdminSession | ||
Description |
Gets the | ||
Return | osid.offering.ParticipantAdminSession | a ParticipantAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsParticipantAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsParticipantAdmin()
is true. | |
Method | getParticipantAdminSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.ParticipantAdminSession | a ParticipantAdminSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsParticipantAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsParticipantAdmin()
and supportsVisibleFederation() are true | |
Method | getParticipantNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.offering.ParticipantReceiver | participantReceiver | the receiver |
Return | osid.offering.ParticipantNotificationSession | a ParticipantNotificationSession | |
Errors | NULL_ARGUMENT | participantReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsParticipantNotification() is false | ||
Compliance | optional | This method must be implemented if supportsParticipantNotification()
is true. | |
Method | getParticipantNotificationSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.offering.ParticipantReceiver | participantReceiver | the receiver |
osid.id.Id | catalogueId | the Id of the Catalogue | |
Return | osid.offering.ParticipantNotificationSession | a ParticipantNotificationSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | participantReceiver or catalogueId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsParticipantNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsParticipantNotification()
and supportsVisibleFederation() are true | |
Method | getParticipantCatalogueSession | ||
Description |
Gets the session for retrieving participant to catalogue mappings. | ||
Return | osid.offering.ParticipantCatalogueSession | a ParticipantCatalogueSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsParticipantCatalogue() is false | ||
Compliance | optional | This method must be implemented if supportsParticipantCatalogue()
is true. | |
Method | getParticipantCatalogueAssignmentSession | ||
Description |
Gets the session for assigning participant to catalogue mappings. | ||
Return | osid.offering.ParticipantCatalogueAssignmentSession | a ParticipantCatalogueAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsParticipantCatalogueAssignment() is false
| ||
Compliance | optional | This method must be implemented if
supportsParticipantCatalogueAssignment() is true. | |
Method | getParticipantSmartCatalogueSession | ||
Description |
Gets the session associated with the participant smart catalogue for the given catalogue. | ||
Parameters | osid.id.Id | catalogueId | the Id of the catalogue |
Return | osid.offering.ParticipantSmartCatalogueSession | a ParticipantSmartCatalogueSession | |
Errors | NOT_FOUND | catalogueId not found | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsParticipantSmartCatalogue() is false | ||
Compliance | optional | This method must be implemented if
supportsParticipantSmartCatalogue() is true. | |
Method | getResultLookupSession | ||
Description |
Gets the | ||
Return | osid.offering.ResultLookupSession | an ResultLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResultLookup() is false | ||
Compliance | optional | This method must be implemented if supportsResultLookup() is
true. | |
Method | getResultLookupSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.ResultLookupSession | an ResultLookupSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResultLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsResultLookup()
and supportsVisibleFederation() are true | |
Method | getResultQuerySession | ||
Description |
Gets the | ||
Return | osid.offering.ResultQuerySession | an ResultQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResultQuery() is false | ||
Compliance | optional | This method must be implemented if supportsResultQuery() is
true. | |
Method | getResultQuerySessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.ResultQuerySession | an ResultQuerySession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResultQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsResultQuery() and
supportsVisibleFederation() are true | |
Method | getResultSearchSession | ||
Description |
Gets the | ||
Return | osid.offering.ResultSearchSession | an ResultSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResultSearch() is false | ||
Compliance | optional | This method must be implemented if supportsResultSearch() is
true. | |
Method | getResultSearchSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.ResultSearchSession | an ResultSearchSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResultSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsResultSearch()
and supportsVisibleFederation() are true | |
Method | getResultAdminSession | ||
Description |
Gets the | ||
Return | osid.offering.ResultAdminSession | an ResultAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResultAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsResultAdmin() is
true. | |
Method | getResultAdminSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | catalogueId | the Id of the Catalogue |
Return | osid.offering.ResultAdminSession | an ResultAdminSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResultAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsResultAdmin() and
supportsVisibleFederation() are true | |
Method | getResultNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.offering.ResultReceiver | resultReceiver | the receiver |
Return | osid.offering.ResultNotificationSession | an ResultNotificationSession | |
Errors | NULL_ARGUMENT | resultReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResultNotification() is false | ||
Compliance | optional | This method must be implemented if supportsResultNotification()
is true. | |
Method | getResultNotificationSessionForCatalogue | ||
Description |
Gets the | ||
Parameters | osid.offering.ResultReceiver | resultReceiver | the receiver |
osid.id.Id | catalogueId | the Id of the Catalogue | |
Return | osid.offering.ResultNotificationSession | an ResultNotificationSession | |
Errors | NOT_FOUND | no Catalogue found by the given Id | |
NULL_ARGUMENT | resultReceiver or catalogueId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResultNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsResultNotification()
and supportsVisibleFederation() are true | |
Method | getResultCatalogueSession | ||
Description |
Gets the session for retrieving result to catalogue mappings. | ||
Return | osid.offering.ResultCatalogueSession | an ResultCatalogueSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResultCatalogue() is false | ||
Compliance | optional | This method must be implemented if supportsResultCatalogue()
is true. | |
Method | getResultCatalogueAssignmentSession | ||
Description |
Gets the session for assigning result to catalogue mappings. | ||
Return | osid.offering.ResultCatalogueAssignmentSession | an ResultCatalogueAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsResultCatalogueAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsResultCatalogueAssignment() is true. | |
Method | getResultSmartCatalogueSession | ||
Description |
Gets the session associated with the result smart catalogue for the given catalogue. | ||
Parameters | osid.id.Id | catalogueId | the Id of the catalogue |
Return | osid.offering.ResultSmartCatalogueSession | an ResultSmartCatalogueSession | |
Errors | NOT_FOUND | catalogueId not found | |
NULL_ARGUMENT | catalogueId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsResultSmartCatalogue() is false | ||
Compliance | optional | This method must be implemented if
supportsAppointmenSmarttCatalogue() is true. | |
Method | getCatalogueLookupSession | ||
Description |
Gets the | ||
Return | osid.offering.CatalogueLookupSession | a CatalogueLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCatalogueLookup() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogueLookup()
is true. | |
Method | getCatalogueQuerySession | ||
Description |
Gets the | ||
Return | osid.offering.CatalogueQuerySession | a CatalogueQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCatalogueQuery() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogueQuery()
is true. | |
Method | getCatalogueSearchSession | ||
Description |
Gets the | ||
Return | osid.offering.CatalogueSearchSession | a CatalogueSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCatalogueSearch() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogueSearch()
is true. | |
Method | getCatalogueAdminSession | ||
Description |
Gets the | ||
Return | osid.offering.CatalogueAdminSession | a CatalogueAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCatalogueAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogueAdmin()
is true. | |
Method | getCatalogueNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.offering.CatalogueReceiver | catalogueReceiver | the receiver |
Return | osid.offering.CatalogueNotificationSession | a CatalogueNotificationSession | |
Errors | NULL_ARGUMENT | catalogueReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsCatalogueNotification() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogueNotification()
is true. | |
Method | getCatalogueHierarchySession | ||
Description |
Gets the | ||
Return | osid.offering.CatalogueHierarchySession | a CatalogueHierarchySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCatalogueHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsCatalogueHierarchy()
is true. | |
Method | getCatalogueHierarchyDesignSession | ||
Description |
Gets the | ||
Return | osid.offering.CatalogueHierarchyDesignSession | a CatalogueHierarchyDesignSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsCatalogueHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if
supportsCatalogueHierarchyDesign() is true. | |
Method | getOfferingBatchManager | ||
Description |
Gets a | ||
Return | osid.offering.batch.OfferingBatchManager | a OfferingBatchManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfferingBatch() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingBatch()
is true. | |
Method | getOfferingRulesManager | ||
Description |
Gets a | ||
Return | osid.offering.rules.OfferingRulesManager | a OfferingRulesManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsOfferingRules() is false | ||
Compliance | optional | This method must be implemented if supportsOfferingRules()
is true. |