OSID Logo
OSID Specifications
offering package
Version 3.1.0
Interfaceosid.offering.OfferingManager
Implementsosid.OsidManager
osid.offering.OfferingProfile
Used Byosid.orchestration.OrchestrationManager
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:

  • CanonicalUnitLookupSession: a session to lookup canonical units
  • CanonicalUnitQuerySession: a session for querying canonical units
  • CanonicalUnitSearchSession: a session to search canonical units
  • CanonicalUnitAdminSession: a session to manage canonical units
  • CanonicalUnitNotificationSession: a session to subscribe to notifications of canonical unit changes
  • CanonicalUnitCatalogueSession: a session to look up canonical unit to catalogue mappings
  • CanonicalUnitCatalogueAssignmentSession: a session to manage canonical unit to catalogue mappings
  • CanonicalUnitSmartCatalogueSession: a session to manage dynamic canonical unit to catalogue mappings
  • OfferingLookupSession: a session to lookup offerings
  • OfferingQuerySession: a session for querying offerings
  • OfferingSearchSession: a session to search offerings
  • OfferingAdminSession: a session to manage offerings
  • OfferingNotificationSession: a session to subscribe to notifications of offering changes
  • OfferingCatalogueSession: a session to look up offering to catalogue mappings
  • OfferingCatalogueAssignmentSession: a session to manage offering to catalogue mappings
  • OfferingSmartCatalogueSession: a session to manage dynamic offering to catalogue mappings
  • ParticipantLookupSession: a session to lookup participants
  • ParticipantQuerySession: a session for querying participants
  • ParticipantSearchSession: a session to search participants
  • ParticipantAdminSession: a session to manage participants
  • ParticipantNotificationSession: a session to subscribe to notifications of participant changes
  • ParticipantCatalogueSession: a session to look up participant to catalogue mappings
  • ParticipantCatalogueAssignmentSession: a session to manage participant to catalogue mappings
  • ParticipantSmartCatalogueSession: a session to manage dynamic participant to catalogue mappings
  • ResultLookupSession: a session to lookup results
  • ResultQuerySession: a session for querying results
  • ResultSearchSession: a session to search results
  • ResultAdminSession: a session to manage results
  • ResultNotificationSession: a session to subscribe to notifications of result changes
  • ResultCatalogueSession: a session to look up result to catalogue mappings
  • ResultCatalogueAssignmentSession: a session to manage result to catalogue mappings
  • ResultSmartCatalogueSession: a session to manage dynamic result to catalogue mappings
  • CatalogueLookupSession: a session to retrieve catalogues
  • CatalogueQuerySession: a session for querying catalogues
  • CatalogueSearchSession: a session to search for catalogues
  • CatalogueAdminSession: a session to create, update and delete catalogues
  • CatalogueNotificationSession: a session to receive notifications for changes in catalogues
  • CatalogueHierarchyTraversalSession: a session to traverse hierarchies of catalogues
  • CatalogueHierarchyDesignSession: a session to manage hierarchies of catalogues

The offering manager also provides a profile for determing the supported search types supported by this service.

MethodgetCanonicalUnitLookupSession
Description

Gets the OsidSession associated with the canonical unit lookup service.

Returnosid.offering.CanonicalUnitLookupSession a CanonicalUnitLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCanonicalUnitLookup() is false
Complianceoptional This method must be implemented if supportsCanonicalUnitLookup() is true.
MethodgetCanonicalUnitLookupSessionForCatalogue
Description

Gets the OsidSession associated with the canonical unit lookup service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.CanonicalUnitLookupSession a CanonicalUnitLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsCanonicalUnitLookup() and supportsVisibleFederation() are true
MethodgetCanonicalUnitQuerySession
Description

Gets the OsidSession associated with the canonical unit query service.

Returnosid.offering.CanonicalUnitQuerySession a CanonicalUnitQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCanonicalUnitQuery() is false
Complianceoptional This method must be implemented if supportsCanonicalUnitQuery() is true.
MethodgetCanonicalUnitQuerySessionForCatalogue
Description

Gets the OsidSession associated with the canonical unit query service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.CanonicalUnitQuerySession a CanonicalUnitQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsCanonicalUnitQuery() and supportsVisibleFederation() are true
MethodgetCanonicalUnitSearchSession
Description

Gets the OsidSession associated with the canonical unit search service.

