Interface HoldProxyManager

All Superinterfaces:

AutoCloseable, Closeable, HoldProfile, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable

public interface HoldProxyManager
extends OsidProxyManager, HoldProfile

The hold proxy manager provides access to rules 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:

• 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

Method Summary

Modifier and Type	Method	Description
BlockAdminSession	getBlockAdminSession(Proxy proxy)	Gets the OsidSession associated with the block administration service.
BlockAdminSession	getBlockAdminSessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the block administration service for the given oubliette.
BlockLookupSession	getBlockLookupSession(Proxy proxy)	Gets the OsidSession associated with the block lookup service.
BlockLookupSession	getBlockLookupSessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the block lookup service for the given oubliette.
BlockNotificationSession	getBlockNotificationSession(BlockReceiver blockReceiver, Proxy proxy)	Gets the OsidSession associated with the block notification service.
BlockNotificationSession	getBlockNotificationSessionForOubliette(BlockReceiver blockReceiver, Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the block notification service for the given oubliette.
BlockOublietteAssignmentSession	getBlockOublietteAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning blocks to oubliettes.
BlockOublietteSession	getBlockOublietteSession(Proxy proxy)	Gets the OsidSession to lookup block/oubliette mappings.
BlockQuerySession	getBlockQuerySession(Proxy proxy)	Gets the OsidSession associated with the block query service.
BlockQuerySession	getBlockQuerySessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the block query service for the given oubliette.
BlockSearchSession	getBlockSearchSession(Proxy proxy)	Gets the OsidSession associated with the block search service.
BlockSearchSession	getBlockSearchSessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the block search service for the given oubliette.
BlockSession	getBlockSession(Proxy proxy)	Gets the OsidSession associated with the block service to check for blocks.
BlockSession	getBlockSessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the block service for the given oubliette.
BlockSmartOublietteSession	getBlockSmartOublietteSession(Id oublietteId, Proxy proxy)	Gets the OsidSession to manage block smart oubliettes.
HoldAdminSession	getHoldAdminSession(Proxy proxy)	Gets the OsidSession associated with the hold administrative service.
HoldAdminSession	getHoldAdminSessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the hold administrative service for the given oubliette.
HoldBatchProxyManager	getHoldBatchProxyManager()	Gets a HoldBatchProxyManager .
HoldLookupSession	getHoldLookupSession(Proxy proxy)	Gets the OsidSession associated with the hold lookup service.
HoldLookupSession	getHoldLookupSessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the hold lookup service for the given oubliette.
HoldNotificationSession	getHoldNotificationSession(HoldReceiver holdReceiver, Proxy proxy)	Gets the OsidSession associated with the hold notification service.
HoldNotificationSession	getHoldNotificationSessionForOubliette(HoldReceiver holdReceiver, Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the hold notification service for the given oubliette.
HoldOublietteAssignmentSession	getHoldOublietteAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning competencies to oubliettes.
HoldOublietteSession	getHoldOublietteSession(Proxy proxy)	Gets the OsidSession to lookup hold/oubliette mappings.
HoldQuerySession	getHoldQuerySession(Proxy proxy)	Gets the OsidSession associated with the hold query service.
HoldQuerySession	getHoldQuerySessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the hold query service for the given oubliette.
HoldRulesProxyManager	getHoldRulesProxyManager()	Gets a HoldRulesProxyManager .
HoldSearchSession	getHoldSearchSession(Proxy proxy)	Gets the OsidSession associated with the hold search service.
HoldSearchSession	getHoldSearchSessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the hold search service for the given oubliette.
HoldSmartOublietteSession	getHoldSmartOublietteSession(Id oublietteId, Proxy proxy)	Gets the OsidSession to manage hold smart oubliettes.
IssueAdminSession	getIssueAdminSession(Proxy proxy)	Gets the OsidSession associated with the issue administration service.
IssueAdminSession	getIssueAdminSessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the issue administration service for the given oubliette.
IssueLookupSession	getIssueLookupSession(Proxy proxy)	Gets the OsidSession associated with the issue lookup service.
IssueLookupSession	getIssueLookupSessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the issue lookup service for the given oubliette.
IssueNotificationSession	getIssueNotificationSession(IssueReceiver issueReceiver, Proxy proxy)	Gets the OsidSession associated with the issue notification service.
IssueNotificationSession	getIssueNotificationSessionForOubliette(IssueReceiver issueReceiver, Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the issue notification service for the given oubliette.
IssueOublietteAssignmentSession	getIssueOublietteAssignmentSession(Proxy proxy)	Gets the OsidSession associated with assigning mappings to oubliettes.
IssueOublietteSession	getIssueOublietteSession(Proxy proxy)	Gets the OsidSession to lookup issue/oubliette holds.
IssueQuerySession	getIssueQuerySession(Proxy proxy)	Gets the OsidSession associated with the issue query service.
IssueQuerySession	getIssueQuerySessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the issue query service for the given oubliette.
IssueSearchSession	getIssueSearchSession(Proxy proxy)	Gets the OsidSession associated with the issue search service.
IssueSearchSession	getIssueSearchSessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the issue search service for the given oubliette.
IssueSmartOublietteSession	getIssueSmartOublietteSession(Id oublietteId, Proxy proxy)	Gets the OsidSession to manage locatin smart oubliettes.
MyHoldSession	getMyHoldSession(Proxy proxy)	Gets the OsidSession associated with the my hold service.
MyHoldSession	getMyHoldSessionForOubliette(Id oublietteId, Proxy proxy)	Gets the OsidSession associated with the my hold service for the given oubliette.
OublietteAdminSession	getOublietteAdminSession(Proxy proxy)	Gets the OsidSession associated with the oubliette administrative service.
OublietteHierarchyDesignSession	getOublietteHierarchyDesignSession(Proxy proxy)	Gets the OsidSession associated with the oubliette hierarchy design service.
OublietteHierarchySession	getOublietteHierarchySession(Proxy proxy)	Gets the OsidSession associated with the oubliette hierarchy service.
OublietteLookupSession	getOublietteLookupSession(Proxy proxy)	Gets the OsidSession associated with the oubliette lookup service.
OublietteNotificationSession	getOublietteNotificationSession(OublietteReceiver oublietteReceiver, Proxy proxy)	Gets the OsidSession associated with the oubliette notification service.
OublietteQuerySession	getOublietteQuerySession(Proxy proxy)	Gets the OsidSession associated with the oubliette query service.
OublietteSearchSession	getOublietteSearchSession(Proxy proxy)	Gets the OsidSession associated with the oubliette search service.

Methods inherited from interface Closeable

close

Methods inherited from interface HoldProfile

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

Modifier and Type	Method	Description
TypeList	getBlockRecordTypes()	Gets the supported Block record types.
TypeList	getBlockSearchRecordTypes()	Gets the supported Block search record types.
TypeList	getHoldRecordTypes()	Gets the supported Hold record types.
TypeList	getHoldSearchRecordTypes()	Gets the supported Hold search record types.
TypeList	getIssueRecordTypes()	Gets the supported Issue record types.
TypeList	getIssueSearchRecordTypes()	Gets the supported Issue search types.
TypeList	getOublietteRecordTypes()	Gets the supported Oubliette record types.
TypeList	getOublietteSearchRecordTypes()	Gets the supported Oubliette search types.
boolean	supportsBlockAdmin()	Tests if block administrative service is supported.
boolean	supportsBlocking()	Tests if a blocking service is supported for the current agent.
boolean	supportsBlockLookup()	Tests if looking up blocks is supported.
boolean	supportsBlockNotification()	Tests if a block notification service is supported.
boolean	supportsBlockOubliette()	Tests if a block oubliette lookup service is supported.
boolean	supportsBlockOublietteAssignment()	Tests if a block oubliette service is supported.
boolean	supportsBlockQuery()	Tests if querying blocks is supported.
boolean	supportsBlockRecordType(Type blockRecordType)	Tests if the given Block record type is supported.
boolean	supportsBlockSearch()	Tests if searching blocks is supported.
boolean	supportsBlockSearchRecordType(Type blockSearchRecordType)	Tests if the given Block search record type is supported.
boolean	supportsBlockSmartOubliette()	Tests if a block smart oubliette lookup service is supported.
boolean	supportsHoldAdmin()	Tests if hold administrative service is supported.
boolean	supportsHoldBatch()	Tests for the availability of a hold batch service.
boolean	supportsHoldLookup()	Tests if looking up holds is supported.
boolean	supportsHoldNotification()	Tests if a hold notification service is supported.
boolean	supportsHoldOubliette()	Tests if a hold oubliette lookup service is supported.
boolean	supportsHoldOublietteAssignment()	Tests if a hold oubliette service is supported.
boolean	supportsHoldQuery()	Tests if querying holds is supported.
boolean	supportsHoldRecordType(Type holdRecordType)	Tests if the given Hold record type is supported.
boolean	supportsHoldRules()	Tests for the availability of a hold rules service.
boolean	supportsHoldSearch()	Tests if searching holds is supported.
boolean	supportsHoldSearchRecordType(Type holdSearchRecordType)	Tests if the given Hold search record type is supported.
boolean	supportsHoldSmartOubliette()	Tests if a hold smart oubliette lookup service is supported.
boolean	supportsIssueAdmin()	Tests if issue administrative service is supported.
boolean	supportsIssueLookup()	Tests if looking up issues is supported.
boolean	supportsIssueNotification()	Tests if an issue notification service is supported.
boolean	supportsIssueOubliette()	Tests if an issue oubliette lookup service is supported.
boolean	supportsIssueOublietteAssignment()	Tests if an issue oubliette assignment service is supported.
boolean	supportsIssueQuery()	Tests if querying issues is supported.
boolean	supportsIssueRecordType(Type issueRecordType)	Tests if the given Issue record type is supported.
boolean	supportsIssueSearch()	Tests if searching issues is supported.
boolean	supportsIssueSearchRecordType(Type issueSearchRecordType)	Tests if the given Issue search type is supported.
boolean	supportsIssueSmartOubliette()	Tests if an issue smart oubliette service is supported.
boolean	supportsMyHold()	Tests if a my hold service is supported for the current agent.
boolean	supportsOublietteAdmin()	Tests if oubliette administrative service is supported.
boolean	supportsOublietteHierarchy()	Tests for the availability of an oubliette hierarchy traversal service.
boolean	supportsOublietteHierarchyDesign()	Tests for the availability of an oubliette hierarchy design service.
boolean	supportsOublietteLookup()	Tests if looking up oubliettes is supported.
boolean	supportsOublietteNotification()	Tests if an oubliette notification service is supported.
boolean	supportsOublietteQuery()	Tests if querying oubliettes is supported.
boolean	supportsOublietteRecordType(Type oublietteRecordType)	Tests if the given Oubliette record type is supported.
boolean	supportsOublietteSearch()	Tests if searching oubliettes is supported.
boolean	supportsOublietteSearchRecordType(Type oublietteSearchRecordType)	Tests if the given Oubliette search record type is supported.
boolean	supportsVisibleFederation()	Tests if any oubliette federation is exposed.

Methods inherited from interface OsidProfile

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

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

Methods inherited from interface OsidProxyManager

close

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

Methods inherited from interface OsidProxyManager

changeBranch, initialize, rollbackService

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

Methods inherited from interface Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

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

Method Details

getBlockSession

BlockSession getBlockSession(Proxy proxy)
                      throws OperationFailedException

Gets the OsidSession associated with the block service to check for blocks.

Parameters:

proxy - a proxy

Returns:

a BlockSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlock() is false

Compliance:

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

getBlockSessionForOubliette

BlockSession getBlockSessionForOubliette(Id oublietteId,
 Proxy proxy)
                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the block service for the given oubliette.

Parameters:

oublietteId - the Id of the oubliette

proxy - a proxy

Returns:

a BlockSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlock() or supportsVisibleFederation() is false

Compliance:

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

getMyHoldSession

MyHoldSession getMyHoldSession(Proxy proxy)
                        throws OperationFailedException

Gets the OsidSession associated with the my hold service.

Parameters:

proxy - a proxy

Returns:

a MyHoldSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyHold() is false

Compliance:

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

getMyHoldSessionForOubliette

MyHoldSession getMyHoldSessionForOubliette(Id oublietteId,
 Proxy proxy)
                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the my hold service for the given oubliette.

Parameters:

oublietteId - the Id of the oubliette

proxy - a proxy

Returns:

a MyHoldSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyHold() or supportsVisibleFederation() is false

Compliance:

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

getBlockLookupSession

BlockLookupSession getBlockLookupSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the block lookup service.

Parameters:

proxy - a proxy

Returns:

a BlockLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockLookup() is false

Compliance:

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

getBlockLookupSessionForOubliette

BlockLookupSession getBlockLookupSessionForOubliette(Id oublietteId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the block lookup service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a BlockLookupSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockLookup() or supportsVisibleFederation() is false

Compliance:

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

getBlockQuerySession

BlockQuerySession getBlockQuerySession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the block query service.

Parameters:

proxy - a proxy

Returns:

a BlockQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockQuery() is false

Compliance:

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

getBlockQuerySessionForOubliette

BlockQuerySession getBlockQuerySessionForOubliette(Id oublietteId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the block query service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a BlockQuerySession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockQuery() or supportsVisibleFederation() is false

Compliance:

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

getBlockSearchSession

BlockSearchSession getBlockSearchSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the block search service.

Parameters:

proxy - a proxy

Returns:

a BlockSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockSearch() is false

Compliance:

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

getBlockSearchSessionForOubliette

BlockSearchSession getBlockSearchSessionForOubliette(Id oublietteId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the block search service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a BlockSearchSession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockSearch() or supportsVisibleFederation() is false

Compliance:

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

getBlockAdminSession

BlockAdminSession getBlockAdminSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the block administration service.

Parameters:

proxy - a proxy

Returns:

a BlockAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockAdmin() is false

Compliance:

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

getBlockAdminSessionForOubliette

BlockAdminSession getBlockAdminSessionForOubliette(Id oublietteId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the block administration service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a BlockAdminSession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBlockNotificationSession

BlockNotificationSession getBlockNotificationSession(BlockReceiver blockReceiver,
 Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the block notification service.

Parameters:

blockReceiver - the notification callback

proxy - a proxy

Returns:

a BlockNotificationSession

Throws:

NullArgumentException - blockReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockNotification() is false

Compliance:

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

getBlockNotificationSessionForOubliette

BlockNotificationSession getBlockNotificationSessionForOubliette(BlockReceiver blockReceiver,
 Id oublietteId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the block notification service for the given oubliette.

Parameters:

blockReceiver - the notification callback

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a BlockNotificationSession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - blockReceiver, oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockNotification() or supportsVisibleFederation() is false

Compliance:

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

getBlockOublietteSession

BlockOublietteSession getBlockOublietteSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession to lookup block/oubliette mappings.

Parameters:

proxy - a proxy

Returns:

a BlockOublietteSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockOubliette() is false

Compliance:

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

getBlockOublietteAssignmentSession

BlockOublietteAssignmentSession getBlockOublietteAssignmentSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with assigning blocks to oubliettes.

Parameters:

proxy - a proxy

Returns:

a BlockOublietteAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockOublietteAssignment() is false

Compliance:

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

getBlockSmartOublietteSession

BlockSmartOublietteSession getBlockSmartOublietteSession(Id oublietteId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage block smart oubliettes.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a BlockSmartOublietteSession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockSmartOubliette() is false

Compliance:

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

getIssueLookupSession

IssueLookupSession getIssueLookupSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the issue lookup service.

Parameters:

proxy - a proxy

Returns:

an IssueLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueLookup() is false

Compliance:

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

getIssueLookupSessionForOubliette

IssueLookupSession getIssueLookupSessionForOubliette(Id oublietteId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue lookup service for the given oubliette.

Parameters:

oublietteId - the Id of the oubliette

proxy - a proxy

Returns:

an IssueLookupSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueLookup() or supportsVisibleFederation() is false

Compliance:

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

getIssueQuerySession

IssueQuerySession getIssueQuerySession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the issue query service.

Parameters:

proxy - a proxy

Returns:

an IssueQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueQuery() is false

Compliance:

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

getIssueQuerySessionForOubliette

IssueQuerySession getIssueQuerySessionForOubliette(Id oublietteId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue query service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

an IssueQuerySession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueQuery() or supportsVisibleFederation() is false

Compliance:

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

getIssueSearchSession

IssueSearchSession getIssueSearchSession(Proxy proxy)
                                  throws OperationFailedException

Gets the OsidSession associated with the issue search service.

Parameters:

proxy - a proxy

Returns:

an IssueSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueSearch() is false

Compliance:

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

getIssueSearchSessionForOubliette

IssueSearchSession getIssueSearchSessionForOubliette(Id oublietteId,
 Proxy proxy)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue search service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

an IssueSearchSession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueSearch() or supportsVisibleFederation() is false

Compliance:

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

getIssueAdminSession

IssueAdminSession getIssueAdminSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the issue administration service.

Parameters:

proxy - a proxy

Returns:

an IssueAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueAdmin() is false

Compliance:

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

getIssueAdminSessionForOubliette

IssueAdminSession getIssueAdminSessionForOubliette(Id oublietteId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue administration service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

an IssueAdminSession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueAdmin() or supportsVisibleFederation() is false

Compliance:

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

getIssueNotificationSession

IssueNotificationSession getIssueNotificationSession(IssueReceiver issueReceiver,
 Proxy proxy)
                                              throws OperationFailedException

Gets the OsidSession associated with the issue notification service.

Parameters:

issueReceiver - the notification callback

proxy - a proxy

Returns:

an IssueNotificationSession

Throws:

NullArgumentException - issueReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueNotification() is false

Compliance:

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

getIssueNotificationSessionForOubliette

IssueNotificationSession getIssueNotificationSessionForOubliette(IssueReceiver issueReceiver,
 Id oublietteId,
 Proxy proxy)
                                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue notification service for the given oubliette.

Parameters:

issueReceiver - the notification callback

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

an IssueNotificationSession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - issueReceiver , oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueNotification() or supportsVisibleFederation() is false

Compliance:

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

getIssueOublietteSession

IssueOublietteSession getIssueOublietteSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession to lookup issue/oubliette holds.

Parameters:

proxy - a proxy

Returns:

an IssueOublietteSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueOubliette() is false

Compliance:

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

getIssueOublietteAssignmentSession

IssueOublietteAssignmentSession getIssueOublietteAssignmentSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with assigning mappings to oubliettes.

Parameters:

proxy - a proxy

Returns:

an IssueOublietteAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueOublietteAssignment() is false

Compliance:

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

getIssueSmartOublietteSession

IssueSmartOublietteSession getIssueSmartOublietteSession(Id oublietteId,
 Proxy proxy)
                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage locatin smart oubliettes.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

an IssueSmartOublietteSession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueSmartOubliette() is false

Compliance:

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

getHoldLookupSession

HoldLookupSession getHoldLookupSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the hold lookup service.

Parameters:

proxy - a proxy

Returns:

a HoldLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldLookup() is false

Compliance:

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

getHoldLookupSessionForOubliette

HoldLookupSession getHoldLookupSessionForOubliette(Id oublietteId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the hold lookup service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a HoldLookupSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldLookup() or supportsVisibleFederation() is false

Compliance:

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

getHoldQuerySession

HoldQuerySession getHoldQuerySession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the hold query service.

Parameters:

proxy - a proxy

Returns:

a HoldQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldQuery() is false

Compliance:

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

getHoldQuerySessionForOubliette

HoldQuerySession getHoldQuerySessionForOubliette(Id oublietteId,
 Proxy proxy)
                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the hold query service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a HoldQuerySession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldQuery() or supportsVisibleFederation() is false

Compliance:

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

getHoldSearchSession

HoldSearchSession getHoldSearchSession(Proxy proxy)
                                throws OperationFailedException

Gets the OsidSession associated with the hold search service.

Parameters:

proxy - a proxy

Returns:

a HoldSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldSearch() is false

Compliance:

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

getHoldSearchSessionForOubliette

HoldSearchSession getHoldSearchSessionForOubliette(Id oublietteId,
 Proxy proxy)
                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the hold search service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a HoldSearchSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldSearch() or supportsVisibleFederation() is false

Compliance:

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

getHoldAdminSession

HoldAdminSession getHoldAdminSession(Proxy proxy)
                              throws OperationFailedException

Gets the OsidSession associated with the hold administrative service.

Parameters:

proxy - a proxy

Returns:

a HoldAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldAdmin() is false

Compliance:

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

getHoldAdminSessionForOubliette

HoldAdminSession getHoldAdminSessionForOubliette(Id oublietteId,
 Proxy proxy)
                                          throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the hold administrative service for the given oubliette.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a HoldAdminSession

Throws:

NotFoundException - no Oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldAdmin() or supportsVisibleFederation() is false

Compliance:

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

getHoldNotificationSession

HoldNotificationSession getHoldNotificationSession(HoldReceiver holdReceiver,
 Proxy proxy)
                                            throws OperationFailedException

Gets the OsidSession associated with the hold notification service.

Parameters:

holdReceiver - the notification callback

proxy - a proxy

Returns:

a HoldNotificationSession

Throws:

NullArgumentException - holdReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldNotification() is false

Compliance:

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

getHoldNotificationSessionForOubliette

HoldNotificationSession getHoldNotificationSessionForOubliette(HoldReceiver holdReceiver,
 Id oublietteId,
 Proxy proxy)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the hold notification service for the given oubliette.

Parameters:

holdReceiver - the notification callback

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a HoldNotificationSession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - holdReceiver, oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldNotification() or supportsVisibleFederation() is false

Compliance:

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

getHoldOublietteSession

HoldOublietteSession getHoldOublietteSession(Proxy proxy)
                                      throws OperationFailedException

Gets the OsidSession to lookup hold/oubliette mappings.

Parameters:

proxy - a proxy

Returns:

a HoldOublietteSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldOubliette() is false

Compliance:

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

getHoldOublietteAssignmentSession

HoldOublietteAssignmentSession getHoldOublietteAssignmentSession(Proxy proxy)
                                                          throws OperationFailedException

Gets the OsidSession associated with assigning competencies to oubliettes.

Parameters:

proxy - a proxy

Returns:

a HoldOublietteAssignmentSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldOublietteAssignment() is false

Compliance:

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

getHoldSmartOublietteSession

HoldSmartOublietteSession getHoldSmartOublietteSession(Id oublietteId,
 Proxy proxy)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage hold smart oubliettes.

Parameters:

oublietteId - the Id of the Oubliette

proxy - a proxy

Returns:

a HoldSmartOublietteSession

Throws:

NotFoundException - no oubliette found by the given Id

NullArgumentException - oublietteId or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldSmartOubliette() is false

Compliance:

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

getOublietteLookupSession

OublietteLookupSession getOublietteLookupSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the oubliette lookup service.

Parameters:

proxy - a proxy

Returns:

an OublietteLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteLookup() is false

Compliance:

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

getOublietteQuerySession

OublietteQuerySession getOublietteQuerySession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the oubliette query service.

Parameters:

proxy - a proxy

Returns:

an OublietteQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteQuery() is false

Compliance:

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

getOublietteSearchSession

OublietteSearchSession getOublietteSearchSession(Proxy proxy)
                                          throws OperationFailedException

Gets the OsidSession associated with the oubliette search service.

Parameters:

proxy - a proxy

Returns:

an OublietteSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteSearch() is false

Compliance:

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

getOublietteAdminSession

OublietteAdminSession getOublietteAdminSession(Proxy proxy)
                                        throws OperationFailedException

Gets the OsidSession associated with the oubliette administrative service.

Parameters:

proxy - a proxy

Returns:

an OublietteAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteAdmin() is false

Compliance:

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

getOublietteNotificationSession

OublietteNotificationSession getOublietteNotificationSession(OublietteReceiver oublietteReceiver,
 Proxy proxy)
                                                      throws OperationFailedException

Gets the OsidSession associated with the oubliette notification service.

Parameters:

oublietteReceiver - the notification callback

proxy - a proxy

Returns:

an OublietteNotificationSession

Throws:

NullArgumentException - oublietteReceiver or proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteNotification() is false

Compliance:

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

getOublietteHierarchySession

OublietteHierarchySession getOublietteHierarchySession(Proxy proxy)
                                                throws OperationFailedException

Gets the OsidSession associated with the oubliette hierarchy service.

Parameters:

proxy - a proxy

Returns:

an OublietteHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteHierarchy() is false

Compliance:

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

getOublietteHierarchyDesignSession

OublietteHierarchyDesignSession getOublietteHierarchyDesignSession(Proxy proxy)
                                                            throws OperationFailedException

Gets the OsidSession associated with the oubliette hierarchy design service.

Parameters:

proxy - a proxy

Returns:

a HierarchyDesignSession for oubliettes

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteHierarchyDesign() is false

Compliance:

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

getHoldBatchProxyManager

HoldBatchProxyManager getHoldBatchProxyManager()
                                        throws OperationFailedException

Gets a HoldBatchProxyManager .

Returns:

a HoldBatchProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldBatch() is false

Compliance:

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

getHoldRulesProxyManager

HoldRulesProxyManager getHoldRulesProxyManager()
                                        throws OperationFailedException

Gets a HoldRulesProxyManager .

Returns:

a HoldRulesProxyManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsHoldRules() is false

Compliance:

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