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.
Modifier and Type | Method and 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 a
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 a
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.
|
changeBranch, initialize, rollbackService
close
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
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
CanonicalUnitLookupSession getCanonicalUnitLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the canonical unit
lookup service.proxy
- a proxy CanonicalUnitLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitLookup()
is false
optional
- This method must be implemented if
supportsCanonicalUnitLookup()
is true.
CanonicalUnitLookupSession getCanonicalUnitLookupSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the canonical unit
lookup service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy CanonicalUnitLookupSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCanonicalUnitLookup()
and
supportsVisibleFederation()
are true
CanonicalUnitQuerySession getCanonicalUnitQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the canonical unit
query service.proxy
- a proxy CanonicalUnitQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitQuery()
is false
optional
- This method must be implemented if
supportsCanonicalUnitQuery()
is true.
CanonicalUnitQuerySession getCanonicalUnitQuerySessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the canonical unit
query service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy CanonicalUnitQuerySession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCanonicalUnitQuery()
and
supportsVisibleFederation()
are true
CanonicalUnitSearchSession getCanonicalUnitSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the canonical unit
search service.proxy
- a proxy CanonicalUnitSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitSearch()
is false
optional
- This method must be implemented if
supportsCanonicalUnitSearch()
is true.
CanonicalUnitSearchSession getCanonicalUnitSearchSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the canonical unit
search service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy CanonicalUnitSearchSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCanonicalUnitSearch()
and
supportsVisibleFederation()
are true
CanonicalUnitAdminSession getCanonicalUnitAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the canonical unit
administration service.proxy
- a proxy CanonicalUnitAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitAdmin()
is false
optional
- This method must be implemented if
supportsCanonicalUnitAdmin()
is true.
CanonicalUnitAdminSession getCanonicalUnitAdminSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the canonical unit
administration service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy CanonicalUnitAdminSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCanonicalUnitAdmin()
and
supportsVisibleFederation()
are true
CanonicalUnitNotificationSession getCanonicalUnitNotificationSession(CanonicalUnitReceiver canonicalUnitReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the canonical unit
notification service.canonicalUnitReceiver
- the receiverproxy
- a proxy CanonicalUnitNotificationSession
NullArgumentException
- canonicalUnitReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitNotification()
is false
optional
- This method must be implemented if
supportsCanonicalUnitNotification()
is
true.
CanonicalUnitNotificationSession getCanonicalUnitNotificationSessionForCatalogue(CanonicalUnitReceiver canonicalUnitReceiver, Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the canonical unit
notification service for the given catalogue.canonicalUnitReceiver
- the receivercatalogueId
- the Id
of the Catalogue
proxy
- a proxy CanonicalUnitNotificationSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- canonicalUnitReceiver,
catalogueId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsCanonicalUnitNotification()
and
supportsVisibleFederation()
are true
CanonicalUnitCatalogueSession getCanonicalUnitCatalogueSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy CanonicalUnitCatalogueSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitCatalogue()
is false
optional
- This method must be implemented if
supportsCanonicalUnitCatalogue()
is true.
CanonicalUnitCatalogueAssignmentSession getCanonicalUnitCatalogueAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy CanonicalUnitCatalogueAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitCatalogueAssignment()
is
false
optional
- This method must be implemented if
supportsCanonicalUnitCatalogueAssignment()
is
true.
CanonicalUnitSmartCatalogueSession getCanonicalUnitSmartCatalogueSession(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
catalogueId
- the Id
of a catalogueproxy
- a proxy CanonicalUnitSmartCatalogueSession
NotFoundException
- catalogueId
not
foundNullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCanonicalUnitSmartCatalogue()
is false
optional
- This method must be implemented if
supportsCanonicalUnitSmartCatalogue()
is
true.
OfferingLookupSession getOfferingLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the offering
lookup service.proxy
- a proxy OfferingLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfferingLookup()
is false
optional
- This method must be implemented if
supportsOfferingLookup()
is true.
OfferingLookupSession getOfferingLookupSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the offering
lookup service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy OfferingLookupSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfferingLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsOfferingLookup()
and
supportsVisibleFederation()
are true
OfferingQuerySession getOfferingQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the offering query
service.proxy
- a proxy OfferingQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsOfferingQuery()
is false
optional
- This method must be implemented if
supportsOfferingQuery()
is true.
OfferingQuerySession getOfferingQuerySessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the offering query
service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy OfferingQuerySession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsOfferingQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsOfferingQuery()
and
supportsVisibleFederation()
are true
OfferingSearchSession getOfferingSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the offering
search service.proxy
- a proxy OfferingSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfferingSearch()
is false
optional
- This method must be implemented if
supportsOfferingSearch()
is true.
OfferingSearchSession getOfferingSearchSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the offering
search service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy OfferingSearchSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfferingSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsOfferingSearch()
and
supportsVisibleFederation()
are true
OfferingAdminSession getOfferingAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the offering
administration service.proxy
- a proxy OfferingAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsOfferingAdmin()
is false
optional
- This method must be implemented if
supportsOfferingAdmin()
is true.
OfferingAdminSession getOfferingAdminSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the offering
administration service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy OfferingAdminSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsOfferingAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsOfferingAdmin()
and
supportsVisibleFederation()
are true
OfferingNotificationSession getOfferingNotificationSession(OfferingReceiver offeringReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the offering
notification service.offeringReceiver
- the receiverproxy
- a proxy OfferingNotificationSession
NullArgumentException
- offeringReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfferingNotification()
is false
optional
- This method must be implemented if
supportsOfferingNotification()
is true.
OfferingNotificationSession getOfferingNotificationSessionForCatalogue(OfferingReceiver offeringReceiver, Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the offering
notification service for the given catalogue.offeringReceiver
- the receivercatalogueId
- the Id
of the Catalogue
proxy
- a proxy OfferingNotificationSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- offeringReceiver,
catalogueId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfferingNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsOfferingNotification()
and
supportsVisibleFederation()
are true
OfferingCatalogueSession getOfferingCatalogueSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy OfferingCatalogueSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfferingCatalogue()
is false
optional
- This method must be implemented if
supportsOfferingCatalogue()
is true.
OfferingCatalogueAssignmentSession getOfferingCatalogueAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy OfferingCatalogueAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfferingCatalogueAssignment()
is false
optional
- This method must be implemented if
supportsOfferingCatalogueAssignment()
is
true.
OfferingSmartCatalogueSession getOfferingSmartCatalogueSession(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
catalogueId
- the Id
of a catalogueproxy
- a proxy OfferingSmartCatalogueSession
NotFoundException
- catalogueId
not
foundNullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOfferingSmartCatalogue()
is false
optional
- This method must be implemented if
supportsOfferingSmartCatalogue()
is true.
ParticipantLookupSession getParticipantLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the participant
lookup service.proxy
- a proxy ParticipantLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantLookup()
is false
optional
- This method must be implemented if
supportsParticipantLookup()
is true.
ParticipantLookupSession getParticipantLookupSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the participant
lookup service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy ParticipantLookupSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantLookup()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsParticipantLookup()
and
supportsVisibleFederation()
are true
ParticipantQuerySession getParticipantQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the participant
query service.proxy
- a proxy ParticipantQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantQuery()
is false
optional
- This method must be implemented if
supportsParticipantQuery()
is true.
ParticipantQuerySession getParticipantQuerySessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the participant
query service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy ParticipantQuerySession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantQuery()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsParticipantQuery()
and
supportsVisibleFederation()
are true
ParticipantSearchSession getParticipantSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the participant
search service.proxy
- a proxy ParticipantSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantSearch()
is false
optional
- This method must be implemented if
supportsParticipantSearch()
is true.
ParticipantSearchSession getParticipantSearchSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the participant
search service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy ParticipantSearchSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantSearch()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsParticipantSearch()
and
supportsVisibleFederation()
are true
ParticipantAdminSession getParticipantAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the participant
administration service.proxy
- a proxy ParticipantAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantAdmin()
is false
optional
- This method must be implemented if
supportsParticipantAdmin()
is true.
ParticipantAdminSession getParticipantAdminSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the participant
administration service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy ParticipantAdminSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantAdmin()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsParticipantAdmin()
and
supportsVisibleFederation()
are true
ParticipantNotificationSession getParticipantNotificationSession(ParticipantReceiver participantReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the participant
notification service.participantReceiver
- the receiverproxy
- a proxy ParticipantNotificationSession
NullArgumentException
- participantReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantNotification()
is false
optional
- This method must be implemented if
supportsParticipantNotification()
is true.
ParticipantNotificationSession getParticipantNotificationSessionForCatalogue(ParticipantReceiver participantReceiver, Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the participant
notification service for the given catalogue.participantReceiver
- the receivercatalogueId
- the Id
of the Catalogue
proxy
- a proxy ParticipantNotificationSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- participantReceiver,
catalogueId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsParticipantNotification()
and
supportsVisibleFederation()
are true
ParticipantCatalogueSession getParticipantCatalogueSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ParticipantCatalogueSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantCatalogue()
is false
optional
- This method must be implemented if
supportsParticipantCatalogue()
is true.
ParticipantCatalogueAssignmentSession getParticipantCatalogueAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ParticipantCatalogueAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantCatalogueAssignment()
is
false
optional
- This method must be implemented if
supportsParticipantCatalogueAssignment()
is
true.
ParticipantSmartCatalogueSession getParticipantSmartCatalogueSession(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
catalogueId
- the Id
of a catalogueproxy
- a proxy ParticipantSmartCatalogueSession
NotFoundException
- catalogueId
not
foundNullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsParticipantSmartCatalogue()
is false
optional
- This method must be implemented if
supportsParticipantSmartCatalogue()
is
true.
ResultLookupSession getResultLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the result lookup
service.proxy
- a proxy ResultLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsResultLookup()
is false
optional
- This method must be implemented if
supportsResultLookup()
is true.
ResultLookupSession getResultLookupSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the result lookup
service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy ResultLookupSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsResultLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsResultLookup()
and
supportsVisibleFederation()
are true
ResultQuerySession getResultQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the result query
service.proxy
- a proxy ResultQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsResultQuery()
is false
optional
- This method must be implemented if
supportsResultQuery()
is true.
ResultQuerySession getResultQuerySessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the result query
service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy ResultQuerySession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsResultQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsResultQuery()
and
supportsVisibleFederation()
are true
ResultSearchSession getResultSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the result search
service.proxy
- a proxy ResultSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsResultSearch()
is false
optional
- This method must be implemented if
supportsResultSearch()
is true.
ResultSearchSession getResultSearchSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the result search
service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy ResultSearchSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsResultSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsResultSearch()
and
supportsVisibleFederation()
are true
ResultAdminSession getResultAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the result
administration service.proxy
- a proxy ResultAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsResultAdmin()
is false
optional
- This method must be implemented if
supportsResultAdmin()
is true.
ResultAdminSession getResultAdminSessionForCatalogue(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the result
administration service for the given catalogue.catalogueId
- the Id
of the Catalogue
proxy
- a proxy ResultAdminSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsResultAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsResultAdmin()
and
supportsVisibleFederation()
are true
ResultNotificationSession getResultNotificationSession(ResultReceiver resultReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the result
notification service.resultReceiver
- the receiverproxy
- a proxy ResultNotificationSession
NullArgumentException
- resultReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResultNotification()
is false
optional
- This method must be implemented if
supportsResultNotification()
is true.
ResultNotificationSession getResultNotificationSessionForCatalogue(ResultReceiver resultReceiver, Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the result
notification service for the given catalogue.resultReceiver
- the receivercatalogueId
- the Id
of the Catalogue
proxy
- a proxy ResultNotificationSession
NotFoundException
- no Catalogue
found
by the given Id
NullArgumentException
- resultReceiver,
catalogueId
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResultNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsResultNotification()
and
supportsVisibleFederation()
are true
ResultCatalogueSession getResultCatalogueSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ResultCatalogueSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResultCatalogue()
is false
optional
- This method must be implemented if
supportsResultCatalogue()
is true.
ResultCatalogueAssignmentSession getResultCatalogueAssignmentSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy ResultCatalogueAssignmentSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResultCatalogueAssignment()
is false
optional
- This method must be implemented if
supportsResultCatalogueAssignment()
is
true.
ResultSmartCatalogueSession getResultSmartCatalogueSession(Id catalogueId, Proxy proxy) throws NotFoundException, OperationFailedException
catalogueId
- the Id
of a catalogueproxy
- a proxy ResultSmartCatalogueSession
NotFoundException
- catalogueId
not
foundNullArgumentException
- catalogueId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsResultSmartCatalogue()
is false
optional
- This method must be implemented if
supportsResultSmartCatalogue()
is true.
CatalogueLookupSession getCatalogueLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalogue
lookup service.proxy
- a proxy CatalogueLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogueLookup()
is false
optional
- This method must be implemented if
supportsCatalogueLookup()
is true.
CatalogueQuerySession getCatalogueQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalogue
query service.proxy
- a proxy CatalogueQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogueQuery()
is false
optional
- This method must be implemented if
supportsCatalogueQuery()
is true.
CatalogueSearchSession getCatalogueSearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalogue
search service.proxy
- a proxy CatalogueSearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogueSearch()
is false
optional
- This method must be implemented if
supportsCatalogueSearch()
is true.
CatalogueAdminSession getCatalogueAdminSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalogue
administrative service.proxy
- a proxy CatalogueAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogueAdmin()
is false
optional
- This method must be implemented if
supportsCatalogueAdmin()
is true.
CatalogueNotificationSession getCatalogueNotificationSession(CatalogueReceiver catalogueReceiver, Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalogue
notification service.catalogueReceiver
- the receiverproxy
- a proxy CatalogueNotificationSession
NullArgumentException
- catalogueReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogueNotification()
is false
optional
- This method must be implemented if
supportsCatalogueNotification()
is true.
CatalogueHierarchySession getCatalogueHierarchySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalogue
hierarchy service.proxy
- a proxy CatalogueHierarchySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogueHierarchy()
is false
optional
- This method must be implemented if
supportsCatalogueHierarchy()
is true.
CatalogueHierarchyDesignSession getCatalogueHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the catalogue
hierarchy design service.proxy
- a proxy CatalogueHierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsCatalogueHierarchyDesign()
is false
optional
- This method must be implemented if
supportsCatalogueHierarchyDesign()
is true.
OfferingBatchProxyManager getOfferingBatchProxyManager() throws OperationFailedException
OfferingBatchProxyManager.
OfferingBatchProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsOfferingBatch()
is false
optional
- This method must be implemented if
supportsOfferingBatch()
is true.
OfferingRulesProxyManager getOfferingRulesProxyManager() throws OperationFailedException
OfferingRulesProxyManager.
OfferingRulesProxyManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsOfferingRules()
is false
optional
- This method must be implemented if
supportsOfferingRules()
is true.