Returnosid.offering.CanonicalUnitSearchSession a CanonicalUnitSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCanonicalUnitSearch() is false
Complianceoptional This method must be implemented if supportsCanonicalUnitSearch() is true.
MethodgetCanonicalUnitSearchSessionForCatalogue
Description

Gets the OsidSession associated with the canonical unit search service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.CanonicalUnitSearchSession a CanonicalUnitSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsCanonicalUnitSearch() and supportsVisibleFederation() are true
MethodgetCanonicalUnitAdminSession
Description

Gets the OsidSession associated with the canonical unit administration service.

Returnosid.offering.CanonicalUnitAdminSession a CanonicalUnitAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCanonicalUnitAdmin() is false
Complianceoptional This method must be implemented if supportsCanonicalUnitAdmin() is true.
MethodgetCanonicalUnitAdminSessionForCatalogue
Description

Gets the OsidSession associated with the canonical unit administration service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.CanonicalUnitAdminSession a CanonicalUnitAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsCanonicalUnitAdmin() and supportsVisibleFederation() are true
MethodgetCanonicalUnitNotificationSession
Description

Gets the OsidSession associated with the canonical unit notification service.

Parametersosid.offering.CanonicalUnitReceivercanonicalUnitReceiver the receiver
Returnosid.offering.CanonicalUnitNotificationSession a CanonicalUnitNotificationSession
ErrorsNULL_ARGUMENT canonicalUnitReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCanonicalUnitNotification() is false
Complianceoptional This method must be implemented if supportsCanonicalUnitNotification() is true.
MethodgetCanonicalUnitNotificationSessionForCatalogue
Description

Gets the OsidSession associated with the canonical unit notification service for the given catalogue.

Parametersosid.offering.CanonicalUnitReceivercanonicalUnitReceiver the receiver
osid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.CanonicalUnitNotificationSession a CanonicalUnitNotificationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsCanonicalUnitNotification() and supportsVisibleFederation() are true
MethodgetCanonicalUnitCatalogueSession
Description

Gets the session for retrieving canonical unit to catalogue mappings.

Returnosid.offering.CanonicalUnitCatalogueSession a CanonicalUnitCatalogueSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCanonicalUnitCatalogue() is false
Complianceoptional This method must be implemented if supportsCanonicalUnitCatalogue() is true.
MethodgetCanonicalUnitCatalogueAssignmentSession
Description

Gets the session for assigning canonical unit to catalogue mappings.

Returnosid.offering.CanonicalUnitCatalogueAssignmentSession a CanonicalUnitCatalogueAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCanonicalUnitCatalogueAssignment() is false
Complianceoptional This method must be implemented if supportsCanonicalUnitCatalogueAssignment() is true.
MethodgetCanonicalUnitSmartCatalogueSession
Description

Gets the session associated with the canonical unit smart catalogue for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the catalogue
Returnosid.offering.CanonicalUnitSmartCatalogueSession a CanonicalUnitSmartCatalogueSession
ErrorsNOT_FOUND catalogueId not found
NULL_ARGUMENT catalogueId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCanonicalUnitSmartCatalogue() is false
Complianceoptional This method must be implemented if supportsCanonicalUnitSmartCatalogue() is true.
MethodgetOfferingLookupSession
Description

Gets the OsidSession associated with the offering lookup service.

Returnosid.offering.OfferingLookupSession an OfferingLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingLookup() is false
Complianceoptional This method must be implemented if supportsOfferingLookup() is true.
MethodgetOfferingLookupSessionForCatalogue
Description

Gets the OsidSession associated with the offering lookup service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.OfferingLookupSession an OfferingLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsOfferingLookup() and supportsVisibleFederation() are true
MethodgetOfferingQuerySession
Description

Gets the OsidSession associated with the offering query service.

Returnosid.offering.OfferingQuerySession an OfferingQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingQuery() is false
Complianceoptional This method must be implemented if supportsOfferingQuery() is true.
MethodgetOfferingQuerySessionForCatalogue
Description

Gets the OsidSession associated with the offering query service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.OfferingQuerySession an OfferingQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsOfferingQuery() and supportsVisibleFederation() are true
MethodgetOfferingSearchSession
Description

Gets the OsidSession associated with the offering search service.

