Interface SequencingProxyManager
- All Superinterfaces:
AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, SequencingProfile, Sourceable
The sequencing proxy manager provides access to sequencing sessions and
provides interoperability tests for various aspects of this service.
Methods in this manager pass a Proxy for passing information from
server environments. The sessions included in this manager are:
-
ElementLookupSession: a session for retrieving elements in a chain -
ElementAdminSession: a session for managing elements in a chain -
SequencingSession: a session for sequencing elements in a chain -
ChainLookupSession: a session to retrieve chains -
ChainQuerySession: a session to query for chains -
ChainSearchSession: a session to search for chains -
ChainAdminSession: a session to create and delete chains -
ChainNotificationSession: a session to receive notifications pertaining to chain changes -
ChainAntimatroidsSession: a session to look up chain antimatroids mappings -
ChainAntimatroidAssignmentSession: a session to manage chain to antimatroid mappings -
ChainSmartAntimatroidSession: a session to manage dynamic antimatroids of chains
-
AntimatroidLookupSession: a session to retrieve antimatroids -
AntimatroidQuerySession: a session to search for antimatroids -
AntimatroidSearchSession: a session to search for antimatroids -
AntimatroidAdminSession: a session to create and delete antimatroids -
AntimatroidNotificationSession: a session to receive notifications pertaining to antimatroid changes -
AntimatroidHierarchySession: a session to traverse a hierarchy of antimatroid -
AntimatroidHierarchyDesignSession: a session to manage an antimatroid hierarchy
-
Method Summary
Modifier and TypeMethodDescriptiongetAntimatroidAdminSession(Proxy proxy) Gets theOsidSessionassociated with the antimatroid administrative service.Gets theOsidSessionassociated with the antimatroid hierarchy design service.Gets theOsidSessionassociated with the antimatroid hierarchy service.getAntimatroidLookupSession(Proxy proxy) Gets theOsidSessionassociated with the antimatroid lookup service.getAntimatroidNotificationSession(AntimatroidReceiver antimatroidReceiver, Proxy proxy) Gets theOsidSessionassociated with the antimatroid notification service.getAntimatroidQuerySession(Proxy proxy) Gets theOsidSessionassociated with the antimatroid query service.getAntimatroidSearchSession(Proxy proxy) Gets theOsidSessionassociated with the antimatroid search service.getChainAdminSession(Proxy proxy) Gets theOsidSessionassociated with the chain administration service.getChainAdminSessionForInput(Id inputId, Proxy proxy) Gets theOsidSessionassociated with the chain administration service for the given input.Gets theOsidSessionassociated with assigning chains to antimatroids.getChainAntimatroidSession(Proxy proxy) Gets theOsidSessionto lookup chain/antimatroid mappings.getChainLookupSession(Proxy proxy) Gets theOsidSessionassociated with the chain lookup service.getChainLookupSessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets theOsidSessionassociated with the chain lookup service for the given antimatroid.getChainNotificationSession(ChainReceiver chainReceiver, Proxy proxy) Gets theOsidSessionassociated with the chain notification service.getChainNotificationSessionForAntimatroid(ChainReceiver chainReceiver, Id antimatroidId, Proxy proxy) Gets theOsidSessionassociated with the chain notification service for the given antimatroid.getChainQuerySession(Proxy proxy) Gets theOsidSessionassociated with the chain query service.getChainQuerySessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets theOsidSessionassociated with the chain query service for the given antimatroid.getChainSearchSession(Proxy proxy) Gets theOsidSessionassociated with the chain search service.getChainSearchSessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets theOsidSessionassociated with the chain search service for the given antimatroid.getChainSmartAntimatroidSession(Id antimatroidId, Proxy proxy) Gets theOsidSessionto manage locatin smart antimatroids.getElementAdminSession(Proxy proxy) Gets theOsidSessionassociated with the element admin service.getElementAdminSessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets theOsidSessionassociated with the element admin service for the given antimatroid.getElementLookupSession(Proxy proxy) Gets theOsidSessionassociated with the element lookup service.getElementLookupSessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets theOsidSessionassociated with the element lookup service for the given antimatroid.getSequencingSession(Proxy proxy) Gets theOsidSessionassociated with the element sequencing service.getSequencingSessionForAntimatroid(Id antimatroidId, Proxy proxy) Gets theOsidSessionassociated with the element sequencing service for the given antimatroid.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface SequencingProfile
getAntimatroidRecordTypes, getAntimatroidSearchRecordTypes, getChainRecordTypes, getChainSearchRecordTypes, supportsAntimatroidAdmin, supportsAntimatroidHierarchy, supportsAntimatroidHierarchyDesign, supportsAntimatroidLookup, supportsAntimatroidNotification, supportsAntimatroidQuery, supportsAntimatroidRecordType, supportsAntimatroidSearch, supportsAntimatroidSearchRecordType, supportsChainAdmin, supportsChainAntimatroid, supportsChainAntimatroidAssignment, supportsChainLookup, supportsChainNotification, supportsChainQuery, supportsChainRecordType, supportsChainSearch, supportsChainSearchRecordType, supportsChainSmartAntimatroid, supportsElementAdmin, supportsElementLookup, supportsSequencing, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedAntimatroidrecord types.Gets the supportedAntimatroidsearch record types.Gets the supportedChainrecord types.Gets the supportedChainsearch types.booleanTests if antimatroid administrative service is supported.booleanTests for the availability of an antimatroid hierarchy traversal service.booleanTests for the availability of an antimatroid hierarchy design service.booleanTests if looking up antimatroids is supported.booleanTests if an antimatroid notification service is supported.booleanTests if querying antimatroids is supported.booleansupportsAntimatroidRecordType(Type antimatroidRecordType) Tests if the givenAntimatroidrecord type is supported.booleanTests if searching antimatroids is supported.booleansupportsAntimatroidSearchRecordType(Type antimatroidSearchRecordType) Tests if the givenAntimatroidsearch record type is supported.booleanTests if chain administrative service is supported.booleanTests if a chain antimatroid lookup service is supported.booleanTests if a chain antimatroid assignment service is supported.booleanTests if looking up chains is supported.booleanTests if a chain notification service is supported.booleanTests if querying chains is supported.booleansupportsChainRecordType(Type chainRecordType) Tests if the givenChainrecord type is supported.booleanTests if searching chains is supported.booleansupportsChainSearchRecordType(Type chainSearchRecordType) Tests if the givenChainsearch type is supported.booleanTests if a chain smart antimatroid service is supported.booleanTests if managing elements is supported.booleanTests if looking up elements is supported.booleanTests if sequencing elements is supported.booleanTests if any action group federation is exposed.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
getElementLookupSession
Gets theOsidSessionassociated with the element lookup service.- Parameters:
proxy- a proxy- Returns:
- an
ElementLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsElementLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsElementLookup()} is {@code true} .
-
getElementLookupSessionForAntimatroid
ElementLookupSession getElementLookupSessionForAntimatroid(Id antimatroidId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the element lookup service for the given antimatroid.- Parameters:
antimatroidId- theIdof the antimatroidproxy- a proxy- Returns:
- an
ElementLookupSession - Throws:
NotFoundException- noAntimatroidfound by the givenIdNullArgumentException-antimatroidId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsElementLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsElementLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getElementAdminSession
Gets theOsidSessionassociated with the element admin service.- Parameters:
proxy- a proxy- Returns:
- an
ElementAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsElementAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsElementAdmin()} is {@code true} .
-
getElementAdminSessionForAntimatroid
ElementAdminSession getElementAdminSessionForAntimatroid(Id antimatroidId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the element admin service for the given antimatroid.- Parameters:
antimatroidId- theIdof the antimatroidproxy- a proxy- Returns:
- an
ElementAdminSession - Throws:
NotFoundException- noAntimatroidfound by the givenIdNullArgumentException-antimatroidId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsElementAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsElementAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getSequencingSession
Gets theOsidSessionassociated with the element sequencing service.- Parameters:
proxy- a proxy- Returns:
- a
SequencingSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSequencingn()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequencing()} is {@code true} .
-
getSequencingSessionForAntimatroid
SequencingSession getSequencingSessionForAntimatroid(Id antimatroidId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the element sequencing service for the given antimatroid.- Parameters:
antimatroidId- theIdof the antimatroidproxy- a proxy- Returns:
- a
SequencingSession - Throws:
NotFoundException- noAntimatroidfound by the givenIdNullArgumentException-antimatroidId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsSequencing()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSequencing()} and {@code supportsVisibleFederation()} are {@code true}
-
getChainLookupSession
Gets theOsidSessionassociated with the chain lookup service.- Parameters:
proxy- a proxy- Returns:
- a
ChainLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChainLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainLookup()} is {@code true} .
-
getChainLookupSessionForAntimatroid
ChainLookupSession getChainLookupSessionForAntimatroid(Id antimatroidId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the chain lookup service for the given antimatroid.- Parameters:
antimatroidId- theIdof the antimatroidproxy- a proxy- Returns:
- a
ChainLookupSession - Throws:
NotFoundException- noAntimatroidfound by the givenIdNullArgumentException-antimatroidId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsChainLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainLookup()} and {@code supportsVisibleFederation()} are {@code true} .
-
getChainQuerySession
Gets theOsidSessionassociated with the chain query service.- Parameters:
proxy- a proxy- Returns:
- a
ChainQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChainQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainQuery()} is {@code true} .
-
getChainQuerySessionForAntimatroid
ChainQuerySession getChainQuerySessionForAntimatroid(Id antimatroidId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the chain query service for the given antimatroid.- Parameters:
antimatroidId- theIdof theAntimatroidproxy- a proxy- Returns:
- a
ChainQuerySession - Throws:
NotFoundException- no antimatroid found by the givenIdNullArgumentException-antimatroidId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsChainQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainQuery()} and {@code supportsVisibleFederation()} are {@code true} .
-
getChainSearchSession
Gets theOsidSessionassociated with the chain search service.- Parameters:
proxy- a proxy- Returns:
- a
ChainSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChainSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainSearch()} is {@code true} .
-
getChainSearchSessionForAntimatroid
ChainSearchSession getChainSearchSessionForAntimatroid(Id antimatroidId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the chain search service for the given antimatroid.- Parameters:
antimatroidId- theIdof theAntimatroidproxy- a proxy- Returns:
- a
ChainSearchSession - Throws:
NotFoundException- no antimatroid found by the givenIdNullArgumentException-antimatroidId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsChainSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainSearch()} and {@code supportsVisibleFederation()} are {@code true} .
-
getChainAdminSession
Gets theOsidSessionassociated with the chain administration service.- Parameters:
proxy- a proxy- Returns:
- a
ChainAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChainAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainAdmin()} is {@code true} .
-
getChainAdminSessionForInput
ChainAdminSession getChainAdminSessionForInput(Id inputId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the chain administration service for the given input.- Parameters:
inputId- theIdof theInputproxy- a proxy- Returns:
- a
ChainAdminSession - Throws:
NotFoundException- no input found by the givenIdNullArgumentException-inputId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsChainAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainAdmin()} and {@code supportsVisibleFederation()} are {@code true} .
-
getChainNotificationSession
ChainNotificationSession getChainNotificationSession(ChainReceiver chainReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the chain notification service.- Parameters:
chainReceiver- the notification callbackproxy- a proxy- Returns:
- a
ChainNotificationSession - Throws:
NullArgumentException-chainReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChainNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainNotification()} is {@code true} .
-
getChainNotificationSessionForAntimatroid
ChainNotificationSession getChainNotificationSessionForAntimatroid(ChainReceiver chainReceiver, Id antimatroidId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the chain notification service for the given antimatroid.- Parameters:
chainReceiver- the notification callbackantimatroidId- theIdof theAntimatroidproxy- a proxy- Returns:
- a
ChainNotificationSession - Throws:
NotFoundException- no antimatroid found by the givenIdNullArgumentException-chainReceiver,antimatroidIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChainNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainNotification()} and {@code supportsVisibleFederation()} are {@code true} .
-
getChainAntimatroidSession
Gets theOsidSessionto lookup chain/antimatroid mappings.- Parameters:
proxy- a proxy- Returns:
- a
ChainAntimatroidSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChainAntimatroid()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainAntimatroid()} is {@code true} .
-
getChainAntimatroidAssignmentSession
ChainAntimatroidAssignmentSession getChainAntimatroidAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning chains to antimatroids.- Parameters:
proxy- a proxy- Returns:
- a
ChainAntimatroidAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsChainAntimatroidAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainAntimatroidAssignment()} is {@code true} .
-
getChainSmartAntimatroidSession
ChainSmartAntimatroidSession getChainSmartAntimatroidSession(Id antimatroidId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage locatin smart antimatroids.- Parameters:
antimatroidId- theIdof theAntimatroidproxy- a proxy- Returns:
- a
ChainSmartAntimatroidSession - Throws:
NotFoundException- no antimatroid found by the givenIdNullArgumentException-antimatroidId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsChainSmartAntimatroid()isfalse- Compliance:
optional- This method must be implemented if {@code supportsChainSmartAntimatroid()} is {@code true} .
-
getAntimatroidLookupSession
Gets theOsidSessionassociated with the antimatroid lookup service.- Parameters:
proxy- a proxy- Returns:
- an
AntimatroidLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAntimatroidLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAntimatroidLookup()} is {@code true} .
-
getAntimatroidQuerySession
Gets theOsidSessionassociated with the antimatroid query service.- Parameters:
proxy- a proxy- Returns:
- an
AntimatroidQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAntimatroidQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAntimatroidQuery()} is {@code true} .
-
getAntimatroidSearchSession
Gets theOsidSessionassociated with the antimatroid search service.- Parameters:
proxy- a proxy- Returns:
- an
AntimatroidSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAntimatroidSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAntimatroidSearch()} is {@code true} .
-
getAntimatroidAdminSession
Gets theOsidSessionassociated with the antimatroid administrative service.- Parameters:
proxy- a proxy- Returns:
- an
AntimatroidAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAntimatroidAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAntimatroidAdmin()} is {@code true} .
-
getAntimatroidNotificationSession
AntimatroidNotificationSession getAntimatroidNotificationSession(AntimatroidReceiver antimatroidReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the antimatroid notification service.- Parameters:
antimatroidReceiver- the notification callbackproxy- a proxy- Returns:
- an
AntimatroidNotificationSession - Throws:
NullArgumentException-antimatroidReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAntimatroidNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAntimatroidNotification()} is {@code true} .
-
getAntimatroidHierarchySession
AntimatroidHierarchySession getAntimatroidHierarchySession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the antimatroid hierarchy service.- Parameters:
proxy- a proxy- Returns:
- an
AntimatroidHierarchySessionfor antimatroids - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAntimatroidHierarchy()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAntimatroidHierarchy()} is {@code true} .
-
getAntimatroidHierarchyDesignSession
AntimatroidHierarchyDesignSession getAntimatroidHierarchyDesignSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the antimatroid hierarchy design service.- Parameters:
proxy- a proxy- Returns:
- an
HierarchyDesignSessionfor antimatroids - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsAntimatroidHierarchyDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsAntimatroidHierarchyDesign()} is {@code true} .
-