Interface TrackingManager

All Superinterfaces:

AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, TrackingProfile

public interface TrackingManager
extends OsidManager, TrackingProfile

The tracking manager provides access to rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

• MyIssueSession : a session to get issues for the authenticated agent
• IssueTrackingSession : a session to examine issues in a queue
• IssueResourcingSession : a session to assign resources to issues
• IssueTriagingSession : a session to reassign issues to queues and topics
• 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
• IssueHierarchySession : a session to examine issues in a hierarchy
• IssueHierarchyAssignmentSession : a session to traverse the issue hierarchy
• IssueFrontOfficeSession : a session to lookup issue front office mappings
• IssueFrontOfficeAssignmentSession : a session to manage issue to front office mappings
• IssueSmartFrontOfficeSession : a session to manage dynamic front offices of issues
• SubtaskIssueLookupSession : a session to retrieve issue subtasks
• SubtaskIssueAdminSession : a session to manage issue subtasks
• DuplicateIssueLookupSession : a session to retrieve linked issues
• DuplicateIssueAdminSession : a session to manage linked issues
• BranchedIssueLookupSession : a session to retrieve issue branches
• BranchedIssueAdminSession : a session to manage issue branches
• BlockingIssueLookupSession : a session to retrieve issue blocks
• BlockingIssueAdminSession : a session to manage issue blocks

• LogEntryLookupSession : a session to retrieve issue log entries
• IssueMessagingSession : a session comment on issues and send messages to customers
• LogEntryNotificationSession : a session to receive notifications pertaining to log entries
• QueueLookupSession : a session to retrieve queues
• QueueQuerySession : a session to query for queues
• QueueSearchSession : a session to search for queues
• QueueAdminSession : a session to create and delete queues
• QueueNotificationSession : a session to receive notifications pertaining to queue changes
• QueueFrontOfficeSession : a session to looking issues of queues to front offices
• QueueFrontOfficeAssignmentSession : a session to manage queue to front office mappings
• QueueFrontOfficeAssignmentSession : a session to manage dynamic front offices of queues
• QueueResourcingSession : a session to manage queue resources

• FrontOfficeLookupSession : a session to retrieve front offices
• FrontOfficeQuerySession : a session to search for front offices
• FrontOfficeSearchSession : a session to search for front offices
• FrontOfficeAdminSession : a session to create and delete front offices
• FrontOfficeNotificationSession : a session to receive notifications pertaining to front office changes
• FrontOfficeHierarchySession : a session to traverse a hierarchy of frontOffice
• FrontOfficeHierarchyDesignSession : a session to manage a front office hierarchy

Method Summary