Returnosid.offering.OfferingSearchSession an OfferingSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingSearch() is false
Complianceoptional This method must be implemented if supportsOfferingSearch() is true.
MethodgetOfferingSearchSessionForCatalogue
Description

Gets the OsidSession associated with the offering search service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.OfferingSearchSession an OfferingSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsOfferingSearch() and supportsVisibleFederation() are true
MethodgetOfferingAdminSession
Description

Gets the OsidSession associated with the offering administration service.

Returnosid.offering.OfferingAdminSession an OfferingAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingAdmin() is false
Complianceoptional This method must be implemented if supportsOfferingAdmin() is true.
MethodgetOfferingAdminSessionForCatalogue
Description

Gets the OsidSession associated with the offering administration service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.OfferingAdminSession an OfferingAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsOfferingAdmin() and supportsVisibleFederation() are true
MethodgetOfferingNotificationSession
Description

Gets the OsidSession associated with the offering notification service.

Parametersosid.offering.OfferingReceiverofferingReceiver the receiver
Returnosid.offering.OfferingNotificationSession an OfferingNotificationSession
ErrorsNULL_ARGUMENT offeringReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingNotification() is false
Complianceoptional This method must be implemented if supportsOfferingNotification() is true.
MethodgetOfferingNotificationSessionForCatalogue
Description

Gets the OsidSession associated with the offering notification service for the given catalogue.

Parametersosid.offering.OfferingReceiverofferingReceiver the receiver
osid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.OfferingNotificationSession an OfferingNotificationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsOfferingNotification() and supportsVisibleFederation() are true
MethodgetOfferingCatalogueSession
Description

Gets the session for retrieving offering to catalogue mappings.

Returnosid.offering.OfferingCatalogueSession an OfferingCatalogueSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingCatalogue() is false
Complianceoptional This method must be implemented if supportsOfferingCatalogue() is true.
MethodgetOfferingCatalogueAssignmentSession
Description

Gets the session for assigning offering to catalogue mappings.

Returnosid.offering.OfferingCatalogueAssignmentSession an OfferingCatalogueAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingCatalogueAssignment() is false
Complianceoptional This method must be implemented if supportsOfferingCatalogueAssignment() is true.
MethodgetOfferingSmartCatalogueSession
Description

Gets the session associated with the offering smart catalogue for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the catalogue
Returnosid.offering.OfferingSmartCatalogueSession an OfferingSmartCatalogueSession
ErrorsNOT_FOUND catalogueId not found
NULL_ARGUMENT catalogueId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingSmartCatalogue() is false
Complianceoptional This method must be implemented if supportsOfferingSmartCatalogue() is true.
MethodgetParticipantLookupSession
Description

Gets the OsidSession associated with the participant lookup service.

Returnosid.offering.ParticipantLookupSession a ParticipantLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParticipantLookup() is false
Complianceoptional This method must be implemented if supportsParticipantLookup() is true.
MethodgetParticipantLookupSessionForCatalogue
Description

Gets the OsidSession associated with the participant lookup service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.ParticipantLookupSession a ParticipantLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsParticipantLookup() and supportsVisibleFederation() are true
MethodgetParticipantQuerySession
Description

Gets the OsidSession associated with the participant query service.

Returnosid.offering.ParticipantQuerySession a ParticipantQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParticipantQuery() is false
Complianceoptional This method must be implemented if supportsParticipantQuery() is true.
MethodgetParticipantQuerySessionForCatalogue
Description

Gets the OsidSession associated with the participant query service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.ParticipantQuerySession a ParticipantQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsParticipantQuery() and supportsVisibleFederation() are true
MethodgetParticipantSearchSession
Description

Gets the OsidSession associated with the participant search service.

Returnosid.offering.ParticipantSearchSession a ParticipantSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParticipantSearch() is false
Complianceoptional This method must be implemented if supportsParticipantSearch() is true.
MethodgetParticipantSearchSessionForCatalogue
Description

Gets the OsidSession associated with the participant search service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.ParticipantSearchSession a ParticipantSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsParticipantSearch() and supportsVisibleFederation() are true
MethodgetParticipantAdminSession
Description

Gets the OsidSession associated with the participant administration service.

Returnosid.offering.ParticipantAdminSession a ParticipantAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParticipantAdmin() is false
Complianceoptional This method must be implemented if supportsParticipantAdmin() is true.
MethodgetParticipantAdminSessionForCatalogue
Description

