org.osid.offering

Interface OfferingManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OfferingProfile, OsidManager, OsidProfile, Sourceable

public interface OfferingManager
extends OsidManager, OfferingProfile

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.

Method Summary

Methods

Modifier and Type	Method and Description
CanonicalUnitAdminSession	getCanonicalUnitAdminSession() Gets the OsidSession associated with the canonical unit administration service.
CanonicalUnitAdminSession	getCanonicalUnitAdminSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the canonical unit administration service for the given catalogue.
CanonicalUnitCatalogueAssignmentSession	getCanonicalUnitCatalogueAssignmentSession() Gets the session for assigning canonical unit to catalogue mappings.
CanonicalUnitCatalogueSession	getCanonicalUnitCatalogueSession() Gets the session for retrieving canonical unit to catalogue mappings.
CanonicalUnitLookupSession	getCanonicalUnitLookupSession() Gets the OsidSession associated with the canonical unit lookup service.
CanonicalUnitLookupSession	getCanonicalUnitLookupSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the canonical unit lookup service for the given catalogue.
CanonicalUnitNotificationSession	getCanonicalUnitNotificationSession(CanonicalUnitReceiver canonicalUnitReceiver) Gets the OsidSession associated with the canonical unit notification service.
CanonicalUnitNotificationSession	getCanonicalUnitNotificationSessionForCatalogue(CanonicalUnitReceiver canonicalUnitReceiver, Id catalogueId) Gets the OsidSession associated with the canonical unit notification service for the given catalogue.
CanonicalUnitQuerySession	getCanonicalUnitQuerySession() Gets the OsidSession associated with the canonical unit query service.
CanonicalUnitQuerySession	getCanonicalUnitQuerySessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the canonical unit query service for the given catalogue.
CanonicalUnitSearchSession	getCanonicalUnitSearchSession() Gets the OsidSession associated with the canonical unit search service.
CanonicalUnitSearchSession	getCanonicalUnitSearchSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the canonical unit search service for the given catalogue.
CanonicalUnitSmartCatalogueSession	getCanonicalUnitSmartCatalogueSession(Id catalogueId) Gets the session associated with the canonical unit smart catalogue for the given catalogue.
CatalogueAdminSession	getCatalogueAdminSession() Gets the OsidSession associated with the catalogue administrative service.
CatalogueHierarchyDesignSession	getCatalogueHierarchyDesignSession() Gets the OsidSession associated with the catalogue hierarchy design service.
CatalogueHierarchySession	getCatalogueHierarchySession() Gets the OsidSession associated with the catalogue hierarchy service.
CatalogueLookupSession	getCatalogueLookupSession() Gets the OsidSession associated with the catalogue lookup service.
CatalogueNotificationSession	getCatalogueNotificationSession(CatalogueReceiver catalogueReceiver) Gets the OsidSession associated with the catalogue notification service.
CatalogueQuerySession	getCatalogueQuerySession() Gets the OsidSession associated with the catalogue query service.
CatalogueSearchSession	getCatalogueSearchSession() Gets the OsidSession associated with the catalogue search service.
OfferingAdminSession	getOfferingAdminSession() Gets the OsidSession associated with the offering administration service.
OfferingAdminSession	getOfferingAdminSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the offering administration service for the given catalogue.
OfferingBatchManager	getOfferingBatchManager() Gets a OfferingBatchManager.
OfferingCatalogueAssignmentSession	getOfferingCatalogueAssignmentSession() Gets the session for assigning offering to catalogue mappings.
OfferingCatalogueSession	getOfferingCatalogueSession() Gets the session for retrieving offering to catalogue mappings.
OfferingLookupSession	getOfferingLookupSession() Gets the OsidSession associated with the offering lookup service.
OfferingLookupSession	getOfferingLookupSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the offering lookup service for the given catalogue.
OfferingNotificationSession	getOfferingNotificationSession(OfferingReceiver offeringReceiver) Gets the OsidSession associated with the offering notification service.
OfferingNotificationSession	getOfferingNotificationSessionForCatalogue(OfferingReceiver offeringReceiver, Id catalogueId) Gets the OsidSession associated with the offering notification service for the given catalogue.
OfferingQuerySession	getOfferingQuerySession() Gets the OsidSession associated with the offering query service.
OfferingQuerySession	getOfferingQuerySessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the offering query service for the given catalogue.
OfferingRulesManager	getOfferingRulesManager() Gets a OfferingRulesManager.
OfferingSearchSession	getOfferingSearchSession() Gets the OsidSession associated with the offering search service.
OfferingSearchSession	getOfferingSearchSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the offering search service for the given catalogue.
OfferingSmartCatalogueSession	getOfferingSmartCatalogueSession(Id catalogueId) Gets the session associated with the offering smart catalogue for the given catalogue.
ParticipantAdminSession	getParticipantAdminSession() Gets the OsidSession associated with the participant administration service.
ParticipantAdminSession	getParticipantAdminSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the participant administration service for the given catalogue.
ParticipantCatalogueAssignmentSession	getParticipantCatalogueAssignmentSession() Gets the session for assigning participant to catalogue mappings.
ParticipantCatalogueSession	getParticipantCatalogueSession() Gets the session for retrieving participant to catalogue mappings.
ParticipantLookupSession	getParticipantLookupSession() Gets the OsidSession associated with the participant lookup service.
ParticipantLookupSession	getParticipantLookupSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the participant lookup service for the given catalogue.
ParticipantNotificationSession	getParticipantNotificationSession(ParticipantReceiver participantReceiver) Gets the OsidSession associated with the participant notification service.
ParticipantNotificationSession	getParticipantNotificationSessionForCatalogue(ParticipantReceiver participantReceiver, Id catalogueId) Gets the OsidSession associated with the participant notification service for the given catalogue.
ParticipantQuerySession	getParticipantQuerySession() Gets the OsidSession associated with the participant query service.
ParticipantQuerySession	getParticipantQuerySessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the participant query service for the given catalogue.
ParticipantSearchSession	getParticipantSearchSession() Gets the OsidSession associated with the participant search service.
ParticipantSearchSession	getParticipantSearchSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the participant search service for the given catalogue.
ParticipantSmartCatalogueSession	getParticipantSmartCatalogueSession(Id catalogueId) Gets the session associated with the participant smart catalogue for the given catalogue.
ResultAdminSession	getResultAdminSession() Gets the OsidSession associated with the result administration service.
ResultAdminSession	getResultAdminSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the result administration service for the given catalogue.
ResultCatalogueAssignmentSession	getResultCatalogueAssignmentSession() Gets the session for assigning result to catalogue mappings.
ResultCatalogueSession	getResultCatalogueSession() Gets the session for retrieving result to catalogue mappings.
ResultLookupSession	getResultLookupSession() Gets the OsidSession associated with the result lookup service.
ResultLookupSession	getResultLookupSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the result lookup service for the given catalogue.
ResultNotificationSession	getResultNotificationSession(ResultReceiver resultReceiver) Gets the OsidSession associated with the result notification service.
ResultNotificationSession	getResultNotificationSessionForCatalogue(ResultReceiver resultReceiver, Id catalogueId) Gets the OsidSession associated with the result notification service for the given catalogue.
ResultQuerySession	getResultQuerySession() Gets the OsidSession associated with the result query service.
ResultQuerySession	getResultQuerySessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the result query service for the given catalogue.
ResultSearchSession	getResultSearchSession() Gets the OsidSession associated with the result search service.
ResultSearchSession	getResultSearchSessionForCatalogue(Id catalogueId) Gets the OsidSession associated with the result search service for the given catalogue.
ResultSmartCatalogueSession	getResultSmartCatalogueSession(Id catalogueId) Gets the session associated with the result smart catalogue for the given catalogue.