Modifier and Type	Method	Description
BlockingIssueAdminSession	getBlockingIssueAdminSession()	Gets the OsidSession associated with the blocking issue administration service.
BlockingIssueAdminSession	getBlockingIssueAdminSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the blocking issue administration service for the given front office.
BlockingIssueLookupSession	getBlockingIssueLookupSession()	Gets the OsidSession associated with the blocking issue lookup service.
BlockingIssueLookupSession	getBlockingIssueLookupSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the blocking issue lookup service for the given front office.
BranchedIssueAdminSession	getBranchedIssueAdminSession()	Gets the OsidSession associated with the branched issue administration service.
BranchedIssueAdminSession	getBranchedIssueAdminSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the branched issue administration service for the given front office.
BranchedIssueLookupSession	getBranchedIssueLookupSession()	Gets the OsidSession associated with the branched issue lookup service.
BranchedIssueLookupSession	getBranchedIssueLookupSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the branched issue lookup service for the given front office.
DuplicateIssueAdminSession	getDuplicateIssueAdminSession()	Gets the OsidSession associated with the duplicate issue administration service.
DuplicateIssueAdminSession	getDuplicateIssueAdminSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the duplicate issue administration service for the given front office.
DuplicateIssueLookupSession	getDuplicateIssueLookupSession()	Gets the OsidSession associated with the duplicate issue lookup service.
DuplicateIssueLookupSession	getDuplicateIssueLookupSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the duplicate issue lookup service for the given front office.
FrontOfficeAdminSession	getFrontOfficeAdminSession()	Gets the OsidSession associated with the front office administrative service.
FrontOfficeHierarchyDesignSession	getFrontOfficeHierarchyDesignSession()	Gets the OsidSession associated with the front office hierarchy design service.
FrontOfficeHierarchySession	getFrontOfficeHierarchySession()	Gets the OsidSession associated with the front office hierarchy service.
FrontOfficeLookupSession	getFrontOfficeLookupSession()	Gets the OsidSession associated with the front office lookup service.
FrontOfficeNotificationSession	getFrontOfficeNotificationSession(FrontOfficeReceiver frontOfficeReceiver)	Gets the OsidSession associated with the front office notification service.
FrontOfficeQuerySession	getFrontOfficeQuerySession()	Gets the OsidSession associated with the front office query service.
FrontOfficeSearchSession	getFrontOfficeSearchSession()	Gets the OsidSession associated with the front office search service.
IssueAdminSession	getIssueAdminSession()	Gets the OsidSession associated with the issue administration service.
IssueAdminSession	getIssueAdminSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the issue administration service for the given front office.
IssueFrontOfficeAssignmentSession	getIssueFrontOfficeAssignmentSession()	Gets the OsidSession associated with assigning issues to frontOffices.
IssueFrontOfficeSession	getIssueFrontOfficeSession()	Gets the OsidSession to lookup issue/front office trackings.
IssueLookupSession	getIssueLookupSession()	Gets the OsidSession associated with the issue lookup service.
IssueLookupSession	getIssueLookupSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the issue lookup service for the given front office.
IssueMessagingSession	getIssueMessagingSession()	Gets the OsidSession associated with the issue messaging service.
IssueMessagingSession	getIssueMessagingSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the issue messaging service for the given front office.
IssueNotificationSession	getIssueNotificationSession(IssueReceiver issueReceiver)	Gets the OsidSession associated with the issue notification service.
IssueNotificationSession	getIssueNotificationSessionForFrontOffice(IssueReceiver issueReceiver, Id frontOfficeId)	Gets the OsidSession associated with the issue notification service for the given front office.
IssueQuerySession	getIssueQuerySession()	Gets the OsidSession associated with the issue query service.
IssueQuerySession	getIssueQuerySessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the issue query service for the given front office.
IssueResourcingSession	getIssueResourcingSession()	Gets the OsidSession associated with the issue resourcing service.
IssueResourcingSession	getIssueResourcingSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the issue resourcing service for the given front office.
IssueSearchSession	getIssueSearchSession()	Gets the OsidSession associated with the issue search service.
IssueSearchSession	getIssueSearchSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the issue search service for the given front office.
IssueSmartFrontOfficeSession	getIssueSmartFrontOfficeSession(Id frontOfficeId)	Gets the OsidSession to manage locatin smart frontOffices.
IssueTrackingSession	getIssueTrackingSession()	Gets the OsidSession associated with the issue tracking service.
IssueTrackingSession	getIssueTrackingSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the issue tracking service for the given front office.
IssueTriagingSession	getIssueTriagingSession()	Gets the OsidSession associated with the issue triaging service.
IssueTriagingSession	getIssueTriagingSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the issue triaging service for the given front office.
LogEntryLookupSession	getLogEntryLookupSession()	Gets the OsidSession associated with the log entry lookup service.
LogEntryLookupSession	getLogEntryLookupSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the log entry lookup service for the given front office.
LogEntryNotificationSession	getLogEntryNotificationSession(LogEntryReceiver logEntryReceiver)	Gets the OsidSession associated with the log entry notification service.
LogEntryNotificationSession	getLogEntryNotificationSessionForFrontOffice(LogEntryReceiver logEntryReceiver, Id frontOfficeId)	Gets the OsidSession associated with the log entry notification service for the given front office.
MyIssueSession	getMyIssueSession()	Gets the OsidSession associated with the my issue service.
MyIssueSession	getMyIssueSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the my issue service for the given front office.
QueueAdminSession	getQueueAdminSession()	Gets the OsidSession associated with the queue administration service.
QueueAdminSession	getQueueAdminSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the queue administration service for the given front office.
QueueFrontOfficeAssignmentSession	getQueueFrontOfficeAssignmentSession()	Gets the OsidSession associated with assigning queues to frontOffices.
QueueFrontOfficeSession	getQueueFrontOfficeSession()	Gets the OsidSession to lookup queue/front office issues.
QueueLookupSession	getQueueLookupSession()	Gets the OsidSession associated with the queue lookup service.
QueueLookupSession	getQueueLookupSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the queue lookup service for the given front office.
QueueNotificationSession	getQueueNotificationSession(QueueReceiver queueReceiver)	Gets the OsidSession associated with the queue notification service.
QueueNotificationSession	getQueueNotificationSessionForFrontOffice(QueueReceiver queueReceiver, Id frontOfficeId)	Gets the OsidSession associated with the queue notification service for the given front office.
QueueQuerySession	getQueueQuerySession()	Gets the OsidSession associated with the queue query service.
QueueQuerySession	getQueueQuerySessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the queue query service for the given front office.
QueueResourcingSession	getQueueResourcingSession()	Gets the OsidSession associated with the queue resourcing service.
QueueResourcingSession	getQueueResourcingSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the queue resourcing service for the given front office.
QueueSearchSession	getQueueSearchSession()	Gets the OsidSession associated with the queue search service.
QueueSearchSession	getQueueSearchSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the queue search service for the given front office.
QueueSmartFrontOfficeSession	getQueueSmartFrontOfficeSession(Id frontOfficeId)	Gets the OsidSession to manage queue smart frontOffices.
SubtaskIssueAdminSession	getSubtaskIssueAdminSession()	Gets the OsidSession associated with the subtask issue administration service.
SubtaskIssueAdminSession	getSubtaskIssueAdminSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the subtask issue administration service for the given front office.
SubtaskIssueLookupSession	getSubtaskIssueLookupSession()	Gets the OsidSession associated with the subtask issue lookup service.
SubtaskIssueLookupSession	getSubtaskIssueLookupSessionForFrontOffice(Id frontOfficeId)	Gets the OsidSession associated with the subtask issue lookup service for the given front office.
TrackingRulesManager	getTrackingRulesManager()	Gets a TrackingRulesManager .