Gets the OsidSession associated with the participant administration service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.ParticipantAdminSession a ParticipantAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsParticipantAdmin() and supportsVisibleFederation() are true
MethodgetParticipantNotificationSession
Description

Gets the OsidSession associated with the participant notification service.

Parametersosid.offering.ParticipantReceiverparticipantReceiver the receiver
Returnosid.offering.ParticipantNotificationSession a ParticipantNotificationSession
ErrorsNULL_ARGUMENT participantReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParticipantNotification() is false
Complianceoptional This method must be implemented if supportsParticipantNotification() is true.
MethodgetParticipantNotificationSessionForCatalogue
Description

Gets the OsidSession associated with the participant notification service for the given catalogue.

Parametersosid.offering.ParticipantReceiverparticipantReceiver the receiver
osid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.ParticipantNotificationSession a ParticipantNotificationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsParticipantNotification() and supportsVisibleFederation() are true
MethodgetParticipantCatalogueSession
Description

Gets the session for retrieving participant to catalogue mappings.

Returnosid.offering.ParticipantCatalogueSession a ParticipantCatalogueSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParticipantCatalogue() is false
Complianceoptional This method must be implemented if supportsParticipantCatalogue() is true.
MethodgetParticipantCatalogueAssignmentSession
Description

Gets the session for assigning participant to catalogue mappings.

Returnosid.offering.ParticipantCatalogueAssignmentSession a ParticipantCatalogueAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParticipantCatalogueAssignment() is false
Complianceoptional This method must be implemented if supportsParticipantCatalogueAssignment() is true.
MethodgetParticipantSmartCatalogueSession
Description

Gets the session associated with the participant smart catalogue for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the catalogue
Returnosid.offering.ParticipantSmartCatalogueSession a ParticipantSmartCatalogueSession
ErrorsNOT_FOUND catalogueId not found
NULL_ARGUMENT catalogueId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsParticipantSmartCatalogue() is false
Complianceoptional This method must be implemented if supportsParticipantSmartCatalogue() is true.
MethodgetResultLookupSession
Description

Gets the OsidSession associated with the result lookup service.

Returnosid.offering.ResultLookupSession a ResultLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResultLookup() is false
Complianceoptional This method must be implemented if supportsResultLookup() is true.
MethodgetResultLookupSessionForCatalogue
Description

Gets the OsidSession associated with the result lookup service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.ResultLookupSession a ResultLookupSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsResultLookup() and supportsVisibleFederation() are true
MethodgetResultQuerySession
Description

Gets the OsidSession associated with the result query service.

Returnosid.offering.ResultQuerySession a ResultQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResultQuery() is false
Complianceoptional This method must be implemented if supportsResultQuery() is true.
MethodgetResultQuerySessionForCatalogue
Description

Gets the OsidSession associated with the result query service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.ResultQuerySession a ResultQuerySession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsResultQuery() and supportsVisibleFederation() are true
MethodgetResultSearchSession
Description

Gets the OsidSession associated with the result search service.

Returnosid.offering.ResultSearchSession a ResultSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResultSearch() is false
Complianceoptional This method must be implemented if supportsResultSearch() is true.
MethodgetResultSearchSessionForCatalogue
Description

Gets the OsidSession associated with the result search service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.ResultSearchSession a ResultSearchSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsResultSearch() and supportsVisibleFederation() are true
MethodgetResultAdminSession
Description

Gets the OsidSession associated with the result administration service.

Returnosid.offering.ResultAdminSession a ResultAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResultAdmin() is false
Complianceoptional This method must be implemented if supportsResultAdmin() is true.
MethodgetResultAdminSessionForCatalogue
Description

Gets the OsidSession associated with the result administration service for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.ResultAdminSession a ResultAdminSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsResultAdmin() and supportsVisibleFederation() are true
MethodgetResultNotificationSession
Description

Gets the OsidSession associated with the result notification service.

Parametersosid.offering.ResultReceiverresultReceiver the receiver
Returnosid.offering.ResultNotificationSession a ResultNotificationSession
ErrorsNULL_ARGUMENT resultReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResultNotification() is false
Complianceoptional This method must be implemented if supportsResultNotification() is true.
MethodgetResultNotificationSessionForCatalogue
Description

Gets the OsidSession associated with the result notification service for the given catalogue.

