public interface HoldManager extends OsidManager, HoldProfile
The hold manager provides access to rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:
BlockSession:
a session for checking for blocks
MyHoldSession:
a session for looking up holds for
the authenticated agent BlockLookupSession:
a session to retrieve blocks
BlockQuerySession:
a session to query for blocks
BlockSearchSession:
a session to search for blocks
BlockAdminSession:
a session to create and delete
blocks BlockNotificationSession:
a session to receive
notifications pertaining to block changes BlockOublietteSession:
a session to looking
mappings of blocks to oubliettes BlockOublietteAssignmentSession:
a session to
manage block to oubliette mappings BlockOublietteAssignmentSession:
a session to
manage dynamic oubliettes of blocks IssueLookupSession:
a session to retrieve issues
IssueQuerySession:
a session to query for issues
IssueSearchSession:
a session to search for issues
IssueAdminSession:
a session to create and delete
issues IssueNotificationSession:
a session to receive
notifications pertaining to issue changes IssueOublietteSession:
a session to look up issue
oubliette mappings IssueOublietteAssignmentSession:
a session to
manage issue to oubliette mappings IssueSmartOublietteSession:
a session to manage
dynamic oubliettes of issues HoldLookupSession:
a session to retrieve holds
HoldQuerySession:
a session to query for holds
HoldSearchSession:
a session to search for holds
HoldAdminSession:
a session to create and delete
holds HoldNotificationSession:
a session to receive
notifications pertaining to hold changes HoldOublietteSession:
a session to look up hol
oubliette mappings HoldOublietteAssignmentSession:
a session to
manage hold to oubliette mappings HoldSmartOublietteSession:
a session to manage
dynamic oubliettes of holds OublietteLookupSession:
a session to retrieve
oubliettes OublietteQuerySession:
a session to search for
oubliettes OublietteSearchSession:
a session to search for
oubliettes OublietteAdminSession:
a session to create and
delete oubliettes OublietteNotificationSession:
a session to receive
notifications pertaining to oubliette changes OublietteHierarchySession:
a session to traverse a
hierarchy of oubliette OublietteHierarchyDesignSession:
a session to
manage an oubliette hierarchy Modifier and Type | Method and Description |
---|---|
BlockAdminSession |
getBlockAdminSession()
Gets the
OsidSession associated with the block
administration service. |
BlockAdminSession |
getBlockAdminSessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the block
administration service for the given oubliette. |
BlockLookupSession |
getBlockLookupSession()
Gets the
OsidSession associated with the block lookup
service. |
BlockLookupSession |
getBlockLookupSessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the block lookup
service for the given oubliette. |
BlockNotificationSession |
getBlockNotificationSession(BlockReceiver blockReceiver)
Gets the
OsidSession associated with the block
notification service. |
BlockNotificationSession |
getBlockNotificationSessionForOubliette(BlockReceiver blockReceiver,
Id oublietteId)
Gets the
OsidSession associated with the block
notification service for the given oubliette. |
BlockOublietteAssignmentSession |
getBlockOublietteAssignmentSession()
Gets the
OsidSession associated with assigning blocks
to oubliettes. |
BlockOublietteSession |
getBlockOublietteSession()
Gets the
OsidSession to lookup block/oubliette
mappings. |
BlockQuerySession |
getBlockQuerySession()
Gets the
OsidSession associated with the block query
service. |
BlockQuerySession |
getBlockQuerySessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the block query
service for the given oubliette. |
BlockSearchSession |
getBlockSearchSession()
Gets the
OsidSession associated with the block search
service. |
BlockSearchSession |
getBlockSearchSessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the block search
service for the given oubliette. |
BlockSession |
getBlockSession()
Gets the
OsidSession associated with the block service
to check for blocks. |
BlockSession |
getBlockSessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the block service
for the given oubliette. |
BlockSmartOublietteSession |
getBlockSmartOublietteSession(Id oublietteId)
Gets the
OsidSession to manage block smart oubliettes. |
HoldAdminSession |
getHoldAdminSession()
Gets the
OsidSession associated with the hold
administrative service. |
HoldAdminSession |
getHoldAdminSessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the hold
administrative service for the given oubliette. |
HoldBatchManager |
getHoldBatchManager()
Gets a
HoldBatchManager. |
HoldLookupSession |
getHoldLookupSession()
Gets the
OsidSession associated with the hold lookup
service. |
HoldLookupSession |
getHoldLookupSessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the hold lookup
service for the given oubliette. |
HoldNotificationSession |
getHoldNotificationSession(HoldReceiver holdReceiver)
Gets the
OsidSession associated with the hold
notification service. |
HoldNotificationSession |
getHoldNotificationSessionForOubliette(HoldReceiver holdReceiver,
Id oublietteId)
Gets the
OsidSession associated with the hold
notification service for the given oubliette. |
HoldOublietteAssignmentSession |
getHoldOublietteAssignmentSession()
Gets the
OsidSession associated with assigning
competencies to oubliettes. |
HoldOublietteSession |
getHoldOublietteSession()
Gets the
OsidSession to lookup hold/oubliette mappings. |
HoldQuerySession |
getHoldQuerySession()
Gets the
OsidSession associated with the hold query
service. |
HoldQuerySession |
getHoldQuerySessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the hold query
service for the given oubliette. |
HoldRulesManager |
getHoldRulesManager()
Gets a
HoldRulesManager. |
HoldSearchSession |
getHoldSearchSession()
Gets the
OsidSession associated with the hold search
service. |
HoldSearchSession |
getHoldSearchSessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the hold search
service for the given oubliette. |
HoldSmartOublietteSession |
getHoldSmartOublietteSession(Id oublietteId)
Gets the
OsidSession to manage hold smart oubliettes. |
IssueAdminSession |
getIssueAdminSession()
Gets the
OsidSession associated with the issue
administration service. |
IssueAdminSession |
getIssueAdminSessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the issue
administration service for the given oubliette. |
IssueLookupSession |
getIssueLookupSession()
Gets the
OsidSession associated with the issue lookup
service. |
IssueLookupSession |
getIssueLookupSessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the issue lookup
service for the given oubliette. |
IssueNotificationSession |
getIssueNotificationSession(IssueReceiver issueReceiver)
Gets the
OsidSession associated with the issue
notification service. |
IssueNotificationSession |
getIssueNotificationSessionForOubliette(IssueReceiver issueReceiver,
Id oublietteId)
Gets the
OsidSession associated with the issue
notification service for the given oubliette. |
IssueOublietteAssignmentSession |
getIssueOublietteAssignmentSession()
Gets the
OsidSession associated with assigning issues
to oubliettes. |
IssueOublietteSession |
getIssueOublietteSession()
Gets the
OsidSession to lookup issue/oubliette holds. |
IssueQuerySession |
getIssueQuerySession()
Gets the
OsidSession associated with the issue query
service. |
IssueQuerySession |
getIssueQuerySessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the issue query
service for the given oubliette. |
IssueSearchSession |
getIssueSearchSession()
Gets the
OsidSession associated with the issue search
service. |
IssueSearchSession |
getIssueSearchSessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the issue search
service for the given oubliette. |
IssueSmartOublietteSession |
getIssueSmartOublietteSession(Id oublietteId)
Gets the
OsidSession to manage locatin smart
oubliettes. |
MyHoldSession |
getMyHoldSession()
Gets the
OsidSession associated with the my hold
service. |
MyHoldSession |
getMyHoldSessionForOubliette(Id oublietteId)
Gets the
OsidSession associated with the my hold
service for the given oubliette. |
OublietteAdminSession |
getOublietteAdminSession()
Gets the
OsidSession associated with the oubliette
administrative service. |
OublietteHierarchyDesignSession |
getOublietteHierarchyDesignSession()
Gets the
OsidSession associated with the oubliette
hierarchy design service. |
OublietteHierarchySession |
getOublietteHierarchySession()
Gets the
OsidSession associated with the oubliette
hierarchy service. |
OublietteLookupSession |
getOublietteLookupSession()
Gets the
OsidSession associated with the oubliette
lookup service. |
OublietteNotificationSession |
getOublietteNotificationSession(OublietteReceiver oublietteReceiver)
Gets the
OsidSession associated with the oubliette
notification service. |
OublietteQuerySession |
getOublietteQuerySession()
Gets the
OsidSession associated with the oubliette
query service. |
OublietteSearchSession |
getOublietteSearchSession()
Gets the
OsidSession associated with the oubliette
search service. |
changeBranch, initialize, rollbackService
close
getBlockRecordTypes, getBlockSearchRecordTypes, getHoldRecordTypes, getHoldSearchRecordTypes, getIssueRecordTypes, getIssueSearchRecordTypes, getOublietteRecordTypes, getOublietteSearchRecordTypes, supportsBlockAdmin, supportsBlocking, supportsBlockLookup, supportsBlockNotification, supportsBlockOubliette, supportsBlockOublietteAssignment, supportsBlockQuery, supportsBlockRecordType, supportsBlockSearch, supportsBlockSearchRecordType, supportsBlockSmartOubliette, supportsHoldAdmin, supportsHoldBatch, supportsHoldLookup, supportsHoldNotification, supportsHoldOubliette, supportsHoldOublietteAssignment, supportsHoldQuery, supportsHoldRecordType, supportsHoldRules, supportsHoldSearch, supportsHoldSearchRecordType, supportsHoldSmartOubliette, supportsIssueAdmin, supportsIssueLookup, supportsIssueNotification, supportsIssueOubliette, supportsIssueOublietteAssignment, supportsIssueQuery, supportsIssueRecordType, supportsIssueSearch, supportsIssueSearchRecordType, supportsIssueSmartOubliette, supportsMyHold, supportsOublietteAdmin, supportsOublietteHierarchy, supportsOublietteHierarchyDesign, supportsOublietteLookup, supportsOublietteNotification, supportsOublietteQuery, supportsOublietteRecordType, supportsOublietteSearch, supportsOublietteSearchRecordType, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
BlockSession getBlockSession() throws OperationFailedException
OsidSession
associated with the block service
to check for blocks. BlockSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlock()
is false
optional
- This method must be implemented if
supportsBlock()
is true.
BlockSession getBlockSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the block service
for the given oubliette.oublietteId
- the Id
of the oubliette BlockSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlock()
or supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBlock()
and
supportsVisibleFederation()
are true
MyHoldSession getMyHoldSession() throws OperationFailedException
OsidSession
associated with the my hold
service. MyHoldSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMyHold()
is false
optional
- This method must be implemented if
supportsMyHold()
is true.
MyHoldSession getMyHoldSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the my hold
service for the given oubliette.oublietteId
- the Id
of the oubliette MyHoldSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsMyHold()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsMyHold()
and
supportsVisibleFederation()
are true
BlockLookupSession getBlockLookupSession() throws OperationFailedException
OsidSession
associated with the block lookup
service. BlockLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlockLookup()
is false
optional
- This method must be implemented if
supportsBlockLookup()
is true.
BlockLookupSession getBlockLookupSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the block lookup
service for the given oubliette.oublietteId
- the Id
of the Oubliette
BlockLookupSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlockLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBlockLookup()
and
supportsVisibleFederation()
are true
BlockQuerySession getBlockQuerySession() throws OperationFailedException
OsidSession
associated with the block query
service. BlockQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlockQuery()
is false
optional
- This method must be implemented if
supportsBlockQuery()
is true.
BlockQuerySession getBlockQuerySessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the block query
service for the given oubliette.oublietteId
- the Id
of the Oubliette
BlockQuerySession
NotFoundException
- no oubliette found by the given
Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlockQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBlockQuery()
and
supportsVisibleFederation()
are true
BlockSearchSession getBlockSearchSession() throws OperationFailedException
OsidSession
associated with the block search
service. BlockSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlockSearch()
is false
optional
- This method must be implemented if
supportsBlockSearch()
is true.
BlockSearchSession getBlockSearchSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the block search
service for the given oubliette.oublietteId
- the Id
of the Oubliette
BlockSearchSession
NotFoundException
- no oubliette found by the given
Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlockSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBlockSearch()
and
supportsVisibleFederation()
are true
BlockAdminSession getBlockAdminSession() throws OperationFailedException
OsidSession
associated with the block
administration service. BlockAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlockAdmin()
is false
optional
- This method must be implemented if
supportsBlockAdmin()
is true.
BlockAdminSession getBlockAdminSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the block
administration service for the given oubliette.oublietteId
- the Id
of the Oubliette
BlockAdminSession
NotFoundException
- no oubliette found by the given
Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsBlockAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsBlockAdmin()
and
supportsVisibleFederation()
are true
BlockNotificationSession getBlockNotificationSession(BlockReceiver blockReceiver) throws OperationFailedException
OsidSession
associated with the block
notification service.blockReceiver
- the notification callback BlockNotificationSession
NullArgumentException
- blockReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBlockNotification()
is false
optional
- This method must be implemented if
supportsBlockNotification()
is true.
BlockNotificationSession getBlockNotificationSessionForOubliette(BlockReceiver blockReceiver, Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the block
notification service for the given oubliette.blockReceiver
- the notification callbackoublietteId
- the Id
of the Oubliette
BlockNotificationSession
NotFoundException
- no oubliette found by the given
Id
NullArgumentException
- blockReceiver
or
oublietteId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBlockNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsBlockNotification()
and
supportsVisibleFederation()
are true
BlockOublietteSession getBlockOublietteSession() throws OperationFailedException
OsidSession
to lookup block/oubliette
mappings. BlockOublietteSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBlockOubliette()
is false
optional
- This method must be implemented if
supportsBlockOubliette()
is true.
BlockOublietteAssignmentSession getBlockOublietteAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning blocks
to oubliettes. BlockOublietteAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBlockOublietteAssignment()
is false
optional
- This method must be implemented if
supportsBlockOublietteAssignment()
is true.
BlockSmartOublietteSession getBlockSmartOublietteSession(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
to manage block smart oubliettes.oublietteId
- the Id
of the Oubliette
BlockSmartOublietteSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsBlockSmartOubliette()
is false
optional
- This method must be implemented if
supportsBlockSmartOubliette()
is true.
IssueLookupSession getIssueLookupSession() throws OperationFailedException
OsidSession
associated with the issue lookup
service. IssueLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsIssueLookup()
is false
optional
- This method must be implemented if
supportsIssueLookup()
is true.
IssueLookupSession getIssueLookupSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the issue lookup
service for the given oubliette.oublietteId
- the Id
of the oubliette IssueLookupSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsIssueLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsIssueLookup()
and
supportsVisibleFederation()
are true
IssueQuerySession getIssueQuerySession() throws OperationFailedException
OsidSession
associated with the issue query
service. IssueQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsIssueQuery()
is false
optional
- This method must be implemented if
supportsIssueQuery()
is true.
IssueQuerySession getIssueQuerySessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the issue query
service for the given oubliette.oublietteId
- the Id
of the Oubliette
IssueQuerySession
NotFoundException
- no oubliette found by the given
Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsIssueQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsIssueQuery()
and
supportsVisibleFederation()
are true
IssueSearchSession getIssueSearchSession() throws OperationFailedException
OsidSession
associated with the issue search
service. IssueSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsIssueSearch()
is false
optional
- This method must be implemented if
supportsIssueSearch()
is true.
IssueSearchSession getIssueSearchSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the issue search
service for the given oubliette.oublietteId
- the Id
of the Oubliette
IssueSearchSession
NotFoundException
- no oubliette found by the given
Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsIssueSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsIssueSearch()
and
supportsVisibleFederation()
are true
IssueAdminSession getIssueAdminSession() throws OperationFailedException
OsidSession
associated with the issue
administration service. IssueAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsIssueAdmin()
is false
optional
- This method must be implemented if
supportsIssueAdmin()
is true.
IssueAdminSession getIssueAdminSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the issue
administration service for the given oubliette.oublietteId
- the Id
of the Oubliette
IssueAdminSession
NotFoundException
- no oubliette found by the given
Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsIssueAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsIssueAdmin()
and
supportsVisibleFederation()
are true
IssueNotificationSession getIssueNotificationSession(IssueReceiver issueReceiver) throws OperationFailedException
OsidSession
associated with the issue
notification service.issueReceiver
- the notification callback IssueNotificationSession
NullArgumentException
- issueReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIssueNotification()
is false
optional
- This method must be implemented if
supportsIssueNotification()
is true.
IssueNotificationSession getIssueNotificationSessionForOubliette(IssueReceiver issueReceiver, Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the issue
notification service for the given oubliette.issueReceiver
- the notification callbackoublietteId
- the Id
of the Oubliette
IssueNotificationSession
NotFoundException
- no oubliette found by the given
Id
NullArgumentException
- issueReceiver
or
oublietteId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIssueNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsIssueNotification()
and
supportsVisibleFederation()
are true
IssueOublietteSession getIssueOublietteSession() throws OperationFailedException
OsidSession
to lookup issue/oubliette holds. IssueOublietteSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIssueOubliette()
is false
optional
- This method must be implemented if
supportsIssueOubliette()
is true.
IssueOublietteAssignmentSession getIssueOublietteAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning issues
to oubliettes. IssueOublietteAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIssueOublietteAssignment()
is false
optional
- This method must be implemented if
supportsIssueOublietteAssignment()
is true.
IssueSmartOublietteSession getIssueSmartOublietteSession(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
to manage locatin smart
oubliettes.oublietteId
- the Id
of the Oubliette
IssueSmartOublietteSession
NotFoundException
- no oubliette found by the given
Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsIssueSmartOubliette()
is false
optional
- This method must be implemented if
supportsIssueSmartOubliette()
is true.
HoldLookupSession getHoldLookupSession() throws OperationFailedException
OsidSession
associated with the hold lookup
service. HoldLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsHoldLookup()
is false
optional
- This method must be implemented if
supportsHoldLookup()
is true.
HoldLookupSession getHoldLookupSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold lookup
service for the given oubliette.oublietteId
- the Id
of the Oubliette
HoldLookupSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsHoldLookup()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsHoldLookup()
and
supportsVisibleFederation()
are true
HoldQuerySession getHoldQuerySession() throws OperationFailedException
OsidSession
associated with the hold query
service. HoldQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsHoldQuery()
is false
optional
- This method must be implemented if
supportsHoldQuery()
is true.
HoldQuerySession getHoldQuerySessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold query
service for the given oubliette.oublietteId
- the Id
of the Oubliette
CHoldQuerySession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsHoldQuery()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsHoldQuery()
and
supportsVisibleFederation()
are true
HoldSearchSession getHoldSearchSession() throws OperationFailedException
OsidSession
associated with the hold search
service. HoldSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsHoldSearch()
is false
optional
- This method must be implemented if
supportsHoldSearch()
is true.
HoldSearchSession getHoldSearchSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold search
service for the given oubliette.oublietteId
- the Id
of the Oubliette
HoldSearchSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsHoldSearch()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsHoldSearch()
and
supportsVisibleFederation()
are true
HoldAdminSession getHoldAdminSession() throws OperationFailedException
OsidSession
associated with the hold
administrative service. HoldAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsHoldAdmin()
is false
optional
- This method must be implemented if
supportsHoldAdmin()
is true.
HoldAdminSession getHoldAdminSessionForOubliette(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold
administrative service for the given oubliette.oublietteId
- the Id
of the Oubliette
HoldAdminSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
- supportsHoldAdmin()
or supportsVisibleFederation()
is
false
optional
- This method must be implemented if
supportsHoldAdmin()
and
supportsVisibleFederation()
are true.
HoldNotificationSession getHoldNotificationSession(HoldReceiver holdReceiver) throws OperationFailedException
OsidSession
associated with the hold
notification service.holdReceiver
- the notification callback HoldNotificationSession
NullArgumentException
- holdReceiver
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldNotification()
is false
optional
- This method must be implemented if
supportsHoldNotification()
is true.
HoldNotificationSession getHoldNotificationSessionForOubliette(HoldReceiver holdReceiver, Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
associated with the hold
notification service for the given oubliette.holdReceiver
- the notification callbackoublietteId
- the Id
of the Oubliette
HoldNotificationSession
NotFoundException
- no oubliette found by the given
Id
NullArgumentException
- holdReceiver
or
oublietteId
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldNotification()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHoldNotification()
and
supportsVisibleFederation()
are true
HoldOublietteSession getHoldOublietteSession() throws OperationFailedException
OsidSession
to lookup hold/oubliette mappings. HoldOublietteSession
OperationFailedException
- unable to complete requestUnimplementedException
- supportsHoldOubliette()
is false
optional
- This method must be implemented if
supportsHoldOubliette()
is true.
HoldOublietteAssignmentSession getHoldOublietteAssignmentSession() throws OperationFailedException
OsidSession
associated with assigning
competencies to oubliettes. HoldOublietteAssignmentSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldOublietteAssignment()
is false
optional
- This method must be implemented if
supportsHoldOublietteAssignment()
is true.
HoldSmartOublietteSession getHoldSmartOublietteSession(Id oublietteId) throws NotFoundException, OperationFailedException
OsidSession
to manage hold smart oubliettes.oublietteId
- the Id
of the Oubliette
HoldSmartOublietteSession
NotFoundException
- no Oubliette
found
by the given Id
NullArgumentException
- oublietteId
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHoldSmartOubliette()
is false
optional
- This method must be implemented if
supportsHoldSmartOubliette()
is true.
OublietteLookupSession getOublietteLookupSession() throws OperationFailedException
OsidSession
associated with the oubliette
lookup service. OublietteLookupSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOublietteLookup()
is false
optional
- This method must be implemented if
supportsOublietteLookup()
is true.
OublietteQuerySession getOublietteQuerySession() throws OperationFailedException
OsidSession
associated with the oubliette
query service. OublietteQuerySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOublietteQuery()
is false
optional
- This method must be implemented if
supportsOublietteQuery()
is true.
OublietteSearchSession getOublietteSearchSession() throws OperationFailedException
OsidSession
associated with the oubliette
search service. OublietteSearchSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOublietteSearch()
is false
optional
- This method must be implemented if
supportsOublietteSearch()
is true.
OublietteAdminSession getOublietteAdminSession() throws OperationFailedException
OsidSession
associated with the oubliette
administrative service. OublietteAdminSession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOublietteAdmin()
is false
optional
- This method must be implemented if
supportsOublietteAdmin()
is true.
OublietteNotificationSession getOublietteNotificationSession(OublietteReceiver oublietteReceiver) throws OperationFailedException
OsidSession
associated with the oubliette
notification service.oublietteReceiver
- the notification callback OublietteNotificationSession
NullArgumentException
- oublietteReceiver
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOublietteNotification()
is false
optional
- This method must be implemented if
supportsOublietteNotification()
is true.
OublietteHierarchySession getOublietteHierarchySession() throws OperationFailedException
OsidSession
associated with the oubliette
hierarchy service. OublietteHierarchySession
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsOublietteHierarchy()
is false
optional
- This method must be implemented if
supportsOublietteHierarchy()
is true.
OublietteHierarchyDesignSession getOublietteHierarchyDesignSession() throws OperationFailedException
OsidSession
associated with the oubliette
hierarchy design service. HierarchyDesignSession
for oubliettesOperationFailedException
- unable to complete requestUnimplementedException
-
supportsOublietteHierarchyDesign()
is false
optional
- This method must be implemented if
supportsOublietteHierarchyDesign()
is true.
HoldBatchManager getHoldBatchManager() throws OperationFailedException
HoldBatchManager.
HoldBatchManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsHoldBatch()
is false
optional
- This method must be implemented if
supportsHoldBatch()
is true.
HoldRulesManager getHoldRulesManager() throws OperationFailedException
HoldRulesManager.
HoldRulesManager
OperationFailedException
- unable to complete requestUnimplementedException
- supportsHoldRules()
is false
optional
- This method must be implemented if
supportsHoldRules()
is true.