Methods inherited from interface Closeable

close

Methods inherited from interface OsidManager

close

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

Methods inherited from interface OsidManager

changeBranch, initialize, rollbackService

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

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 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.

Methods inherited from interface TrackingProfile

getFrontOfficeRecordTypes, getFrontOfficeSearchRecordTypes, getIssueRecordTypes, getIssueSearchRecordTypes, getLogEntryRecordTypes, getQueueRecordTypes, getQueueSearchRecordTypes, supportsBlockingIssueAdmin, supportsBlockingIssueLookup, supportsBranchedIssueAdmin, supportsBranchedIssueLookup, supportsDuplicateIssueAdmin, supportsDuplicateIssueLookup, supportsFrontOfficeAdmin, supportsFrontOfficeHierarchy, supportsFrontOfficeHierarchyDesign, supportsFrontOfficeLookup, supportsFrontOfficeNotification, supportsFrontOfficeQuery, supportsFrontOfficeRecordType, supportsFrontOfficeSearch, supportsFrontOfficeSearchRecordType, supportsIssueAdmin, supportsIssueFrontOffice, supportsIssueFrontOfficeAssignment, supportsIssueLookup, supportsIssueMessaging, supportsIssueNotification, supportsIssueQuery, supportsIssueRecordType, supportsIssueResourcing, supportsIssueSearch, supportsIssueSearchRecordType, supportsIssueSmartFrontOffice, supportsIssueTracking, supportsIssueTriaging, supportsLogEntryLookup, supportsLogEntryNotification, supportsLogEntryRecordType, supportsMyIssue, supportsQueueAdmin, supportsQueueFrontOffice, supportsQueueFrontOfficeAssignment, supportsQueueLookup, supportsQueueNotification, supportsQueueQuery, supportsQueueRecordType, supportsQueueResourcing, supportsQueueSearch, supportsQueueSearchRecordType, supportsQueueSmartFrontOffice, supportsSubtaskIssueAdmin, supportsSubtaskIssueLookup, supportsTrackingRules, supportsVisibleFederation