Methods inherited from interface org.osid.OsidManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.offering.OfferingProfile

getCanonicalUnitRecordTypes, getCanonicalUnitSearchRecordTypes, getCatalogueRecordTypes, getCatalogueSearchRecordTypes, getOfferingRecordTypes, getOfferingSearchRecordTypes, getParticipantRecordTypes, getParticipantSearchRecordTypes, getResultRecordTypes, getResultSearchRecordTypes, supportsCanonicalUnitAdmin, supportsCanonicalUnitCatalogue, supportsCanonicalUnitCatalogueAssignment, supportsCanonicalUnitLookup, supportsCanonicalUnitNotification, supportsCanonicalUnitQuery, supportsCanonicalUnitRecordType, supportsCanonicalUnitSearch, supportsCanonicalUnitSearchRecordType, supportsCanonicalUnitSmartCatalogue, supportsCatalogueAdmin, supportsCatalogueHierarchy, supportsCatalogueHierarchyDesign, supportsCatalogueLookup, supportsCatalogueNotification, supportsCatalogueQuery, supportsCatalogueRecordType, supportsCatalogueSearch, supportsCatalogueSearchRecordType, supportsOfferingAdmin, supportsOfferingBatch, supportsOfferingCatalogue, supportsOfferingCatalogueAssignment, supportsOfferingLookup, supportsOfferingNotification, supportsOfferingQuery, supportsOfferingRecordType, supportsOfferingRules, supportsOfferingSearch, supportsOfferingSearchRecordType, supportsOfferingSmartCatalogue, supportsParticipantAdmin, supportsParticipantCatalogue, supportsParticipantCatalogueAssignment, supportsParticipantLookup, supportsParticipantNotification, supportsParticipantQuery, supportsParticipantRecordType, supportsParticipantSearch, supportsParticipantSearchRecordType, supportsParticipantSmartCatalogue, supportsResultAdmin, supportsResultCatalogue, supportsResultCatalogueAssignment, supportsResultLookup, supportsResultNotification, supportsResultQuery, supportsResultRecordType, supportsResultSearch, supportsResultSearchRecordType, supportsResultSmartCatalogue, supportsVisibleFederation

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getCanonicalUnitLookupSession

