Interface OfferingProxyManager

All Superinterfaces:

AutoCloseable, Closeable, OfferingProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface OfferingProxyManager
extends OsidProxyManager, OfferingProfile

The offering manager provides access to offering sessions and provides interoperability tests for various aspects of this service. Methods in this manager accept a Proxy interface for passing information from a server environment. 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

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

Methods inherited from interface Closeable

close

Methods inherited from interface 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

Modifier and Type	Method	Description
TypeList	getCanonicalUnitRecordTypes()	Gets the supported CanonicalUnit record types.
TypeList	getCanonicalUnitSearchRecordTypes()	Gets the supported canonical unit search record types.
TypeList	getCatalogueRecordTypes()	Gets the supported Catalogue record types.
TypeList	getCatalogueSearchRecordTypes()	Gets the supported catalogue search record types.
TypeList	getOfferingRecordTypes()	Gets the supported Offering record types.
TypeList	getOfferingSearchRecordTypes()	Gets the supported offering search record types.
TypeList	getParticipantRecordTypes()	Gets the supported Participant record types.
TypeList	getParticipantSearchRecordTypes()	Gets the supported participant search record types.
TypeList	getResultRecordTypes()	Gets the supported Result record types.
TypeList	getResultSearchRecordTypes()	Gets the supported result search record types.
boolean	supportsCanonicalUnitAdmin()	Tests if managing for canonical units is available.
boolean	supportsCanonicalUnitCatalogue()	Tests if a canonical unit to catalogue lookup session is available.
boolean	supportsCanonicalUnitCatalogueAssignment()	Tests if a canonical unit to catalogue assignment session is available.
boolean	supportsCanonicalUnitLookup()	Tests for the availability of a canonical unit lookup service.
boolean	supportsCanonicalUnitNotification()	Tests if canonical unit notification is available.
boolean	supportsCanonicalUnitQuery()	Tests for the availability of a canonical unit query service.
boolean	supportsCanonicalUnitRecordType(Type canonicalUnitRecordType)	Tests if the given CanonicalUnit record type is supported.
boolean	supportsCanonicalUnitSearch()	Tests if searching for canonical units is available.
boolean	supportsCanonicalUnitSearchRecordType(Type canonicalUnitSearchRecordType)	Tests if the given canonical unit search record type is supported.
boolean	supportsCanonicalUnitSmartCatalogue()	Tests if a canonical unit smart catalogue session is available.
boolean	supportsCatalogueAdmin()	Tests for the availability of a catalogue administrative service for creating and deleting catalogues.
boolean	supportsCatalogueHierarchy()	Tests for the availability of a catalogue hierarchy traversal service.
boolean	supportsCatalogueHierarchyDesign()	Tests for the availability of a catalogue hierarchy design service.
boolean	supportsCatalogueLookup()	Tests for the availability of a catalogue lookup service.
boolean	supportsCatalogueNotification()	Tests for the availability of a catalogue notification service.
boolean	supportsCatalogueQuery()	Tests if querying catalogues is available.
boolean	supportsCatalogueRecordType(Type catalogueRecordType)	Tests if the given Catalogue record type is supported.
boolean	supportsCatalogueSearch()	Tests if searching for catalogues is available.
boolean	supportsCatalogueSearchRecordType(Type catalogueSearchRecordType)	Tests if the given catalogue search record type is supported.
boolean	supportsOfferingAdmin()	Tests if managing for offerings is available.
boolean	supportsOfferingBatch()	Tests for the availability of an offering batch service.
boolean	supportsOfferingCatalogue()	Tests if an offering to catalogue lookup session is available.
boolean	supportsOfferingCatalogueAssignment()	Tests if an offering to catalogue assignment session is available.
boolean	supportsOfferingLookup()	Tests for the availability of an offering lookup service.
boolean	supportsOfferingNotification()	Tests if offering notification is available.
boolean	supportsOfferingQuery()	Tests for the availability of an offering query service.
boolean	supportsOfferingRecordType(Type offeringRecordType)	Tests if the given Offering record type is supported.
boolean	supportsOfferingRules()	Tests for the availability of an offering rules service.
boolean	supportsOfferingSearch()	Tests if searching for offerings is available.
boolean	supportsOfferingSearchRecordType(Type offeringSearchRecordType)	Tests if the given offering search record type is supported.
boolean	supportsOfferingSmartCatalogue()	Tests if an offering smart catalogue session is available.
boolean	supportsParticipantAdmin()	Tests if managing for participants is available.
boolean	supportsParticipantCatalogue()	Tests if a participant to catalogue lookup session is available.
boolean	supportsParticipantCatalogueAssignment()	Tests if a participant to catalogue assignment session is available.
boolean	supportsParticipantLookup()	Tests for the availability of a participant lookup service.
boolean	supportsParticipantNotification()	Tests if participant notification is available.
boolean	supportsParticipantQuery()	Tests for the availability of a participant query service.
boolean	supportsParticipantRecordType(Type participantRecordType)	Tests if the given Participant record type is supported.
boolean	supportsParticipantSearch()	Tests if searching for participants is available.
boolean	supportsParticipantSearchRecordType(Type participantSearchRecordType)	Tests if the given participant search record type is supported.
boolean	supportsParticipantSmartCatalogue()	Tests if a participant smart catalogue session is available.
boolean	supportsResultAdmin()	Tests if managing for results is available.
boolean	supportsResultCatalogue()	Tests if a result to catalogue lookup session is available.
boolean	supportsResultCatalogueAssignment()	Tests if a result to catalogue assignment session is available.
boolean	supportsResultLookup()	Tests for the availability of a result lookup service.
boolean	supportsResultNotification()	Tests if result notification is available.
boolean	supportsResultQuery()	Tests for the availability of a result query service.
boolean	supportsResultRecordType(Type resultRecordType)	Tests if the given Result record type is supported.
boolean	supportsResultSearch()	Tests if searching for results is available.
boolean	supportsResultSearchRecordType(Type resultSearchRecordType)	Tests if the given result search record type is supported.
boolean	supportsResultSmartCatalogue()	Tests if a result smart catalogue session is available.
boolean	supportsVisibleFederation()	Tests if any catalogue federation is exposed.