Modifier and Type	Method	Description
TypeList	getFrontOfficeRecordTypes()	Gets the supported FrontOffice record types.
TypeList	getFrontOfficeSearchRecordTypes()	Gets the supported FrontOffice search record types.
TypeList	getIssueRecordTypes()	Gets the supported Issue record types.
TypeList	getIssueSearchRecordTypes()	Gets the supported Issue search types.
TypeList	getLogEntryRecordTypes()	Gets the supported LogEntry record types.
TypeList	getQueueRecordTypes()	Gets the supported Queue record types.
TypeList	getQueueSearchRecordTypes()	Gets the supported Queue search record types.
boolean	supportsBlockingIssueAdmin()	Tests if managing issue blocks is supported.
boolean	supportsBlockingIssueLookup()	Tests if looking up blocking issues is supported.
boolean	supportsBranchedIssueAdmin()	Tests if managing issue branches is supported.
boolean	supportsBranchedIssueLookup()	Tests if looking up issue branches is supported.
boolean	supportsDuplicateIssueAdmin()	Tests if managing duplicate issues is supported.
boolean	supportsDuplicateIssueLookup()	Tests if looking up duplicate issues is supported.
boolean	supportsFrontOfficeAdmin()	Tests if front office administrative service is supported.
boolean	supportsFrontOfficeHierarchy()	Tests for the availability of a front office hierarchy traversal service.
boolean	supportsFrontOfficeHierarchyDesign()	Tests for the availability of a front office hierarchy design service.
boolean	supportsFrontOfficeLookup()	Tests if looking up front offices is supported.
boolean	supportsFrontOfficeNotification()	Tests if a front office notification service is supported.
boolean	supportsFrontOfficeQuery()	Tests if querying front offices is supported.
boolean	supportsFrontOfficeRecordType(Type frontOfficeRecordType)	Tests if the given FrontOffice record type is supported.
boolean	supportsFrontOfficeSearch()	Tests if searching front offices is supported.
boolean	supportsFrontOfficeSearchRecordType(Type frontOfficeSearchRecordType)	Tests if the given FrontOffice search record type is supported.
boolean	supportsIssueAdmin()	Tests if issue administrative service is supported.
boolean	supportsIssueFrontOffice()	Tests if an issue front office lookup service is supported.
boolean	supportsIssueFrontOfficeAssignment()	Tests if an issue front office assignment service is supported.
boolean	supportsIssueLookup()	Tests if looking up issues is supported.
boolean	supportsIssueMessaging()	Tests if issue commenting and customer messaging is supported.
boolean	supportsIssueNotification()	Tests if an issue notification 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	supportsIssueResourcing()	Tests if an issue resourcing service is supported.
boolean	supportsIssueSearch()	Tests if searching issues is supported.
boolean	supportsIssueSearchRecordType(Type issueSearchRecordType)	Tests if the given Issue search type is supported.
boolean	supportsIssueSmartFrontOffice()	Tests if an issue smart front office service is supported.
boolean	supportsIssueTracking()	Tests if an issue tracking service is supported.
boolean	supportsIssueTriaging()	Tests if an issue triaging service is supported.
boolean	supportsLogEntryLookup()	Tests if looking up log entries is supported.
boolean	supportsLogEntryNotification()	Tests if log entry notification is supported.
boolean	supportsLogEntryRecordType(Type logEntryRecordType)	Tests if the given LogEntry record type is supported.
boolean	supportsMyIssue()	Tests if an issue service is supported for the current agent.
boolean	supportsQueueAdmin()	Tests if queue administrative service is supported.
boolean	supportsQueueFrontOffice()	Tests if a queue front office lookup service is supported.
boolean	supportsQueueFrontOfficeAssignment()	Tests if a queue front office service is supported.
boolean	supportsQueueLookup()	Tests if looking up queues is supported.
boolean	supportsQueueNotification()	Tests if a queue notification service is supported.
boolean	supportsQueueQuery()	Tests if querying queues is supported.
boolean	supportsQueueRecordType(Type queueRecordType)	Tests if the given Queue record type is supported.
boolean	supportsQueueResourcing()	Tests if a queue resourcing is supported.
boolean	supportsQueueSearch()	Tests if searching queues is supported.
boolean	supportsQueueSearchRecordType(Type queueSearchRecordType)	Tests if the given Queue search record type is supported.
boolean	supportsQueueSmartFrontOffice()	Tests if a queue smart front office lookup service is supported.
boolean	supportsSubtaskIssueAdmin()	Tests if managing subtasks is supported.
boolean	supportsSubtaskIssueLookup()	Tests if looking up subtasks is supported.
boolean	supportsTrackingRules()	Tests for the availability of a tracking rules service.
boolean	supportsVisibleFederation()	Tests if any front office federation is exposed.

Method Details

getMyIssueSession

MyIssueSession getMyIssueSession()
                          throws OperationFailedException

Gets the OsidSession associated with the my issue service.

Returns:

a MyIssueSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMyIssue() is false

Compliance:

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

getMyIssueSessionForFrontOffice

MyIssueSession getMyIssueSessionForFrontOffice(Id frontOfficeId)
                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the my issue service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

a MyIssueLookupSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsMyIssue() or supportsVisibleFederation() is false

Compliance:

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

getIssueTrackingSession

IssueTrackingSession getIssueTrackingSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the issue tracking service.

Returns:

an IssueTrackingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueTracking() is false

Compliance:

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

getIssueTrackingSessionForFrontOffice