CanonicalUnitLookupSession getCanonicalUnitLookupSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the canonical unit lookup service.

Returns:

a CanonicalUnitLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitLookup() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitLookup() is true.

getCanonicalUnitLookupSessionForCatalogue

CanonicalUnitLookupSession getCanonicalUnitLookupSessionForCatalogue(Id catalogueId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

a CanonicalUnitLookupSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitLookup() and supportsVisibleFederation() are true

getCanonicalUnitQuerySession

CanonicalUnitQuerySession getCanonicalUnitQuerySession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the canonical unit query service.

Returns:

a CanonicalUnitQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitQuery() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitQuery() is true.

getCanonicalUnitQuerySessionForCatalogue

CanonicalUnitQuerySession getCanonicalUnitQuerySessionForCatalogue(Id catalogueId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

a CanonicalUnitQuerySession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitQuery() and supportsVisibleFederation() are true

getCanonicalUnitSearchSession

CanonicalUnitSearchSession getCanonicalUnitSearchSession()
                                                         throws OperationFailedException

Gets the OsidSession associated with the canonical unit search service.

Returns:

a CanonicalUnitSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitSearch() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitSearch() is true.

getCanonicalUnitSearchSessionForCatalogue

CanonicalUnitSearchSession getCanonicalUnitSearchSessionForCatalogue(Id catalogueId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

a CanonicalUnitSearchSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitSearch() and supportsVisibleFederation() are true

getCanonicalUnitAdminSession

CanonicalUnitAdminSession getCanonicalUnitAdminSession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the canonical unit administration service.

Returns:

a CanonicalUnitAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitAdmin() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitAdmin() is true.

getCanonicalUnitAdminSessionForCatalogue

CanonicalUnitAdminSession getCanonicalUnitAdminSessionForCatalogue(Id catalogueId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

a CanonicalUnitAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitAdmin() and supportsVisibleFederation() are true

getCanonicalUnitNotificationSession

CanonicalUnitNotificationSession getCanonicalUnitNotificationSession(CanonicalUnitReceiver canonicalUnitReceiver)
                                                                     throws OperationFailedException

Gets the OsidSession associated with the canonical unit notification service.

Parameters:

canonicalUnitReceiver - the receiver

Returns:

a CanonicalUnitNotificationSession

Throws:

NullArgumentException - canonicalUnitReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitNotification() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitNotification() is true.

getCanonicalUnitNotificationSessionForCatalogue

CanonicalUnitNotificationSession getCanonicalUnitNotificationSessionForCatalogue(CanonicalUnitReceiver canonicalUnitReceiver,
                                                                               Id catalogueId)
                                                                                 throws NotFoundException,
                                                                                        OperationFailedException

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

Parameters:

canonicalUnitReceiver - the receiver

catalogueId - the Id of the Catalogue

Returns:

a CanonicalUnitNotificationSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - canonicalUnitReceiver or catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitNotification() and supportsVisibleFederation() are true

getCanonicalUnitCatalogueSession

CanonicalUnitCatalogueSession getCanonicalUnitCatalogueSession()
                                                               throws OperationFailedException

Gets the session for retrieving canonical unit to catalogue mappings.

Returns:

a CanonicalUnitCatalogueSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitCatalogue() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitCatalogue() is true.

getCanonicalUnitCatalogueAssignmentSession

CanonicalUnitCatalogueAssignmentSession getCanonicalUnitCatalogueAssignmentSession()
                                                                                   throws OperationFailedException

Gets the session for assigning canonical unit to catalogue mappings.

Returns:

a CanonicalUnitCatalogueAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitCatalogueAssignment() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitCatalogueAssignment() is true.

getCanonicalUnitSmartCatalogueSession

CanonicalUnitSmartCatalogueSession getCanonicalUnitSmartCatalogueSession(Id catalogueId)
                                                                         throws NotFoundException,
                                                                                OperationFailedException

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

Parameters:

catalogueId - the Id of the catalogue

Returns:

a CanonicalUnitSmartCatalogueSession

Throws:

NotFoundException - catalogueId not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitSmartCatalogue() is false

Compliance:

optional - This method must be implemented if supportsCanonicalUnitSmartCatalogue() is true.

getOfferingLookupSession

OfferingLookupSession getOfferingLookupSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the offering lookup service.

Returns:

an OfferingLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingLookup() is false

Compliance:

optional - This method must be implemented if supportsOfferingLookup() is true.

getOfferingLookupSessionForCatalogue

OfferingLookupSession getOfferingLookupSessionForCatalogue(Id catalogueId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

an OfferingLookupSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOfferingLookup() and supportsVisibleFederation() are true

getOfferingQuerySession

OfferingQuerySession getOfferingQuerySession()
                                             throws OperationFailedException

Gets the OsidSession associated with the offering query service.

Returns:

an OfferingQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingQuery() is false

Compliance:

optional - This method must be implemented if supportsOfferingQuery() is true.

getOfferingQuerySessionForCatalogue

OfferingQuerySession getOfferingQuerySessionForCatalogue(Id catalogueId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

an OfferingQuerySession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOfferingQuery() and supportsVisibleFederation() are true

getOfferingSearchSession

OfferingSearchSession getOfferingSearchSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the offering search service.

Returns:

an OfferingSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingSearch() is false

Compliance:

optional - This method must be implemented if supportsOfferingSearch() is true.

getOfferingSearchSessionForCatalogue

OfferingSearchSession getOfferingSearchSessionForCatalogue(Id catalogueId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

an OfferingSearchSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOfferingSearch() and supportsVisibleFederation() are true

getOfferingAdminSession

OfferingAdminSession getOfferingAdminSession()
                                             throws OperationFailedException

Gets the OsidSession associated with the offering administration service.

Returns:

an OfferingAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingAdmin() is false

Compliance:

optional - This method must be implemented if supportsOfferingAdmin() is true.

getOfferingAdminSessionForCatalogue

OfferingAdminSession getOfferingAdminSessionForCatalogue(Id catalogueId)
                                                         throws NotFoundException,
                                                                OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

an OfferingAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOfferingAdmin() and supportsVisibleFederation() are true

getOfferingNotificationSession

OfferingNotificationSession getOfferingNotificationSession(OfferingReceiver offeringReceiver)
                                                           throws OperationFailedException

Gets the OsidSession associated with the offering notification service.

Parameters:

offeringReceiver - the receiver

Returns:

an OfferingNotificationSession

Throws:

NullArgumentException - offeringReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingNotification() is false

Compliance:

optional - This method must be implemented if supportsOfferingNotification() is true.

getOfferingNotificationSessionForCatalogue

OfferingNotificationSession getOfferingNotificationSessionForCatalogue(OfferingReceiver offeringReceiver,
                                                                     Id catalogueId)
                                                                       throws NotFoundException,
                                                                              OperationFailedException

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

Parameters:

offeringReceiver - the receiver

catalogueId - the Id of the Catalogue

Returns:

an OfferingNotificationSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - offeringReceiver or catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsOfferingNotification() and supportsVisibleFederation() are true

getOfferingCatalogueSession

OfferingCatalogueSession getOfferingCatalogueSession()
                                                     throws OperationFailedException

Gets the session for retrieving offering to catalogue mappings.

Returns:

an OfferingCatalogueSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingCatalogue() is false

Compliance:

optional - This method must be implemented if supportsOfferingCatalogue() is true.

getOfferingCatalogueAssignmentSession

OfferingCatalogueAssignmentSession getOfferingCatalogueAssignmentSession()
                                                                         throws OperationFailedException

Gets the session for assigning offering to catalogue mappings.

Returns:

an OfferingCatalogueAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingCatalogueAssignment() is false

Compliance:

optional - This method must be implemented if supportsOfferingCatalogueAssignment() is true.

getOfferingSmartCatalogueSession

OfferingSmartCatalogueSession getOfferingSmartCatalogueSession(Id catalogueId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

catalogueId - the Id of the catalogue

Returns:

an OfferingSmartCatalogueSession

Throws:

NotFoundException - catalogueId not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingSmartCatalogue() is false

Compliance:

optional - This method must be implemented if supportsOfferingSmartCatalogue() is true.

getParticipantLookupSession

ParticipantLookupSession getParticipantLookupSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the participant lookup service.

Returns:

a ParticipantLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantLookup() is false

Compliance:

optional - This method must be implemented if supportsParticipantLookup() is true.

getParticipantLookupSessionForCatalogue

ParticipantLookupSession getParticipantLookupSessionForCatalogue(Id catalogueId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

a ParticipantLookupSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsParticipantLookup() and supportsVisibleFederation() are true

getParticipantQuerySession

ParticipantQuerySession getParticipantQuerySession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the participant query service.

Returns:

a ParticipantQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantQuery() is false

Compliance:

optional - This method must be implemented if supportsParticipantQuery() is true.

getParticipantQuerySessionForCatalogue

ParticipantQuerySession getParticipantQuerySessionForCatalogue(Id catalogueId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

a ParticipantQuerySession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsParticipantQuery() and supportsVisibleFederation() are true

getParticipantSearchSession

ParticipantSearchSession getParticipantSearchSession()
                                                     throws OperationFailedException

Gets the OsidSession associated with the participant search service.

Returns:

a ParticipantSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantSearch() is false

Compliance:

optional - This method must be implemented if supportsParticipantSearch() is true.

getParticipantSearchSessionForCatalogue

ParticipantSearchSession getParticipantSearchSessionForCatalogue(Id catalogueId)
                                                                 throws NotFoundException,
                                                                        OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

a ParticipantSearchSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsParticipantSearch() and supportsVisibleFederation() are true

getParticipantAdminSession

ParticipantAdminSession getParticipantAdminSession()
                                                   throws OperationFailedException

Gets the OsidSession associated with the participant administration service.

Returns:

a ParticipantAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantAdmin() is false

Compliance:

optional - This method must be implemented if supportsParticipantAdmin() is true.

getParticipantAdminSessionForCatalogue

ParticipantAdminSession getParticipantAdminSessionForCatalogue(Id catalogueId)
                                                               throws NotFoundException,
                                                                      OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

a ParticipantAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsParticipantAdmin() and supportsVisibleFederation() are true

getParticipantNotificationSession

ParticipantNotificationSession getParticipantNotificationSession(ParticipantReceiver participantReceiver)
                                                                 throws OperationFailedException

Gets the OsidSession associated with the participant notification service.

Parameters:

participantReceiver - the receiver

Returns:

a ParticipantNotificationSession

Throws:

NullArgumentException - participantReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantNotification() is false

Compliance:

optional - This method must be implemented if supportsParticipantNotification() is true.

getParticipantNotificationSessionForCatalogue

ParticipantNotificationSession getParticipantNotificationSessionForCatalogue(ParticipantReceiver participantReceiver,
                                                                           Id catalogueId)
                                                                             throws NotFoundException,
                                                                                    OperationFailedException

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

Parameters:

participantReceiver - the receiver

catalogueId - the Id of the Catalogue

Returns:

a ParticipantNotificationSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - participantReceiver or catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsParticipantNotification() and supportsVisibleFederation() are true

getParticipantCatalogueSession

ParticipantCatalogueSession getParticipantCatalogueSession()
                                                           throws OperationFailedException

Gets the session for retrieving participant to catalogue mappings.

Returns:

a ParticipantCatalogueSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantCatalogue() is false

Compliance:

optional - This method must be implemented if supportsParticipantCatalogue() is true.

getParticipantCatalogueAssignmentSession

ParticipantCatalogueAssignmentSession getParticipantCatalogueAssignmentSession()
                                                                               throws OperationFailedException

Gets the session for assigning participant to catalogue mappings.

Returns:

a ParticipantCatalogueAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantCatalogueAssignment() is false

Compliance:

optional - This method must be implemented if supportsParticipantCatalogueAssignment() is true.

getParticipantSmartCatalogueSession

ParticipantSmartCatalogueSession getParticipantSmartCatalogueSession(Id catalogueId)
                                                                     throws NotFoundException,
                                                                            OperationFailedException

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

Parameters:

catalogueId - the Id of the catalogue

Returns:

a ParticipantSmartCatalogueSession

Throws:

NotFoundException - catalogueId not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantSmartCatalogue() is false

Compliance:

optional - This method must be implemented if supportsParticipantSmartCatalogue() is true.

getResultLookupSession

ResultLookupSession getResultLookupSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the result lookup service.

Returns:

an ResultLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResultLookup() is false

Compliance:

optional - This method must be implemented if supportsResultLookup() is true.

getResultLookupSessionForCatalogue

ResultLookupSession getResultLookupSessionForCatalogue(Id catalogueId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

an ResultLookupSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResultLookup() and supportsVisibleFederation() are true

getResultQuerySession

ResultQuerySession getResultQuerySession()
                                         throws OperationFailedException

Gets the OsidSession associated with the result query service.

Returns:

an ResultQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResultQuery() is false

Compliance:

optional - This method must be implemented if supportsResultQuery() is true.

getResultQuerySessionForCatalogue

ResultQuerySession getResultQuerySessionForCatalogue(Id catalogueId)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

an ResultQuerySession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResultQuery() and supportsVisibleFederation() are true

getResultSearchSession

ResultSearchSession getResultSearchSession()
                                           throws OperationFailedException

Gets the OsidSession associated with the result search service.

Returns:

an ResultSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResultSearch() is false

Compliance:

optional - This method must be implemented if supportsResultSearch() is true.

getResultSearchSessionForCatalogue

ResultSearchSession getResultSearchSessionForCatalogue(Id catalogueId)
                                                       throws NotFoundException,
                                                              OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

an ResultSearchSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResultSearch() and supportsVisibleFederation() are true

getResultAdminSession

ResultAdminSession getResultAdminSession()
                                         throws OperationFailedException

Gets the OsidSession associated with the result administration service.

Returns:

an ResultAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResultAdmin() is false

Compliance:

optional - This method must be implemented if supportsResultAdmin() is true.

getResultAdminSessionForCatalogue

ResultAdminSession getResultAdminSessionForCatalogue(Id catalogueId)
                                                     throws NotFoundException,
                                                            OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

Returns:

an ResultAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResultAdmin() and supportsVisibleFederation() are true

getResultNotificationSession

ResultNotificationSession getResultNotificationSession(ResultReceiver resultReceiver)
                                                       throws OperationFailedException

Gets the OsidSession associated with the result notification service.

Parameters:

resultReceiver - the receiver

Returns:

an ResultNotificationSession

Throws:

NullArgumentException - resultReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultNotification() is false

Compliance:

optional - This method must be implemented if supportsResultNotification() is true.

getResultNotificationSessionForCatalogue

ResultNotificationSession getResultNotificationSessionForCatalogue(ResultReceiver resultReceiver,
                                                                 Id catalogueId)
                                                                   throws NotFoundException,
                                                                          OperationFailedException

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

Parameters:

resultReceiver - the receiver

catalogueId - the Id of the Catalogue

Returns:

an ResultNotificationSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - resultReceiver or catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if supportsResultNotification() and supportsVisibleFederation() are true

getResultCatalogueSession

ResultCatalogueSession getResultCatalogueSession()
                                                 throws OperationFailedException

Gets the session for retrieving result to catalogue mappings.

Returns:

an ResultCatalogueSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResultCatalogue() is false

Compliance:

optional - This method must be implemented if supportsResultCatalogue() is true.

getResultCatalogueAssignmentSession

ResultCatalogueAssignmentSession getResultCatalogueAssignmentSession()
                                                                     throws OperationFailedException

Gets the session for assigning result to catalogue mappings.

Returns:

an ResultCatalogueAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsResultCatalogueAssignment() is false

Compliance:

optional - This method must be implemented if supportsResultCatalogueAssignment() is true.

getResultSmartCatalogueSession

ResultSmartCatalogueSession getResultSmartCatalogueSession(Id catalogueId)
                                                           throws NotFoundException,
                                                                  OperationFailedException

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

Parameters:

catalogueId - the Id of the catalogue

Returns:

an ResultSmartCatalogueSession

Throws:

NotFoundException - catalogueId not found

NullArgumentException - catalogueId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultSmartCatalogue() is false

Compliance:

optional - This method must be implemented if supportsAppointmenSmarttCatalogue() is true.

getCatalogueLookupSession

CatalogueLookupSession getCatalogueLookupSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the catalogue lookup service.

Returns:

a CatalogueLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueLookup() is false

Compliance:

optional - This method must be implemented if supportsCatalogueLookup() is true.

getCatalogueQuerySession

CatalogueQuerySession getCatalogueQuerySession()
                                               throws OperationFailedException

Gets the OsidSession associated with the catalogue query service.

Returns:

a CatalogueQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueQuery() is false

Compliance:

optional - This method must be implemented if supportsCatalogueQuery() is true.

getCatalogueSearchSession

CatalogueSearchSession getCatalogueSearchSession()
                                                 throws OperationFailedException

Gets the OsidSession associated with the catalogue search service.

Returns:

a CatalogueSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueSearch() is false

Compliance:

optional - This method must be implemented if supportsCatalogueSearch() is true.

getCatalogueAdminSession

CatalogueAdminSession getCatalogueAdminSession()
                                               throws OperationFailedException

Gets the OsidSession associated with the catalogue administrative service.

Returns:

a CatalogueAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueAdmin() is false

Compliance:

optional - This method must be implemented if supportsCatalogueAdmin() is true.

getCatalogueNotificationSession

CatalogueNotificationSession getCatalogueNotificationSession(CatalogueReceiver catalogueReceiver)
                                                             throws OperationFailedException

Gets the OsidSession associated with the catalogue notification service.

Parameters:

catalogueReceiver - the receiver

Returns:

a CatalogueNotificationSession

Throws:

NullArgumentException - catalogueReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueNotification() is false

Compliance:

optional - This method must be implemented if supportsCatalogueNotification() is true.

getCatalogueHierarchySession

CatalogueHierarchySession getCatalogueHierarchySession()
                                                       throws OperationFailedException

Gets the OsidSession associated with the catalogue hierarchy service.

Returns:

a CatalogueHierarchySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueHierarchy() is false

Compliance:

optional - This method must be implemented if supportsCatalogueHierarchy() is true.

getCatalogueHierarchyDesignSession

CatalogueHierarchyDesignSession getCatalogueHierarchyDesignSession()
                                                                   throws OperationFailedException

Gets the OsidSession associated with the catalogue hierarchy design service.

Returns:

a CatalogueHierarchyDesignSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueHierarchyDesign() is false

Compliance:

optional - This method must be implemented if supportsCatalogueHierarchyDesign() is true.

getOfferingBatchManager

OfferingBatchManager getOfferingBatchManager()
                                             throws OperationFailedException

Gets a OfferingBatchManager.

Returns:

a OfferingBatchManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingBatch() is false

Compliance:

optional - This method must be implemented if supportsOfferingBatch() is true.

getOfferingRulesManager

OfferingRulesManager getOfferingRulesManager()
                                             throws OperationFailedException

Gets a OfferingRulesManager.

Returns:

a OfferingRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingRules() is false

Compliance:

optional - This method must be implemented if supportsOfferingRules() is true.