Methods inherited from interface OsidProfile

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

Modifier and Type	Method	Description
Branch	getBranch()	Gets this service branch.
Id	getBranchId()	Gets the Branch Id representing this service branch.
DisplayText	getDescription()	Gets a description of this service implementation.
DisplayText	getDisplayName()	Gets a display name for this service implementation.
Id	getId()	Gets an identifier for this service implementation.
LocaleList	getLocales()	Gets the locales supported in this service.
TypeList	getProxyRecordTypes()	Gets the proxy record Types supported in this service.
DateTime	getReleaseDate()	Gets the date this service implementation was released.
Version	getVersion()	Gets the version of this service implementation.
boolean	supportsJournalBranching()	Test for support of a journal branching service.
boolean	supportsJournalRollback()	Test for support of a journaling rollback service.
boolean	supportsOSIDVersion(Version version)	Test for support of an OSID specification version.
boolean	supportsProxyRecordType(Type proxyRecordType)	Test for support of a proxy type.

Methods inherited from interface OsidProxyManager

close

Modifier and Type	Method	Description
void	close()	Close this manager.

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

Modifier and Type	Method	Description
void	changeBranch(Id branchId, Proxy proxy)	Changes the service branch.
void	initialize(OsidRuntimeManager runtime)	Initializes this manager.
JournalEntry	rollbackService(Date rollbackTime, Proxy proxy)	Rolls back this service to a point in time.

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Modifier and Type	Method	Description
AssetList	getBranding()	Gets a branding, such as an image or logo, expressed using the Asset interface.
IdList	getBrandingIds()	Gets the branding asset Ids.
DisplayText	getLicense()	Gets the terms of usage.
Resource	getProvider()	Gets the Resource representing the provider.
Id	getProviderId()	Gets the Id of the provider.

Method Details

getCanonicalUnitLookupSession

CanonicalUnitLookupSession getCanonicalUnitLookupSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the canonical unit lookup service.

Parameters:

proxy - a proxy

Returns:

a CanonicalUnitLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitLookup()} is {@code true}.

getCanonicalUnitLookupSessionForCatalogue

CanonicalUnitLookupSession getCanonicalUnitLookupSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a CanonicalUnitLookupSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitLookup()} and {@code supportsVisibleFederation()} are {@code true}

getCanonicalUnitQuerySession

CanonicalUnitQuerySession getCanonicalUnitQuerySession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the canonical unit query service.

Parameters:

proxy - a proxy

Returns:

a CanonicalUnitQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitQuery()} is {@code true}.

