org.osid.hold

Interface HoldProxyManager

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, HoldProfile, OsidProfile, 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

Methods

Modifier and Type	Method and 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 org.osid.OsidProxyManager

changeBranch, initialize, rollbackService

Methods inherited from interface org.osid.binding.java.OsidProxyManager

close

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.osid.hold.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

Methods inherited from interface org.osid.OsidProfile

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

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

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 supportsBlock() is 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 supportsBlock() and supportsVisibleFederation() are 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 supportsMyHold() is 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 supportsMyHold() and supportsVisibleFederation() are 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 supportsBlockLookup() is 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 supportsBlockLookup() and supportsVisibleFederation() are 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 supportsBlockQuery() is 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 supportsBlockQuery() and supportsVisibleFederation() are 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 supportsBlockSearch() is 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 supportsBlockSearch() and supportsVisibleFederation() are 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 supportsBlockAdmin() is 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 supportsBlockAdmin() and supportsVisibleFederation() are 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 supportsBlockNotification() is 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 supportsBlockNotification() and supportsVisibleFederation() are 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 supportsBlockOubliette() is 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 supportsBlockOublietteAssignment() is 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 supportsBlockSmartOubliette() is 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 supportsIssueLookup() is 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 supportsIssueLookup() and supportsVisibleFederation() are 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 supportsIssueQuery() is 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 supportsIssueQuery() and supportsVisibleFederation() are 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 supportsIssueSearch() is 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 supportsIssueSearch() and supportsVisibleFederation() are 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 supportsIssueAdmin() is 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 supportsIssueAdmin() and supportsVisibleFederation() are 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 supportsIssueNotification() is 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 supportsIssueNotification() and supportsVisibleFederation() are 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 supportsIssueOubliette() is 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 supportsIssueOublietteAssignment() is 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 supportsIssueSmartOubliette() is 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 supportsHoldLookup() is 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 supportsHoldLookup() and supportsVisibleFederation() are 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 supportsHoldQuery() is 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 supportsHoldQuery() and supportsVisibleFederation() are 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 supportsHoldSearch() is 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 supportsHoldSearch() and supportsVisibleFederation() are 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 supportsHoldAdmin() is 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 supportsHoldAdmin() and supportsVisibleFederation() are 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 supportsHoldNotification() is 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 supportsHoldNotification() and supportsVisibleFederation() are 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 supportsHoldOubliette() is 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 supportsHoldOublietteAssignment() is 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 supportsHoldSmartOubliette() is true.

getOublietteLookupSession

OublietteLookupSession getOublietteLookupSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the oubliette lookup service.

Parameters:

proxy - a proxy

Returns:

a OublietteLookupSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteLookup() is false

Compliance:

optional - This method must be implemented if supportsOublietteLookup() is true.

getOublietteQuerySession

OublietteQuerySession getOublietteQuerySession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the oubliette query service.

Parameters:

proxy - a proxy

Returns:

a OublietteQuerySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteQuery() is false

Compliance:

optional - This method must be implemented if supportsOublietteQuery() is true.

getOublietteSearchSession

OublietteSearchSession getOublietteSearchSession(Proxy proxy)
                                                 throws OperationFailedException

Gets the OsidSession associated with the oubliette search service.

Parameters:

proxy - a proxy

Returns:

a OublietteSearchSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteSearch() is false

Compliance:

optional - This method must be implemented if supportsOublietteSearch() is true.

getOublietteAdminSession

OublietteAdminSession getOublietteAdminSession(Proxy proxy)
                                               throws OperationFailedException

Gets the OsidSession associated with the oubliette administrative service.

Parameters:

proxy - a proxy

Returns:

a OublietteAdminSession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteAdmin() is false

Compliance:

optional - This method must be implemented if supportsOublietteAdmin() is 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:

a 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 supportsOublietteNotification() is true.

getOublietteHierarchySession

OublietteHierarchySession getOublietteHierarchySession(Proxy proxy)
                                                       throws OperationFailedException

Gets the OsidSession associated with the oubliette hierarchy service.

Parameters:

proxy - a proxy

Returns:

a OublietteHierarchySession

Throws:

NullArgumentException - proxy is null

OperationFailedException - unable to complete request

UnimplementedException - supportsOublietteHierarchy() is false

Compliance:

optional - This method must be implemented if supportsOublietteHierarchy() is 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 supportsOublietteHierarchyDesign() is 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 supportsHoldBatch() is 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 supportsHoldRules() is true.