IssueTrackingSession getIssueTrackingSessionForFrontOffice(Id frontOfficeId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue tracking service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

an IssueTrackingSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueTracking() or supportsVisibleFederation() is false

Compliance:

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

getIssueResourcingSession

IssueResourcingSession getIssueResourcingSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the issue resourcing service.

Returns:

an IssueResourcingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueResourcing() is false

Compliance:

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

getIssueResourcingSessionForFrontOffice

IssueResourcingSession getIssueResourcingSessionForFrontOffice(Id frontOfficeId)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue resourcing service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

an IssueResourcingSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueResourcing() or supportsVisibleFederation() is false

Compliance:

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

getIssueTriagingSession

IssueTriagingSession getIssueTriagingSession()
                                      throws OperationFailedException

Gets the OsidSession associated with the issue triaging service.

Returns:

an IssueTriagingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsMyIssueLookup() is false

Compliance:

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

getIssueTriagingSessionForFrontOffice

IssueTriagingSession getIssueTriagingSessionForFrontOffice(Id frontOfficeId)
                                                    throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue triaging service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

an IssueTriagingSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueTriaging() or supportsVisibleFederation() is false

Compliance:

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

getIssueLookupSession

IssueLookupSession getIssueLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the issue lookup service.

Returns:

an IssueLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueLookup() is false

Compliance:

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

getIssueLookupSessionForFrontOffice

IssueLookupSession getIssueLookupSessionForFrontOffice(Id frontOfficeId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue lookup service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

an IssueLookupSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId 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()
                                throws OperationFailedException

Gets the OsidSession associated with the issue query service.

Returns:

an IssueQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueQuery() is false

Compliance:

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

getIssueQuerySessionForFrontOffice

IssueQuerySession getIssueQuerySessionForFrontOffice(Id frontOfficeId)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue query service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

an IssueQuerySession

Throws:

NotFoundException - no front office found by the given Id

NullArgumentException - frontOfficeId 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()
                                  throws OperationFailedException

Gets the OsidSession associated with the issue search service.

Returns:

an IssueSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueSearch() is false

Compliance:

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

getIssueSearchSessionForFrontOffice

IssueSearchSession getIssueSearchSessionForFrontOffice(Id frontOfficeId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue search service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

an IssueSearchSession

Throws:

NotFoundException - no front office found by the given Id

NullArgumentException - frontOfficeId 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()
                                throws OperationFailedException

Gets the OsidSession associated with the issue administration service.

Returns:

an IssueAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueAdmin() is false

Compliance:

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

getIssueAdminSessionForFrontOffice

IssueAdminSession getIssueAdminSessionForFrontOffice(Id frontOfficeId)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue administration service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

an IssueAdminSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId 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)
                                              throws OperationFailedException

Gets the OsidSession associated with the issue notification service.

Parameters:

issueReceiver - the notification callback

Returns:

an IssueNotificationSession

Throws:

NullArgumentException - issueReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueNotification() is false

Compliance:

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

getIssueNotificationSessionForFrontOffice

IssueNotificationSession getIssueNotificationSessionForFrontOffice(IssueReceiver issueReceiver,
 Id frontOfficeId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue notification service for the given front office.

Parameters:

issueReceiver - the notification callback

frontOfficeId - the Id of the FrontOffice

Returns:

an IssueNotificationSession

Throws:

NotFoundException - no front office found by the given Id

NullArgumentException - issueReceiver or frontOfficeId 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}

getIssueFrontOfficeSession

IssueFrontOfficeSession getIssueFrontOfficeSession()
                                            throws OperationFailedException

Gets the OsidSession to lookup issue/front office trackings.

Returns:

an IssueFrontOfficeSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueFrontOffice() is false

Compliance:

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

getIssueFrontOfficeAssignmentSession

IssueFrontOfficeAssignmentSession getIssueFrontOfficeAssignmentSession()
                                                                throws OperationFailedException

Gets the OsidSession associated with assigning issues to frontOffices.

Returns:

an IssueFrontOfficeAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueFrontOfficeAssignment() is false

Compliance:

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

getIssueSmartFrontOfficeSession

IssueSmartFrontOfficeSession getIssueSmartFrontOfficeSession(Id frontOfficeId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage locatin smart frontOffices.

Parameters:

frontOfficeId - the Id of the front office

Returns:

an IssueSmartFrontOfficeSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueSmartFrontOffice() is false

Compliance:

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

getSubtaskIssueLookupSession

SubtaskIssueLookupSession getSubtaskIssueLookupSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the subtask issue lookup service.

Returns:

a SubtaskIssueLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubtaskIssueLookup() is false

Compliance:

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

getSubtaskIssueLookupSessionForFrontOffice

SubtaskIssueLookupSession getSubtaskIssueLookupSessionForFrontOffice(Id frontOfficeId)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subtask issue lookup service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

a SubtaskIssueLookupSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubtaskIssueLookup() or supportsVisibleFederation() is false

Compliance:

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

getSubtaskIssueAdminSession

SubtaskIssueAdminSession getSubtaskIssueAdminSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the subtask issue administration service.

Returns:

a SubtaskIssueAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsSubtaskIssueAdmin() is false

Compliance:

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

getSubtaskIssueAdminSessionForFrontOffice

SubtaskIssueAdminSession getSubtaskIssueAdminSessionForFrontOffice(Id frontOfficeId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the subtask issue administration service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

a SubtaskIssueAdminSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsSubtaskIssueAdmin() or supportsVisibleFederation() is false

Compliance:

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

getDuplicateIssueLookupSession

DuplicateIssueLookupSession getDuplicateIssueLookupSession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the duplicate issue lookup service.

Returns:

a DuplicateIssueLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDuplicateIssueLookup() is false

Compliance:

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

getDuplicateIssueLookupSessionForFrontOffice

DuplicateIssueLookupSession getDuplicateIssueLookupSessionForFrontOffice(Id frontOfficeId)
                                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the duplicate issue lookup service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

a DuplicateIssueLookupSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDuplicateIssueLookup() or supportsVisibleFederation() is false

Compliance:

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

getDuplicateIssueAdminSession

DuplicateIssueAdminSession getDuplicateIssueAdminSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the duplicate issue administration service.

Returns:

a DuplicateIssueAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsDuplicateIssueAdmin() is false

Compliance:

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

getDuplicateIssueAdminSessionForFrontOffice

DuplicateIssueAdminSession getDuplicateIssueAdminSessionForFrontOffice(Id frontOfficeId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the duplicate issue administration service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

a DuplicateIssueAdminSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsDuplicateIssueAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBranchedIssueLookupSession

BranchedIssueLookupSession getBranchedIssueLookupSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the branched issue lookup service.

Returns:

a BranchedIssueLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchedIssueLookup() is false

Compliance:

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

getBranchedIssueLookupSessionForFrontOffice

BranchedIssueLookupSession getBranchedIssueLookupSessionForFrontOffice(Id frontOfficeId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the branched issue lookup service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

a BranchedIssueLookupSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchedIssueLookup() or supportsVisibleFederation() is false

Compliance:

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

getBranchedIssueAdminSession

BranchedIssueAdminSession getBranchedIssueAdminSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the branched issue administration service.

Returns:

a BranchedIssueAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchedIssueAdmin() is false

Compliance:

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

getBranchedIssueAdminSessionForFrontOffice

BranchedIssueAdminSession getBranchedIssueAdminSessionForFrontOffice(Id frontOfficeId)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the branched issue administration service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

a BranchedIssueAdminSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBranchedIssueAdmin() or supportsVisibleFederation() is false

Compliance:

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

getBlockingIssueLookupSession

BlockingIssueLookupSession getBlockingIssueLookupSession()
                                                  throws OperationFailedException

Gets the OsidSession associated with the blocking issue lookup service.

Returns:

a BlockingIssueLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockingIssueLookup() is false

Compliance:

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

getBlockingIssueLookupSessionForFrontOffice

BlockingIssueLookupSession getBlockingIssueLookupSessionForFrontOffice(Id frontOfficeId)
                                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the blocking issue lookup service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

a BlockingIssueLookupSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockingIssueLookup() or supportsVisibleFederation() is false

Compliance:

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

getBlockingIssueAdminSession

BlockingIssueAdminSession getBlockingIssueAdminSession()
                                                throws OperationFailedException

Gets the OsidSession associated with the blocking issue administration service.

Returns:

a BlockingIssueAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockingIssueAdmin() is false

Compliance:

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

getBlockingIssueAdminSessionForFrontOffice

BlockingIssueAdminSession getBlockingIssueAdminSessionForFrontOffice(Id frontOfficeId)
                                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the blocking issue administration service for the given front office.

Parameters:

frontOfficeId - the Id of the front office

Returns:

a BlockingIssueAdminSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsBlockingIssueAdmin() or supportsVisibleFederation() is false

Compliance:

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

getLogEntryLookupSession

LogEntryLookupSession getLogEntryLookupSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the log entry lookup service.

Returns:

a LogEntryLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryLookup() is false

Compliance:

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

getLogEntryLookupSessionForFrontOffice

LogEntryLookupSession getLogEntryLookupSessionForFrontOffice(Id frontOfficeId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the log entry lookup service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

a LogEntryLookupSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryLookup() or supportsVisibleFederation() is false

Compliance:

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

getIssueMessagingSession

IssueMessagingSession getIssueMessagingSession()
                                        throws OperationFailedException

Gets the OsidSession associated with the issue messaging service.

Returns:

an IssueMessagingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueMessaging() is false

Compliance:

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

getIssueMessagingSessionForFrontOffice

IssueMessagingSession getIssueMessagingSessionForFrontOffice(Id frontOfficeId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the issue messaging service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

an IssueMessagingSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsIssueMessaging() or supportsVisibleFederation() is false

Compliance:

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

getLogEntryNotificationSession

LogEntryNotificationSession getLogEntryNotificationSession(LogEntryReceiver logEntryReceiver)
                                                    throws OperationFailedException

Gets the OsidSession associated with the log entry notification service.

Parameters:

logEntryReceiver - the notification callback

Returns:

a LogEntryNotificationSession

Throws:

NullArgumentException - logEntryReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryNotification() is false

Compliance:

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

getLogEntryNotificationSessionForFrontOffice

LogEntryNotificationSession getLogEntryNotificationSessionForFrontOffice(LogEntryReceiver logEntryReceiver,
 Id frontOfficeId)
                                                                  throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the log entry notification service for the given front office.

Parameters:

logEntryReceiver - the notification callback

frontOfficeId - the Id of the FrontOffice

Returns:

a LogEntryNotificationSession

Throws:

NotFoundException - no front office found by the given Id

NullArgumentException - logEntryReceiver or frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsLogEntryNotification() or supportsVisibleFederation() is false

Compliance:

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

getQueueLookupSession

QueueLookupSession getQueueLookupSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the queue lookup service.

Returns:

a QueueLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueLookup() is false

Compliance:

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

getQueueLookupSessionForFrontOffice

QueueLookupSession getQueueLookupSessionForFrontOffice(Id frontOfficeId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the queue lookup service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

a QueueLookupSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueLookup() or supportsVisibleFederation() is false

Compliance:

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

getQueueQuerySession

QueueQuerySession getQueueQuerySession()
                                throws OperationFailedException

Gets the OsidSession associated with the queue query service.

Returns:

a QueueQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueQuery() is false

Compliance:

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

getQueueQuerySessionForFrontOffice

QueueQuerySession getQueueQuerySessionForFrontOffice(Id frontOfficeId)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the queue query service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

a QueueQuerySession

Throws:

NotFoundException - no front office found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueQuery() or supportsVisibleFederation() is false

Compliance:

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

getQueueSearchSession

QueueSearchSession getQueueSearchSession()
                                  throws OperationFailedException

Gets the OsidSession associated with the queue search service.

Returns:

a QueueSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueSearch() is false

Compliance:

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

getQueueSearchSessionForFrontOffice

QueueSearchSession getQueueSearchSessionForFrontOffice(Id frontOfficeId)
                                                throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the queue search service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

a QueueSearchSession

Throws:

NotFoundException - no front office found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueSearch() or supportsVisibleFederation() is false

Compliance:

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

getQueueAdminSession

QueueAdminSession getQueueAdminSession()
                                throws OperationFailedException

Gets the OsidSession associated with the queue administration service.

Returns:

a QueueAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueAdmin() is false

Compliance:

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

getQueueAdminSessionForFrontOffice

QueueAdminSession getQueueAdminSessionForFrontOffice(Id frontOfficeId)
                                              throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the queue administration service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

a QueueAdminSession

Throws:

NotFoundException - no front office found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueAdmin() or supportsVisibleFederation() is false

Compliance:

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

getQueueNotificationSession

QueueNotificationSession getQueueNotificationSession(QueueReceiver queueReceiver)
                                              throws OperationFailedException

Gets the OsidSession associated with the queue notification service.

Parameters:

queueReceiver - the notification callback

Returns:

a QueueNotificationSession

Throws:

NullArgumentException - queueReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueNotification() is false

Compliance:

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

getQueueNotificationSessionForFrontOffice

QueueNotificationSession getQueueNotificationSessionForFrontOffice(QueueReceiver queueReceiver,
 Id frontOfficeId)
                                                            throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the queue notification service for the given front office.

Parameters:

queueReceiver - the notification callback

frontOfficeId - the Id of the FrontOffice

Returns:

a QueueNotificationSession

Throws:

NotFoundException - no front office found by the given Id

NullArgumentException - queueReceiver or frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueNotification() or supportsVisibleFederation() is false

Compliance:

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

getQueueFrontOfficeSession

QueueFrontOfficeSession getQueueFrontOfficeSession()
                                            throws OperationFailedException

Gets the OsidSession to lookup queue/front office issues.

Returns:

a QueueFrontOfficeSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueFrontOffice() is false

Compliance:

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

getQueueFrontOfficeAssignmentSession

QueueFrontOfficeAssignmentSession getQueueFrontOfficeAssignmentSession()
                                                                throws OperationFailedException

Gets the OsidSession associated with assigning queues to frontOffices.

Returns:

a QueueFrontOfficeAssignmentSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueFrontOfficeAssignment() is false

Compliance:

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

getQueueSmartFrontOfficeSession

QueueSmartFrontOfficeSession getQueueSmartFrontOfficeSession(Id frontOfficeId)
                                                      throws NotFoundException,
OperationFailedException

Gets the OsidSession to manage queue smart frontOffices.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

a QueueSmartFrontOfficeSession

Throws:

NotFoundException - no front office found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueSmartFrontOffice() is false

Compliance:

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

getQueueResourcingSession

QueueResourcingSession getQueueResourcingSession()
                                          throws OperationFailedException

Gets the OsidSession associated with the queue resourcing service.

Returns:

a QueueResourcingSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueResourcing() is false

Compliance:

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

getQueueResourcingSessionForFrontOffice

QueueResourcingSession getQueueResourcingSessionForFrontOffice(Id frontOfficeId)
                                                        throws NotFoundException,
OperationFailedException

Gets the OsidSession associated with the queue resourcing service for the given front office.

Parameters:

frontOfficeId - the Id of the FrontOffice

Returns:

a QueueResourcingSession

Throws:

NotFoundException - no FrontOffice found by the given Id

NullArgumentException - frontOfficeId is null

OperationFailedException - unable to complete request

UnimplementedException - supportsQueueResourcing() or supportsVisibleFederation() is false

Compliance:

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

getFrontOfficeLookupSession

FrontOfficeLookupSession getFrontOfficeLookupSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the front office lookup service.

Returns:

a FrontOfficeLookupSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFrontOfficeLookup() is false

Compliance:

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

getFrontOfficeQuerySession

FrontOfficeQuerySession getFrontOfficeQuerySession()
                                            throws OperationFailedException

Gets the OsidSession associated with the front office query service.

Returns:

a FrontOfficeQuerySession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFrontOfficeQuery() is false

Compliance:

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

getFrontOfficeSearchSession

FrontOfficeSearchSession getFrontOfficeSearchSession()
                                              throws OperationFailedException

Gets the OsidSession associated with the front office search service.

Returns:

a FrontOfficeSearchSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFrontOfficeSearch() is false

Compliance:

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

getFrontOfficeAdminSession

FrontOfficeAdminSession getFrontOfficeAdminSession()
                                            throws OperationFailedException

Gets the OsidSession associated with the front office administrative service.

Returns:

a FrontOfficeAdminSession

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFrontOfficeAdmin() is false

Compliance:

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

getFrontOfficeNotificationSession

FrontOfficeNotificationSession getFrontOfficeNotificationSession(FrontOfficeReceiver frontOfficeReceiver)
                                                          throws OperationFailedException

Gets the OsidSession associated with the front office notification service.

Parameters:

frontOfficeReceiver - the notification callback

Returns:

a FrontOfficeNotificationSession

Throws:

NullArgumentException - frontOfficeReceiver is null

OperationFailedException - unable to complete request

UnimplementedException - supportsFrontOfficeNotification() is false

Compliance:

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

getFrontOfficeHierarchySession

FrontOfficeHierarchySession getFrontOfficeHierarchySession()
                                                    throws OperationFailedException

Gets the OsidSession associated with the front office hierarchy service.

Returns:

a hierarchy design session for front offices

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFrontOfficeHierarchy() is false

Compliance:

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

getFrontOfficeHierarchyDesignSession

FrontOfficeHierarchyDesignSession getFrontOfficeHierarchyDesignSession()
                                                                throws OperationFailedException

Gets the OsidSession associated with the front office hierarchy design service.

Returns:

a hierarchy design session for front offices

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsFrontOfficeHierarchyDesign() is false

Compliance:

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

getTrackingRulesManager

TrackingRulesManager getTrackingRulesManager()
                                      throws OperationFailedException

Gets a TrackingRulesManager .

Returns:

a TrackingRulesManager

Throws:

OperationFailedException - unable to complete request

UnimplementedException - supportsTrackingRules() is false

Compliance:

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