getCanonicalUnitQuerySessionForCatalogue

CanonicalUnitQuerySession getCanonicalUnitQuerySessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a CanonicalUnitQuerySession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitQuery()} and {@code supportsVisibleFederation()} are {@code true}

getCanonicalUnitSearchSession

CanonicalUnitSearchSession getCanonicalUnitSearchSession(Proxy proxy)
                                                  throws OperationFailedException

Gets the OsidSession associated with the canonical unit search service.

Parameters:

proxy - a proxy

Returns:

a CanonicalUnitSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitSearch()} is {@code true}.

getCanonicalUnitSearchSessionForCatalogue

CanonicalUnitSearchSession getCanonicalUnitSearchSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a CanonicalUnitSearchSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitSearch()} and {@code supportsVisibleFederation()} are {@code true}

getCanonicalUnitAdminSession

CanonicalUnitAdminSession getCanonicalUnitAdminSession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the canonical unit administration service.

Parameters:

proxy - a proxy

Returns:

a CanonicalUnitAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitAdmin()} is {@code true}.

getCanonicalUnitAdminSessionForCatalogue

CanonicalUnitAdminSession getCanonicalUnitAdminSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                            throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a CanonicalUnitAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getCanonicalUnitNotificationSession

CanonicalUnitNotificationSession getCanonicalUnitNotificationSession(CanonicalUnitReceiver canonicalUnitReceiver,
 Proxy proxy)
                                                              throws OperationFailedException

Gets the OsidSession associated with the canonical unit notification service.

Parameters:

canonicalUnitReceiver - the receiver

proxy - a proxy

Returns:

a CanonicalUnitNotificationSession

Throws:

NullArgumentException - canonicalUnitReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitNotification()} is {@code true}.

getCanonicalUnitNotificationSessionForCatalogue

CanonicalUnitNotificationSession getCanonicalUnitNotificationSessionForCatalogue(CanonicalUnitReceiver canonicalUnitReceiver,
 Id catalogueId,
 Proxy proxy)
                                                                          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

proxy - a proxy

Returns:

a CanonicalUnitNotificationSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - canonicalUnitReceiver, catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitNotification()} and {@code supportsVisibleFederation()} are {@code true}

getCanonicalUnitCatalogueSession

CanonicalUnitCatalogueSession getCanonicalUnitCatalogueSession(Proxy proxy)
                                                        throws OperationFailedException

Gets the session for retrieving canonical unit to catalogue mappings.

Parameters:

proxy - a proxy

Returns:

a CanonicalUnitCatalogueSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitCatalogue() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitCatalogue()} is {@code true}.

getCanonicalUnitCatalogueAssignmentSession

CanonicalUnitCatalogueAssignmentSession getCanonicalUnitCatalogueAssignmentSession(Proxy proxy)
                                                                            throws OperationFailedException

Gets the session for assigning canonical unit to catalogue mappings.

Parameters:

proxy - a proxy

Returns:

a CanonicalUnitCatalogueAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitCatalogueAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitCatalogueAssignment()} is {@code true}.

getCanonicalUnitSmartCatalogueSession

CanonicalUnitSmartCatalogueSession getCanonicalUnitSmartCatalogueSession(Id catalogueId,
 Proxy proxy)
                                                                  throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic canonical unit catalogues for the given catalogue.

Parameters:

catalogueId - the Id of a catalogue

proxy - a proxy

Returns:

a CanonicalUnitSmartCatalogueSession

Throws:

NotFoundException - catalogueId not found

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCanonicalUnitSmartCatalogue() is false

Compliance:

optional - This method must be implemented if {@code supportsCanonicalUnitSmartCatalogue()} is {@code true}.

getOfferingLookupSession

OfferingLookupSession getOfferingLookupSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the offering lookup service.

Parameters:

proxy - a proxy

Returns:

an OfferingLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingLookup()} is {@code true}.

getOfferingLookupSessionForCatalogue

OfferingLookupSession getOfferingLookupSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

an OfferingLookupSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingLookup()} and {@code supportsVisibleFederation()} are {@code true}

getOfferingQuerySession

OfferingQuerySession getOfferingQuerySession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the offering query service.

Parameters:

proxy - a proxy

Returns:

an OfferingQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingQuery()} is {@code true}.

getOfferingQuerySessionForCatalogue

OfferingQuerySession getOfferingQuerySessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