Parametersosid.offering.ResultReceiverresultReceiver the receiver
osid.id.IdcatalogueId the Id of the Catalogue
Returnosid.offering.ResultNotificationSession a ResultNotificationSession
ErrorsNOT_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
Complianceoptional This method must be implemented if supportsResultNotification() and supportsVisibleFederation() are true
MethodgetResultCatalogueSession
Description

Gets the session for retrieving result to catalogue mappings.

Returnosid.offering.ResultCatalogueSession a ResultCatalogueSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResultCatalogue() is false
Complianceoptional This method must be implemented if supportsResultCatalogue() is true.
MethodgetResultCatalogueAssignmentSession
Description

Gets the session for assigning result to catalogue mappings.

Returnosid.offering.ResultCatalogueAssignmentSession a ResultCatalogueAssignmentSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResultCatalogueAssignment() is false
Complianceoptional This method must be implemented if supportsResultCatalogueAssignment() is true.
MethodgetResultSmartCatalogueSession
Description

Gets the session associated with the result smart catalogue for the given catalogue.

Parametersosid.id.IdcatalogueId the Id of the catalogue
Returnosid.offering.ResultSmartCatalogueSession a ResultSmartCatalogueSession
ErrorsNOT_FOUND catalogueId not found
NULL_ARGUMENT catalogueId is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsResultSmartCatalogue() is false
Complianceoptional This method must be implemented if supportsAppointmenSmarttCatalogue() is true.
MethodgetCatalogueLookupSession
Description

Gets the OsidSession associated with the catalogue lookup service.

Returnosid.offering.CatalogueLookupSession a CatalogueLookupSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCatalogueLookup() is false
Complianceoptional This method must be implemented if supportsCatalogueLookup() is true.
MethodgetCatalogueQuerySession
Description

Gets the OsidSession associated with the catalogue query service.

Returnosid.offering.CatalogueQuerySession a CatalogueQuerySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCatalogueQuery() is false
Complianceoptional This method must be implemented if supportsCatalogueQuery() is true.
MethodgetCatalogueSearchSession
Description

Gets the OsidSession associated with the catalogue search service.

Returnosid.offering.CatalogueSearchSession a CatalogueSearchSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCatalogueSearch() is false
Complianceoptional This method must be implemented if supportsCatalogueSearch() is true.
MethodgetCatalogueAdminSession
Description

Gets the OsidSession associated with the catalogue administrative service.

Returnosid.offering.CatalogueAdminSession a CatalogueAdminSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCatalogueAdmin() is false
Complianceoptional This method must be implemented if supportsCatalogueAdmin() is true.
MethodgetCatalogueNotificationSession
Description

Gets the OsidSession associated with the catalogue notification service.

Parametersosid.offering.CatalogueReceivercatalogueReceiver the receiver
Returnosid.offering.CatalogueNotificationSession a CatalogueNotificationSession
ErrorsNULL_ARGUMENT catalogueReceiver is null
OPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCatalogueNotification() is false
Complianceoptional This method must be implemented if supportsCatalogueNotification() is true.
MethodgetCatalogueHierarchySession
Description

Gets the OsidSession associated with the catalogue hierarchy service.

Returnosid.offering.CatalogueHierarchySession a CatalogueHierarchySession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCatalogueHierarchy() is false
Complianceoptional This method must be implemented if supportsCatalogueHierarchy() is true.
MethodgetCatalogueHierarchyDesignSession
Description

Gets the OsidSession associated with the catalogue hierarchy design service.

Returnosid.offering.CatalogueHierarchyDesignSession a CatalogueHierarchyDesignSession
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsCatalogueHierarchyDesign() is false
Complianceoptional This method must be implemented if supportsCatalogueHierarchyDesign() is true.
MethodgetOfferingBatchManager
Description

Gets an OfferingBatchManager.

Returnosid.offering.batch.OfferingBatchManager an OfferingBatchManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingBatch() is false
Complianceoptional This method must be implemented if supportsOfferingBatch() is true.
MethodgetOfferingRulesManager
Description

Gets an OfferingRulesManager.

Returnosid.offering.rules.OfferingRulesManager an OfferingRulesManager
ErrorsOPERATION_FAILED unable to complete request
UNIMPLEMENTED supportsOfferingRules() is false
Complianceoptional This method must be implemented if supportsOfferingRules() is true.