Interface TrackingProxyManager
- All Superinterfaces:
AutoCloseable, Closeable, OsidProfile, OsidProxyManager, OsidProxyManager, Sourceable, TrackingProfile
The tracking 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:
-
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 look up issue front offics 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 TypeMethodDescriptionGets theOsidSessionassociated with the blocking issue administration service.getBlockingIssueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the blocking issue administration service for the given front office.Gets theOsidSessionassociated with the blocking issue lookup service.getBlockingIssueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the blocking issue lookup service for the given front office.Gets theOsidSessionassociated with the branched issue administration service.getBranchedIssueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the branched issue administration service for the given front office.Gets theOsidSessionassociated with the branched issue lookup service.getBranchedIssueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the branched issue lookup service for the given front office.Gets theOsidSessionassociated with the duplicate issue administration service.getDuplicateIssueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the duplicate issue administration service for the given front office.Gets theOsidSessionassociated with the duplicate issue lookup service.getDuplicateIssueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the duplicate issue lookup service for the given front office.getFrontOfficeAdminSession(Proxy proxy) Gets theOsidSessionassociated with the front office administrative service.Gets theOsidSessionassociated with the front office hierarchy design service.Gets theOsidSessionassociated with the front office hierarchy service.getFrontOfficeLookupSession(Proxy proxy) Gets theOsidSessionassociated with the front office lookup service.getFrontOfficeNotificationSession(FrontOfficeReceiver frontOfficeReceiver, Proxy proxy) Gets theOsidSessionassociated with the front office notification service.getFrontOfficeQuerySession(Proxy proxy) Gets theOsidSessionassociated with the front office query service.getFrontOfficeSearchSession(Proxy proxy) Gets theOsidSessionassociated with the front office search service.getIssueAdminSession(Proxy proxy) Gets theOsidSessionassociated with the issue administration service.getIssueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the issue administration service for the given front office.Gets theOsidSessionassociated with assigning issues to frontOffices.getIssueFrontOfficeSession(Proxy proxy) Gets theOsidSessionto lookup issue/front office trackings.getIssueLookupSession(Proxy proxy) Gets theOsidSessionassociated with the issue lookup service.getIssueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the issue lookup service for the given front office.getIssueMessagingSession(Proxy proxy) Gets theOsidSessionassociated with the issue messaging service.getIssueMessagingSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the issue messaging service for the given front office.getIssueNotificationSession(IssueReceiver issueReceiver, Proxy proxy) Gets theOsidSessionassociated with the issue notification service.getIssueNotificationSessionForFrontOffice(IssueReceiver issueReceiver, Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the issue notification service for the given front office.getIssueQuerySession(Proxy proxy) Gets theOsidSessionassociated with the issue query service.getIssueQuerySessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the issue query service for the given front office.getIssueResourcingSession(Proxy proxy) Gets theOsidSessionassociated with the issue resourcing service.getIssueResourcingSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the issue resourcing service for the given front office.getIssueSearchSession(Proxy proxy) Gets theOsidSessionassociated with the issue search service.getIssueSearchSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the issue search service for the given front office.getIssueSmartFrontOfficeSession(Id frontOfficeId, Proxy proxy) Gets theOsidSessionto manage locatin smart frontOffices.getIssueTrackingSession(Proxy proxy) Gets theOsidSessionassociated with the issue tracking service.getIssueTrackingSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the issue tracking service for the given front office.getIssueTriagingSession(Proxy proxy) Gets theOsidSessionassociated with the issue triaging service.getIssueTriagingSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the issue triaging service for the given front office.getLogEntryLookupSession(Proxy proxy) Gets theOsidSessionassociated with the log entry lookup service.getLogEntryLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the log entry lookup service for the given front office.getLogEntryNotificationSession(LogEntryReceiver logEntryReceiver, Proxy proxy) Gets theOsidSessionassociated with the log entry notification service.getLogEntryNotificationSessionForFrontOffice(LogEntryReceiver logEntryReceiver, Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the log entry notification service for the given front office.getMyIssueSession(Proxy proxy) Gets theOsidSessionassociated with the my issue service.getMyIssueSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the my issue service for the given front office.getQueueAdminSession(Proxy proxy) Gets theOsidSessionassociated with the queue administration service.getQueueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the queue administration service for the given front office.Gets theOsidSessionassociated with assigning queues to frontOffices.getQueueFrontOfficeSession(Proxy proxy) Gets theOsidSessionto lookup queue/front office issues.getQueueLookupSession(Proxy proxy) Gets theOsidSessionassociated with the queue lookup service.getQueueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the queue lookup service for the given front office.getQueueNotificationSession(QueueReceiver queueReceiver, Proxy proxy) Gets theOsidSessionassociated with the queue notification service.getQueueNotificationSessionForFrontOffice(QueueReceiver queueReceiver, Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the queue notification service for the given front office.getQueueQuerySession(Proxy proxy) Gets theOsidSessionassociated with the queue query service.getQueueQuerySessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the queue query service for the given front office.getQueueResourcingSession(Proxy proxy) Gets theOsidSessionassociated with the queue resourcing service.getQueueResourcingSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the queue resourcing service for the given front office.getQueueSearchSession(Proxy proxy) Gets theOsidSessionassociated with the queue search service.getQueueSearchSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the queue search service for the given front office.getQueueSmartFrontOfficeSession(Id frontOfficeId, Proxy proxy) Gets theOsidSessionto manage queue smart frontOffices.getSubtaskIssueAdminSession(Proxy proxy) Gets theOsidSessionassociated with the subtask issue administration service.getSubtaskIssueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the subtask issue administration service for the given front office.Gets theOsidSessionassociated with the subtask issue lookup service.getSubtaskIssueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) Gets theOsidSessionassociated with the subtask issue lookup service for the given front office.Gets aTrackingRulesProxyManager.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface OsidProxyManager
closeMethods inherited from interface OsidProxyManager
changeBranch, initialize, rollbackServiceModifier and TypeMethodDescriptionvoidchangeBranch(Id branchId, Proxy proxy) Changes the service branch.voidinitialize(OsidRuntimeManager runtime) Initializes this manager.rollbackService(Date rollbackTime, Proxy proxy) Rolls back this service to a point in time.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.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, supportsVisibleFederationModifier and TypeMethodDescriptionGets the supportedFrontOfficerecord types.Gets the supportedFrontOfficesearch record types.Gets the supportedIssuerecord types.Gets the supportedIssuesearch types.Gets the supportedLogEntryrecord types.Gets the supportedQueuerecord types.Gets the supportedQueuesearch record types.booleanTests if managing issue blocks is supported.booleanTests if looking up blocking issues is supported.booleanTests if managing issue branches is supported.booleanTests if looking up issue branches is supported.booleanTests if managing duplicate issues is supported.booleanTests if looking up duplicate issues is supported.booleanTests if front office administrative service is supported.booleanTests for the availability of a front office hierarchy traversal service.booleanTests for the availability of a front office hierarchy design service.booleanTests if looking up front offices is supported.booleanTests if a front office notification service is supported.booleanTests if querying front offices is supported.booleansupportsFrontOfficeRecordType(Type frontOfficeRecordType) Tests if the givenFrontOfficerecord type is supported.booleanTests if searching front offices is supported.booleansupportsFrontOfficeSearchRecordType(Type frontOfficeSearchRecordType) Tests if the givenFrontOfficesearch record type is supported.booleanTests if issue administrative service is supported.booleanTests if an issue front office lookup service is supported.booleanTests if an issue front office assignment service is supported.booleanTests if looking up issues is supported.booleanTests if issue commenting and customer messaging is supported.booleanTests if an issue notification service is supported.booleanTests if querying issues is supported.booleansupportsIssueRecordType(Type issueRecordType) Tests if the givenIssuerecord type is supported.booleanTests if an issue resourcing service is supported.booleanTests if searching issues is supported.booleansupportsIssueSearchRecordType(Type issueSearchRecordType) Tests if the givenIssuesearch type is supported.booleanTests if an issue smart front office service is supported.booleanTests if an issue tracking service is supported.booleanTests if an issue triaging service is supported.booleanTests if looking up log entries is supported.booleanTests if log entry notification is supported.booleansupportsLogEntryRecordType(Type logEntryRecordType) Tests if the givenLogEntryrecord type is supported.booleanTests if an issue service is supported for the current agent.booleanTests if queue administrative service is supported.booleanTests if a queue front office lookup service is supported.booleanTests if a queue front office service is supported.booleanTests if looking up queues is supported.booleanTests if a queue notification service is supported.booleanTests if querying queues is supported.booleansupportsQueueRecordType(Type queueRecordType) Tests if the givenQueuerecord type is supported.booleanTests if a queue resourcing is supported.booleanTests if searching queues is supported.booleansupportsQueueSearchRecordType(Type queueSearchRecordType) Tests if the givenQueuesearch record type is supported.booleanTests if a queue smart front office lookup service is supported.booleanTests if managing subtasks is supported.booleanTests if looking up subtasks is supported.booleanTests for the availability of a tracking rules service.booleanTests if any front office federation is exposed.
-
Method Details
-
getMyIssueSession
Gets theOsidSessionassociated with the my issue service.- Parameters:
proxy- a proxy- Returns:
- a
MyIssueSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsMyIssue()isfalse- Compliance:
optional- This method must be implemented if {@code supportsMyIssue()} is {@code true} .
-
getMyIssueSessionForFrontOffice
MyIssueSession getMyIssueSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the my issue service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- a
MyIssueLookupSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsMyIssue()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsMyIssue()} and {@code supportsVisibleFederation()} are {@code true}
-
getIssueTrackingSession
Gets theOsidSessionassociated with the issue tracking service.- Parameters:
proxy- a proxy- Returns:
- an
IssueTrackingSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueTracking()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueTracking()} is {@code true} .
-
getIssueTrackingSessionForFrontOffice
IssueTrackingSession getIssueTrackingSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the issue tracking service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- an
IssueTrackingSession - Throws:
NotFoundException- noFrontOfficefound by the given IdNullArgumentException-frontOfficeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueTracking()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueTracking()} and {@code supportsVisibleFederation()} are {@code true}
-
getIssueResourcingSession
Gets theOsidSessionassociated with the issue resourcing service.- Parameters:
proxy- a proxy- Returns:
- an
IssueResourcingSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueResourcing()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueResourcing()} is {@code true} .
-
getIssueResourcingSessionForFrontOffice
IssueResourcingSession getIssueResourcingSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the issue resourcing service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- an
IssueResourcingSession - Throws:
NotFoundException- noFrontOfficefound by the given IdNullArgumentException-frontOfficeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueResourcing()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueResourcing()} and {@code supportsVisibleFederation()} are {@code true}
-
getIssueTriagingSession
Gets theOsidSessionassociated with the issue triaging service.- Parameters:
proxy- a proxy- Returns:
- an
IssueTriagingSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsMyIssueLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueTriaging()} is {@code true} .
-
getIssueTriagingSessionForFrontOffice
IssueTriagingSession getIssueTriagingSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the issue triaging service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- an
IssueTriagingSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueTriaging()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueTriaging()} and {@code supportsVisibleFederation()} are {@code true}
-
getIssueLookupSession
Gets theOsidSessionassociated with the issue lookup service.- Parameters:
proxy- a proxy- Returns:
- an
IssueLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueLookup()} is {@code true} .
-
getIssueLookupSessionForFrontOffice
IssueLookupSession getIssueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the issue lookup service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- an
IssueLookupSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getIssueQuerySession
Gets theOsidSessionassociated with the issue query service.- Parameters:
proxy- a proxy- Returns:
- an
IssueQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueQuery()} is {@code true} .
-
getIssueQuerySessionForFrontOffice
IssueQuerySession getIssueQuerySessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the issue query service for the given front office.- Parameters:
frontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- an
IssueQuerySession - Throws:
NotFoundException- no front office found by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getIssueSearchSession
Gets theOsidSessionassociated with the issue search service.- Parameters:
proxy- a proxy- Returns:
- an
IssueSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueSearch()} is {@code true} .
-
getIssueSearchSessionForFrontOffice
IssueSearchSession getIssueSearchSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the issue search service for the given front office.- Parameters:
frontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- an
IssueSearchSession - Throws:
NotFoundException- no front office found by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getIssueAdminSession
Gets theOsidSessionassociated with the issue administration service.- Parameters:
proxy- a proxy- Returns:
- an
IssueAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueAdmin()} is {@code true} .
-
getIssueAdminSessionForFrontOffice
IssueAdminSession getIssueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the issue administration service for the given front office.- Parameters:
frontOfficeId- theIdof theQueueproxy- a proxy- Returns:
- an
IssueAdminSession - Throws:
NotFoundException- noFrontOfficefound by the given IdNullArgumentException-frontOfficeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getIssueNotificationSession
IssueNotificationSession getIssueNotificationSession(IssueReceiver issueReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the issue notification service.- Parameters:
issueReceiver- the notification callbackproxy- a proxy- Returns:
- an
IssueNotificationSession - Throws:
NullArgumentException-issueReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueNotification()} is {@code true} .
-
getIssueNotificationSessionForFrontOffice
IssueNotificationSession getIssueNotificationSessionForFrontOffice(IssueReceiver issueReceiver, Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the issue notification service for the given front office.- Parameters:
issueReceiver- the notification callbackfrontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- an
IssueNotificationSession - Throws:
NotFoundException- no front office found by the givenIdNullArgumentException-issueReceiver, frontOfficeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getIssueFrontOfficeSession
Gets theOsidSessionto lookup issue/front office trackings.- Parameters:
proxy- a proxy- Returns:
- an
IssueFrontOfficeSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueFrontOffice()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueFrontOffice()} is {@code true} .
-
getIssueFrontOfficeAssignmentSession
IssueFrontOfficeAssignmentSession getIssueFrontOfficeAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning issues to frontOffices.- Parameters:
proxy- a proxy- Returns:
- an
IssueFrontOfficeAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueFrontOfficeAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueFrontOfficeAssignment()} is {@code true} .
-
getIssueSmartFrontOfficeSession
IssueSmartFrontOfficeSession getIssueSmartFrontOfficeSession(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage locatin smart frontOffices.- Parameters:
frontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- an
IssueSmartFrontOfficeSession - Throws:
NotFoundException- no front office found by the givenIdNullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueSmartFrontOffice()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueSmartFrontOffice()} is {@code true} .
-
getSubtaskIssueLookupSession
Gets theOsidSessionassociated with the subtask issue lookup service.- Parameters:
proxy- a proxy- Returns:
- a
SubtaskIssueLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSubtaskIssueLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSubtaskIssueLookup()} is {@code true} .
-
getSubtaskIssueLookupSessionForFrontOffice
SubtaskIssueLookupSession getSubtaskIssueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the subtask issue lookup service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- a
SubtaskIssueLookupSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsSubtaskIssueLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSubtaskIssueLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getSubtaskIssueAdminSession
Gets theOsidSessionassociated with the subtask issue administration service.- Parameters:
proxy- a proxy- Returns:
- a
SubtaskIssueAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsSubtaskIssueAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSubtaskIssueAdmin()} is {@code true} .
-
getSubtaskIssueAdminSessionForFrontOffice
SubtaskIssueAdminSession getSubtaskIssueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the subtask issue administration service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- a
SubtaskIssueAdminSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsSubtaskIssueAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsSubtaskIssueAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getDuplicateIssueLookupSession
DuplicateIssueLookupSession getDuplicateIssueLookupSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the duplicate issue lookup service.- Parameters:
proxy- a proxy- Returns:
- a
DuplicateIssueLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDuplicateIssueLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDuplicateIssueLookup()} is {@code true} .
-
getDuplicateIssueLookupSessionForFrontOffice
DuplicateIssueLookupSession getDuplicateIssueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the duplicate issue lookup service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- a
DuplicateIssueLookupSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsDuplicateIssueLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDuplicateIssueLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getDuplicateIssueAdminSession
DuplicateIssueAdminSession getDuplicateIssueAdminSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the duplicate issue administration service.- Parameters:
proxy- a proxy- Returns:
- a
DuplicateIssueAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsDuplicateIssueAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDuplicateIssueAdmin()} is {@code true} .
-
getDuplicateIssueAdminSessionForFrontOffice
DuplicateIssueAdminSession getDuplicateIssueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the duplicate issue administration service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- a
DuplicateIssueAdminSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsDuplicateIssueAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsDuplicateIssueAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getBranchedIssueLookupSession
BranchedIssueLookupSession getBranchedIssueLookupSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the branched issue lookup service.- Parameters:
proxy- a proxy- Returns:
- a
BranchedIssueLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsBranchedIssueLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchedIssueLookup()} is {@code true} .
-
getBranchedIssueLookupSessionForFrontOffice
BranchedIssueLookupSession getBranchedIssueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the branched issue lookup service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- a
BranchedIssueLookupSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsBranchedIssueLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchedIssueLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getBranchedIssueAdminSession
Gets theOsidSessionassociated with the branched issue administration service.- Parameters:
proxy- a proxy- Returns:
- a
BranchedIssueAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsBranchedIssueAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchedIssueAdmin()} is {@code true} .
-
getBranchedIssueAdminSessionForFrontOffice
BranchedIssueAdminSession getBranchedIssueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the branched issue administration service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- a
BranchedIssueAdminSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsBranchedIssueAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBranchedIssueAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getBlockingIssueLookupSession
BlockingIssueLookupSession getBlockingIssueLookupSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the blocking issue lookup service.- Parameters:
proxy- a proxy- Returns:
- a
BlockingIssueLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsBlockingIssueLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBlockingIssueLookup()} is {@code true} .
-
getBlockingIssueLookupSessionForFrontOffice
BlockingIssueLookupSession getBlockingIssueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the blocking issue lookup service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- a
BlockingIssueLookupSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsBlockingIssueLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBlockingIssueLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getBlockingIssueAdminSession
Gets theOsidSessionassociated with the blocking issue administration service.- Parameters:
proxy- a proxy- Returns:
- a
BlockingIssueAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsBlockingIssueAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBlockingIssueAdmin()} is {@code true} .
-
getBlockingIssueAdminSessionForFrontOffice
BlockingIssueAdminSession getBlockingIssueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the blocking issue administration service for the given front office.- Parameters:
frontOfficeId- theIdof the front officeproxy- a proxy- Returns:
- a
BlockingIssueAdminSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsBlockingIssueAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsBlockingIssueAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getLogEntryLookupSession
Gets theOsidSessionassociated with the log entry lookup service.- Parameters:
proxy- a proxy- Returns:
- a
LogEntryLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsLogEntryLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsLogEntryLookup()} is {@code true} .
-
getLogEntryLookupSessionForFrontOffice
LogEntryLookupSession getLogEntryLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the log entry lookup service for the given front office.- Parameters:
frontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- a
LogEntryLookupSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsLogEntryLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsLogEntryLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getIssueMessagingSession
Gets theOsidSessionassociated with the issue messaging service.- Parameters:
proxy- a proxy- Returns:
- an
IssueMessagingSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueMessaging()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueMessaging()} is {@code true} .
-
getIssueMessagingSessionForFrontOffice
IssueMessagingSession getIssueMessagingSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the issue messaging service for the given front office.- Parameters:
frontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- an
IssueMessagingSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsIssueMessaging()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsIssueMessaging()} and {@code supportsVisibleFederation()} are {@code true}
-
getLogEntryNotificationSession
LogEntryNotificationSession getLogEntryNotificationSession(LogEntryReceiver logEntryReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the log entry notification service.- Parameters:
logEntryReceiver- the notification callbackproxy- a proxy- Returns:
- a
LogEntryNotificationSession - Throws:
NullArgumentException-logEntryReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsLogEntryNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsLogEntryNotification()} is {@code true} .
-
getLogEntryNotificationSessionForFrontOffice
LogEntryNotificationSession getLogEntryNotificationSessionForFrontOffice(LogEntryReceiver logEntryReceiver, Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the log entry notification service for the given front office.- Parameters:
logEntryReceiver- the notification callbackfrontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- a
LogEntryNotificationSession - Throws:
NotFoundException- no front office found by the givenIdNullArgumentException-logEntryReceiver, frontOfficeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsLogEntryNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsLogEntryNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getQueueLookupSession
Gets theOsidSessionassociated with the queue lookup service.- Parameters:
proxy- a proxy- Returns:
- a
QueueLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueLookup()} is {@code true} .
-
getQueueLookupSessionForFrontOffice
QueueLookupSession getQueueLookupSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the queue lookup service for the given front office.- Parameters:
frontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- a
QueueLookupSession - Throws:
NotFoundException- noFrontOfficefound by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueLookup()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueLookup()} and {@code supportsVisibleFederation()} are {@code true}
-
getQueueQuerySession
Gets theOsidSessionassociated with the queue query service.- Parameters:
proxy- a proxy- Returns:
- a
QueueQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueQuery()} is {@code true} .
-
getQueueQuerySessionForFrontOffice
QueueQuerySession getQueueQuerySessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the queue query service for the given front office.- Parameters:
frontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- a
QueueQuerySession - Throws:
NotFoundException- no front office found by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueQuery()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueQuery()} and {@code supportsVisibleFederation()} are {@code true}
-
getQueueSearchSession
Gets theOsidSessionassociated with the queue search service.- Parameters:
proxy- a proxy- Returns:
- a
QueueSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueSearch()} is {@code true} .
-
getQueueSearchSessionForFrontOffice
QueueSearchSession getQueueSearchSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the queue search service for the given front office.- Parameters:
frontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- a
QueueSearchSession - Throws:
NotFoundException- no front office found by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueSearch()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueSearch()} and {@code supportsVisibleFederation()} are {@code true}
-
getQueueAdminSession
Gets theOsidSessionassociated with the queue administration service.- Parameters:
proxy- a proxy- Returns:
- a
QueueAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueAdmin()} is {@code true} .
-
getQueueAdminSessionForFrontOffice
QueueAdminSession getQueueAdminSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the queue administration service for the given front office.- Parameters:
frontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- a
QueueAdminSession - Throws:
NotFoundException- no front office found by the givenIdNullArgumentException-frontOfficeId or proxy is nullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueAdmin()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueAdmin()} and {@code supportsVisibleFederation()} are {@code true}
-
getQueueNotificationSession
QueueNotificationSession getQueueNotificationSession(QueueReceiver queueReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the queue notification service.- Parameters:
queueReceiver- the notification callbackproxy- a proxy- Returns:
- a
QueueNotificationSession - Throws:
NullArgumentException-queueReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueNotification()} is {@code true} .
-
getQueueNotificationSessionForFrontOffice
QueueNotificationSession getQueueNotificationSessionForFrontOffice(QueueReceiver queueReceiver, Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the queue notification service for the given front office.- Parameters:
queueReceiver- the notification callbackfrontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- a
QueueNotificationSession - Throws:
NotFoundException- no front office found by the givenIdNullArgumentException-queueReceiver, frontOfficeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueNotification()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueNotification()} and {@code supportsVisibleFederation()} are {@code true}
-
getQueueFrontOfficeSession
Gets theOsidSessionto lookup queue/front office issues.- Parameters:
proxy- a proxy- Returns:
- a
QueueFrontOfficeSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueFrontOffice()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueFrontOffice()} is {@code true} .
-
getQueueFrontOfficeAssignmentSession
QueueFrontOfficeAssignmentSession getQueueFrontOfficeAssignmentSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with assigning queues to frontOffices.- Parameters:
proxy- a proxy- Returns:
- a
QueueFrontOfficeAssignmentSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueFrontOfficeAssignment()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueFrontOfficeAssignment()} is {@code true} .
-
getQueueSmartFrontOfficeSession
QueueSmartFrontOfficeSession getQueueSmartFrontOfficeSession(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionto manage queue smart frontOffices.- Parameters:
frontOfficeId- theIdof theFrontOfficeproxy- a proxy- Returns:
- a
QueueSmartFrontOfficeSession - Throws:
NotFoundException- no front office found by the givenIdNullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueSmartFrontOffice()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueSmartFrontOffice()} is {@code true} .
-
getQueueResourcingSession
Gets theOsidSessionassociated with the queue resourcing service.- Parameters:
proxy- a proxy- Returns:
- a
QueueResourcingSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueResourcing()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueResourcing()} is {@code true} .
-
getQueueResourcingSessionForFrontOffice
QueueResourcingSession getQueueResourcingSessionForFrontOffice(Id frontOfficeId, Proxy proxy) throws NotFoundException, OperationFailedException Gets theOsidSessionassociated with the queue resourcing service for the given front office.- Parameters:
frontOfficeId- theIdof theQueueproxy- a proxy- Returns:
- a
QueueResourcingSession - Throws:
NotFoundException- noFrontOfficefound by the given IdNullArgumentException-frontOfficeIdorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsQueueResourcing()orsupportsVisibleFederation()isfalse- Compliance:
optional- This method must be implemented if {@code supportsQueueResourcing()} and {@code supportsVisibleFederation()} are {@code true}
-
getFrontOfficeLookupSession
Gets theOsidSessionassociated with the front office lookup service.- Parameters:
proxy- a proxy- Returns:
- a
FrontOfficeLookupSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFrontOfficeLookup()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFrontOfficeLookup()} is {@code true} .
-
getFrontOfficeQuerySession
Gets theOsidSessionassociated with the front office query service.- Parameters:
proxy- a proxy- Returns:
- a
FrontOfficeQuerySession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFrontOfficeQuery()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFrontOfficeQuery()} is {@code true} .
-
getFrontOfficeSearchSession
Gets theOsidSessionassociated with the front office search service.- Parameters:
proxy- a proxy- Returns:
- a
FrontOfficeSearchSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFrontOfficeSearch()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFrontOfficeSearch()} is {@code true} .
-
getFrontOfficeAdminSession
Gets theOsidSessionassociated with the front office administrative service.- Parameters:
proxy- a proxy- Returns:
- a
FrontOfficeAdminSession - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFrontOfficeAdmin()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFrontOfficeAdmin()} is {@code true} .
-
getFrontOfficeNotificationSession
FrontOfficeNotificationSession getFrontOfficeNotificationSession(FrontOfficeReceiver frontOfficeReceiver, Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the front office notification service.- Parameters:
frontOfficeReceiver- the notification callbackproxy- a proxy- Returns:
- a
FrontOfficeNotificationSession - Throws:
NullArgumentException-frontOfficeReceiverorproxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFrontOfficeNotification()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFrontOfficeNotification()} is {@code true} .
-
getFrontOfficeHierarchySession
FrontOfficeHierarchySession getFrontOfficeHierarchySession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the front office hierarchy service.- Parameters:
proxy- a proxy- Returns:
- a
FrontOfficeHierarchySessionfor frontOffices - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFrontOfficeHierarchy()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFrontOfficeHierarchy()} is {@code true} .
-
getFrontOfficeHierarchyDesignSession
FrontOfficeHierarchyDesignSession getFrontOfficeHierarchyDesignSession(Proxy proxy) throws OperationFailedException Gets theOsidSessionassociated with the front office hierarchy design service.- Parameters:
proxy- a proxy- Returns:
- a
HierarchyDesignSessionfor frontOffices - Throws:
NullArgumentException-proxyisnullOperationFailedException- unable to complete requestUnimplementedException-supportsFrontOfficeHierarchyDesign()isfalse- Compliance:
optional- This method must be implemented if {@code supportsFrontOfficeHierarchyDesign()} is {@code true} .
-
getTrackingRulesProxyManager
Gets aTrackingRulesProxyManager.- Returns:
- a
TrackingRulesProxyManager - Throws:
OperationFailedException- unable to complete requestUnimplementedException-supportsTrackingRules()isfalse- Compliance:
optional- This method must be implemented if {@code supportsTrackingRules()} is {@code true} .
-