an OfferingQuerySession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingQuery()} and {@code supportsVisibleFederation()} are {@code true}

getOfferingSearchSession

OfferingSearchSession getOfferingSearchSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the offering search service.

Parameters:

proxy - a proxy

Returns:

an OfferingSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingSearch()} is {@code true}.

getOfferingSearchSessionForCatalogue

OfferingSearchSession getOfferingSearchSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

an OfferingSearchSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingSearch()} and {@code supportsVisibleFederation()} are {@code true}

getOfferingAdminSession

OfferingAdminSession getOfferingAdminSession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession associated with the offering administration service.

Parameters:

proxy - a proxy

Returns:

an OfferingAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingAdmin()} is {@code true}.

getOfferingAdminSessionForCatalogue

OfferingAdminSession getOfferingAdminSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

an OfferingAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getOfferingNotificationSession

OfferingNotificationSession getOfferingNotificationSession(OfferingReceiver offeringReceiver,
 Proxy proxy)
                                                    throws OperationFailedException

Gets the OsidSession associated with the offering notification service.

Parameters:

offeringReceiver - the receiver

proxy - a proxy

Returns:

an OfferingNotificationSession

Throws:

NullArgumentException - offeringReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingNotification()} is {@code true}.

getOfferingNotificationSessionForCatalogue

OfferingNotificationSession getOfferingNotificationSessionForCatalogue(OfferingReceiver offeringReceiver,
 Id catalogueId,
 Proxy proxy)
                                                                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

proxy - a proxy

Returns:

an OfferingNotificationSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - offeringReceiver, catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingNotification()} and {@code supportsVisibleFederation()} are {@code true}

getOfferingCatalogueSession

OfferingCatalogueSession getOfferingCatalogueSession(Proxy proxy)
                                              throws OperationFailedException

Gets the session for retrieving offering to catalogue mappings.

Parameters:

proxy - a proxy

Returns:

an OfferingCatalogueSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingCatalogue() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingCatalogue()} is {@code true}.

getOfferingCatalogueAssignmentSession

OfferingCatalogueAssignmentSession getOfferingCatalogueAssignmentSession(Proxy proxy)
                                                                  throws OperationFailedException

Gets the session for assigning offering to catalogue mappings.

Parameters:

proxy - a proxy

Returns:

an OfferingCatalogueAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingCatalogueAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingCatalogueAssignment()} is {@code true}.

getOfferingSmartCatalogueSession

OfferingSmartCatalogueSession getOfferingSmartCatalogueSession(Id catalogueId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic offering catalogues for the given catalogue.

Parameters:

catalogueId - the Id of a catalogue

proxy - a proxy

Returns:

an OfferingSmartCatalogueSession

Throws:

NotFoundException - catalogueId not found

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingSmartCatalogue() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingSmartCatalogue()} is {@code true}.

getParticipantLookupSession

ParticipantLookupSession getParticipantLookupSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the participant lookup service.

Parameters:

proxy - a proxy

Returns:

a ParticipantLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantLookup()} is {@code true}.

getParticipantLookupSessionForCatalogue

ParticipantLookupSession getParticipantLookupSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a ParticipantLookupSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantLookup()} and {@code supportsVisibleFederation()} are {@code true}

getParticipantQuerySession

ParticipantQuerySession getParticipantQuerySession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the participant query service.

Parameters:

proxy - a proxy

Returns:

a ParticipantQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantQuery()} is {@code true}.

getParticipantQuerySessionForCatalogue

ParticipantQuerySession getParticipantQuerySessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a ParticipantQuerySession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantQuery()} and {@code supportsVisibleFederation()} are {@code true}

getParticipantSearchSession

ParticipantSearchSession getParticipantSearchSession(Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the participant search service.

Parameters:

proxy - a proxy

Returns:

a ParticipantSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantSearch()} is {@code true}.

getParticipantSearchSessionForCatalogue

ParticipantSearchSession getParticipantSearchSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a ParticipantSearchSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantSearch()} and {@code supportsVisibleFederation()} are {@code true}

getParticipantAdminSession

ParticipantAdminSession getParticipantAdminSession(Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the participant administration service.

Parameters:

proxy - a proxy

Returns:

a ParticipantAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantAdmin()} is {@code true}.

getParticipantAdminSessionForCatalogue

ParticipantAdminSession getParticipantAdminSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a ParticipantAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getParticipantNotificationSession

ParticipantNotificationSession getParticipantNotificationSession(ParticipantReceiver participantReceiver,
 Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with the participant notification service.

Parameters:

participantReceiver - the receiver

proxy - a proxy

Returns:

a ParticipantNotificationSession

Throws:

NullArgumentException - participantReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantNotification()} is {@code true}.

getParticipantNotificationSessionForCatalogue

ParticipantNotificationSession getParticipantNotificationSessionForCatalogue(ParticipantReceiver participantReceiver,
 Id catalogueId,
 Proxy proxy)
                                                                      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

proxy - a proxy

Returns:

a ParticipantNotificationSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - participantReceiver, catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantNotification()} and {@code supportsVisibleFederation()} are {@code true}

getParticipantCatalogueSession

ParticipantCatalogueSession getParticipantCatalogueSession(Proxy proxy)
                                                    throws OperationFailedException

Gets the session for retrieving participant to catalogue mappings.

Parameters:

proxy - a proxy

Returns:

a ParticipantCatalogueSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantCatalogue() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantCatalogue()} is {@code true}.

getParticipantCatalogueAssignmentSession

ParticipantCatalogueAssignmentSession getParticipantCatalogueAssignmentSession(Proxy proxy)
                                                                        throws OperationFailedException

Gets the session for assigning participant to catalogue mappings.

Parameters:

proxy - a proxy

Returns:

a ParticipantCatalogueAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantCatalogueAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantCatalogueAssignment()} is {@code true}.

getParticipantSmartCatalogueSession

ParticipantSmartCatalogueSession getParticipantSmartCatalogueSession(Id catalogueId,
 Proxy proxy)
                                                              throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic participant catalogues for the given catalogue.

Parameters:

catalogueId - the Id of a catalogue

proxy - a proxy

Returns:

a ParticipantSmartCatalogueSession

Throws:

NotFoundException - catalogueId not found

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsParticipantSmartCatalogue() is false

Compliance:

optional - This method must be implemented if {@code supportsParticipantSmartCatalogue()} is {@code true}.

getResultLookupSession

ResultLookupSession getResultLookupSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the result lookup service.

Parameters:

proxy - a proxy

Returns:

a ResultLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsResultLookup()} is {@code true}.

getResultLookupSessionForCatalogue

ResultLookupSession getResultLookupSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a ResultLookupSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultLookup() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResultLookup()} and {@code supportsVisibleFederation()} are {@code true}

getResultQuerySession

ResultQuerySession getResultQuerySession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the result query service.

Parameters:

proxy - a proxy

Returns:

a ResultQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsResultQuery()} is {@code true}.

getResultQuerySessionForCatalogue

ResultQuerySession getResultQuerySessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a ResultQuerySession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultQuery() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResultQuery()} and {@code supportsVisibleFederation()} are {@code true}

getResultSearchSession

ResultSearchSession getResultSearchSession(Proxy proxy)
                                    throws OperationFailedException

Gets the OsidSession associated with the result search service.

Parameters:

proxy - a proxy

Returns:

a ResultSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsResultSearch()} is {@code true}.

getResultSearchSessionForCatalogue

ResultSearchSession getResultSearchSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a ResultSearchSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultSearch() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResultSearch()} and {@code supportsVisibleFederation()} are {@code true}

getResultAdminSession

ResultAdminSession getResultAdminSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the result administration service.

Parameters:

proxy - a proxy

Returns:

a ResultAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsResultAdmin()} is {@code true}.

getResultAdminSessionForCatalogue

ResultAdminSession getResultAdminSessionForCatalogue(Id catalogueId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

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

Parameters:

catalogueId - the Id of the Catalogue

proxy - a proxy

Returns:

a ResultAdminSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultAdmin() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResultAdmin()} and {@code supportsVisibleFederation()} are {@code true}

getResultNotificationSession

ResultNotificationSession getResultNotificationSession(ResultReceiver resultReceiver,
 Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the result notification service.

Parameters:

resultReceiver - the receiver

proxy - a proxy

Returns:

a ResultNotificationSession

Throws:

NullArgumentException - resultReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsResultNotification()} is {@code true}.

getResultNotificationSessionForCatalogue

ResultNotificationSession getResultNotificationSessionForCatalogue(ResultReceiver resultReceiver,
 Id catalogueId,
 Proxy proxy)
                                                            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

proxy - a proxy

Returns:

a ResultNotificationSession

Throws:

NotFoundException - no Catalogue found by the given Id

NullArgumentException - resultReceiver, catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultNotification() or supportsVisibleFederation() is false

Compliance:

optional - This method must be implemented if {@code supportsResultNotification()} and {@code supportsVisibleFederation()} are {@code true}

getResultCatalogueSession

ResultCatalogueSession getResultCatalogueSession(Proxy proxy)
                                          throws OperationFailedException

Gets the session for retrieving result to catalogue mappings.

Parameters:

proxy - a proxy

Returns:

a ResultCatalogueSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultCatalogue() is false

Compliance:

optional - This method must be implemented if {@code supportsResultCatalogue()} is {@code true}.

getResultCatalogueAssignmentSession

ResultCatalogueAssignmentSession getResultCatalogueAssignmentSession(Proxy proxy)
                                                              throws OperationFailedException

Gets the session for assigning result to catalogue mappings.

Parameters:

proxy - a proxy

Returns:

a ResultCatalogueAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultCatalogueAssignment() is false

Compliance:

optional - This method must be implemented if {@code supportsResultCatalogueAssignment()} is {@code true}.

getResultSmartCatalogueSession

ResultSmartCatalogueSession getResultSmartCatalogueSession(Id catalogueId,
 Proxy proxy)
                                                    throws NotFoundException,
OperationFailedException

Gets the session for managing dynamic result catalogues for the given catalogue.

Parameters:

catalogueId - the Id of a catalogue

proxy - a proxy

Returns:

a ResultSmartCatalogueSession

Throws:

NotFoundException - catalogueId not found

NullArgumentException - catalogueId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsResultSmartCatalogue() is false

Compliance:

optional - This method must be implemented if {@code supportsResultSmartCatalogue()} is {@code true}.

getCatalogueLookupSession

CatalogueLookupSession getCatalogueLookupSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the catalogue lookup service.

Parameters:

proxy - a proxy

Returns:

a CatalogueLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueLookup() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogueLookup()} is {@code true}.

getCatalogueQuerySession

CatalogueQuerySession getCatalogueQuerySession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the catalogue query service.

Parameters:

proxy - a proxy

Returns:

a CatalogueQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogueQuery()} is {@code true}.

getCatalogueSearchSession

CatalogueSearchSession getCatalogueSearchSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the catalogue search service.

Parameters:

proxy - a proxy

Returns:

a CatalogueSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueSearch() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogueSearch()} is {@code true}.

getCatalogueAdminSession

CatalogueAdminSession getCatalogueAdminSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the catalogue administrative service.

Parameters:

proxy - a proxy

Returns:

a CatalogueAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueAdmin() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogueAdmin()} is {@code true}.

getCatalogueNotificationSession

CatalogueNotificationSession getCatalogueNotificationSession(CatalogueReceiver catalogueReceiver,
 Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the catalogue notification service.

Parameters:

catalogueReceiver - the receiver

proxy - a proxy

Returns:

a CatalogueNotificationSession

Throws:

NullArgumentException - catalogueReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueNotification() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogueNotification()} is {@code true}.

getCatalogueHierarchySession

CatalogueHierarchySession getCatalogueHierarchySession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the catalogue hierarchy service.

Parameters:

proxy - a proxy

Returns:

a CatalogueHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueHierarchy() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogueHierarchy()} is {@code true}.

getCatalogueHierarchyDesignSession

CatalogueHierarchyDesignSession getCatalogueHierarchyDesignSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the catalogue hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a CatalogueHierarchyDesignSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsCatalogueHierarchyDesign() is false

Compliance:

optional - This method must be implemented if {@code supportsCatalogueHierarchyDesign()} is {@code true}.

getOfferingBatchProxyManager

OfferingBatchProxyManager getOfferingBatchProxyManager()
                                                throws OperationFailedException

Gets an OfferingBatchProxyManager.

Returns:

an OfferingBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingBatch() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingBatch()} is {@code true}.

getOfferingRulesProxyManager

OfferingRulesProxyManager getOfferingRulesProxyManager()
                                                throws OperationFailedException

Gets an OfferingRulesProxyManager.

Returns:

an OfferingRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsOfferingRules() is false

Compliance:

optional - This method must be implemented if {@code supportsOfferingRules()} is {@code true}.