OSID Logo
OSID Specifications
tracking package
Version 3.0.0
Interfaceosid.tracking.TrackingManager
Implementsosid.OsidManager
osid.tracking.TrackingProfile
Used Byosid.orchestration.OrchestrationManager
Description

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
MethodgetMyIssueSession
Description

Gets the OsidSession associated with the my issue service.

Returnosid.tracking.MyIssueSessiona MyIssueSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsMyIssue() is false
ComplianceoptionalThis method must be implemented if supportsMyIssue() is true .
MethodgetMyIssueSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.MyIssueSessiona MyIssueLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsMyIssue() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsMyIssue() and supportsVisibleFederation() are true
MethodgetIssueTrackingSession
Description

Gets the OsidSession associated with the issue tracking service.

Returnosid.tracking.IssueTrackingSessionan IssueTrackingSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueTracking() is false
ComplianceoptionalThis method must be implemented if supportsIssueTracking() is true .
MethodgetIssueTrackingSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.IssueTrackingSessionan IssueTrackingSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueTracking() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIssueTracking() and supportsVisibleFederation() are true
MethodgetIssueResourcingSession
Description

Gets the OsidSession associated with the issue resourcing service.

Returnosid.tracking.IssueResourcingSessionan IssueResourcingSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueResourcing() is false
ComplianceoptionalThis method must be implemented if supportsIssueResourcing() is true .
MethodgetIssueResourcingSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.IssueResourcingSessionan IssueResourcingSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueResourcing() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIssueResourcing() and supportsVisibleFederation() are true
MethodgetIssueTriagingSession
Description

Gets the OsidSession associated with the issue triaging service.

Returnosid.tracking.IssueTriagingSessionan IssueTriagingSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsMyIssueLookup() is false
ComplianceoptionalThis method must be implemented if supportsIssueTriaging() is true .
MethodgetIssueTriagingSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.IssueTriagingSessionan IssueTriagingSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueTriaging() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIssueTriaging() and supportsVisibleFederation() are true
MethodgetIssueLookupSession
Description

Gets the OsidSession associated with the issue lookup service.

Returnosid.tracking.IssueLookupSessionan IssueLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueLookup() is false
ComplianceoptionalThis method must be implemented if supportsIssueLookup() is true .
MethodgetIssueLookupSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.IssueLookupSessionan IssueLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIssueLookup() and supportsVisibleFederation() are true
MethodgetIssueQuerySession
Description

Gets the OsidSession associated with the issue query service.

Returnosid.tracking.IssueQuerySessionan IssueQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueQuery() is false
ComplianceoptionalThis method must be implemented if supportsIssueQuery() is true .
MethodgetIssueQuerySessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.IssueQuerySessionan IssueQuerySession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIssueQuery() and supportsVisibleFederation() are true
MethodgetIssueSearchSession
Description

Gets the OsidSession associated with the issue search service.

Returnosid.tracking.IssueSearchSessionan IssueSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueSearch() is false
ComplianceoptionalThis method must be implemented if supportsIssueSearch() is true .
MethodgetIssueSearchSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.IssueSearchSessionan IssueSearchSession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIssueSearch() and supportsVisibleFederation() are true
MethodgetIssueAdminSession
Description

Gets the OsidSession associated with the issue administration service.

Returnosid.tracking.IssueAdminSessionan IssueAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueAdmin() is false
ComplianceoptionalThis method must be implemented if supportsIssueAdmin() is true .
MethodgetIssueAdminSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.IssueAdminSessionan IssueAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIssueAdmin() and supportsVisibleFederation() are true
MethodgetIssueNotificationSession
Description

Gets the OsidSession associated with the issue notification service.

Parametersosid.tracking.IssueReceiverissueReceiverthe notification callback
Returnosid.tracking.IssueNotificationSessionan IssueNotificationSession
ErrorsNULL_ARGUMENTissueReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueNotification() is false
ComplianceoptionalThis method must be implemented if supportsIssueNotification() is true .
MethodgetIssueNotificationSessionForFrontOffice
Description

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

Parametersosid.tracking.IssueReceiverissueReceiverthe notification callback
osid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.IssueNotificationSessionan IssueNotificationSession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENTissueReceiver or frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIssueNotification() and supportsVisibleFederation() are true
MethodgetIssueFrontOfficeSession
Description

Gets the OsidSession to lookup issue/front office trackings.

Returnosid.tracking.IssueFrontOfficeSessionan IssueFrontOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsIssueFrontOffice() is true .
MethodgetIssueFrontOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning issues to frontOffices.

Returnosid.tracking.IssueFrontOfficeAssignmentSessionan IssueFrontOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueFrontOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsIssueFrontOfficeAssignment() is true .
MethodgetIssueSmartFrontOfficeSession
Description

Gets the OsidSession to manage locatin smart frontOffices.

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.IssueSmartFrontOfficeSessionan IssueSmartFrontOfficeSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueSmartFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsIssueSmartFrontOffice() is true .
MethodgetSubtaskIssueLookupSession
Description

Gets the OsidSession associated with the subtask issue lookup service.

Returnosid.tracking.SubtaskIssueLookupSessiona SubtaskIssueLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubtaskIssueLookup() is false
ComplianceoptionalThis method must be implemented if supportsSubtaskIssueLookup() is true .
MethodgetSubtaskIssueLookupSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.SubtaskIssueLookupSessiona SubtaskIssueLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubtaskIssueLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubtaskIssueLookup() and supportsVisibleFederation() are true
MethodgetSubtaskIssueAdminSession
Description

Gets the OsidSession associated with the subtask issue administration service.

Returnosid.tracking.SubtaskIssueAdminSessiona SubtaskIssueAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubtaskIssueAdmin() is false
ComplianceoptionalThis method must be implemented if supportsSubtaskIssueAdmin() is true .
MethodgetSubtaskIssueAdminSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.SubtaskIssueAdminSessiona SubtaskIssueAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsSubtaskIssueAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsSubtaskIssueAdmin() and supportsVisibleFederation() are true
MethodgetDuplicateIssueLookupSession
Description

Gets the OsidSession associated with the duplicate issue lookup service.

Returnosid.tracking.DuplicateIssueLookupSessiona DuplicateIssueLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDuplicateIssueLookup() is false
ComplianceoptionalThis method must be implemented if supportsDuplicateIssueLookup() is true .
MethodgetDuplicateIssueLookupSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.DuplicateIssueLookupSessiona DuplicateIssueLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDuplicateIssueLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDuplicateIssueLookup() and supportsVisibleFederation() are true
MethodgetDuplicateIssueAdminSession
Description

Gets the OsidSession associated with the duplicate issue administration service.

Returnosid.tracking.DuplicateIssueAdminSessiona DuplicateIssueAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDuplicateIssueAdmin() is false
ComplianceoptionalThis method must be implemented if supportsDuplicateIssueAdmin() is true .
MethodgetDuplicateIssueAdminSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.DuplicateIssueAdminSessiona DuplicateIssueAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsDuplicateIssueAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsDuplicateIssueAdmin() and supportsVisibleFederation() are true
MethodgetBranchedIssueLookupSession
Description

Gets the OsidSession associated with the branched issue lookup service.

Returnosid.tracking.BranchedIssueLookupSessiona BranchedIssueLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBranchedIssueLookup() is false
ComplianceoptionalThis method must be implemented if supportsBranchedIssueLookup() is true .
MethodgetBranchedIssueLookupSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.BranchedIssueLookupSessiona BranchedIssueLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBranchedIssueLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBranchedIssueLookup() and supportsVisibleFederation() are true
MethodgetBranchedIssueAdminSession
Description

Gets the OsidSession associated with the branched issue administration service.

Returnosid.tracking.BranchedIssueAdminSessiona BranchedIssueAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBranchedIssueAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBranchedIssueAdmin() is true .
MethodgetBranchedIssueAdminSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.BranchedIssueAdminSessiona BranchedIssueAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBranchedIssueAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBranchedIssueAdmin() and supportsVisibleFederation() are true
MethodgetBlockingIssueLookupSession
Description

Gets the OsidSession associated with the blocking issue lookup service.

Returnosid.tracking.BlockingIssueLookupSessiona BlockingIssueLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBlockingIssueLookup() is false
ComplianceoptionalThis method must be implemented if supportsBlockingIssueLookup() is true .
MethodgetBlockingIssueLookupSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.BlockingIssueLookupSessiona BlockingIssueLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBlockingIssueLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBlockingIssueLookup() and supportsVisibleFederation() are true
MethodgetBlockingIssueAdminSession
Description

Gets the OsidSession associated with the blocking issue administration service.

Returnosid.tracking.BlockingIssueAdminSessiona BlockingIssueAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBlockingIssueAdmin() is false
ComplianceoptionalThis method must be implemented if supportsBlockingIssueAdmin() is true .
MethodgetBlockingIssueAdminSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the front office
Returnosid.tracking.BlockingIssueAdminSessiona BlockingIssueAdminSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsBlockingIssueAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsBlockingIssueAdmin() and supportsVisibleFederation() are true
MethodgetLogEntryLookupSession
Description

Gets the OsidSession associated with the log entry lookup service.

Returnosid.tracking.LogEntryLookupSessiona LogEntryLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsLogEntryLookup() is false
ComplianceoptionalThis method must be implemented if supportsLogEntryLookup() is true .
MethodgetLogEntryLookupSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.LogEntryLookupSessiona LogEntryLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsLogEntryLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLogEntryLookup() and supportsVisibleFederation() are true
MethodgetIssueMessagingSession
Description

Gets the OsidSession associated with the issue messaging service.

Returnosid.tracking.IssueMessagingSessionan IssueMessagingSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueMessaging() is false
ComplianceoptionalThis method must be implemented if supportsIssueMessaging() is true .
MethodgetIssueMessagingSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.IssueMessagingSessionan IssueMessagingSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsIssueMessaging() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsIssueMessaging() and supportsVisibleFederation() are true
MethodgetLogEntryNotificationSession
Description

Gets the OsidSession associated with the log entry notification service.

Parametersosid.tracking.LogEntryReceiverlogEntryReceiverthe notification callback
Returnosid.tracking.LogEntryNotificationSessiona LogEntryNotificationSession
ErrorsNULL_ARGUMENTlogEntryReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsLogEntryNotification() is false
ComplianceoptionalThis method must be implemented if supportsLogEntryNotification() is true .
MethodgetLogEntryNotificationSessionForFrontOffice
Description

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

Parametersosid.tracking.LogEntryReceiverlogEntryReceiverthe notification callback
osid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.LogEntryNotificationSessiona LogEntryNotificationSession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENTlogEntryReceiver or frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsLogEntryNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsLogEntryNotification() and supportsVisibleFederation() are true
MethodgetQueueLookupSession
Description

Gets the OsidSession associated with the queue lookup service.

Returnosid.tracking.QueueLookupSessiona QueueLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueLookup() is false
ComplianceoptionalThis method must be implemented if supportsQueueLookup() is true .
MethodgetQueueLookupSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.QueueLookupSessiona QueueLookupSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueLookup() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueLookup() and supportsVisibleFederation() are true
MethodgetQueueQuerySession
Description

Gets the OsidSession associated with the queue query service.

Returnosid.tracking.QueueQuerySessiona QueueQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueQuery() is false
ComplianceoptionalThis method must be implemented if supportsQueueQuery() is true .
MethodgetQueueQuerySessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.QueueQuerySessiona QueueQuerySession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueQuery() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueQuery() and supportsVisibleFederation() are true
MethodgetQueueSearchSession
Description

Gets the OsidSession associated with the queue search service.

Returnosid.tracking.QueueSearchSessiona QueueSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueSearch() is false
ComplianceoptionalThis method must be implemented if supportsQueueSearch() is true .
MethodgetQueueSearchSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.QueueSearchSessiona QueueSearchSession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueSearch() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueSearch() and supportsVisibleFederation() are true
MethodgetQueueAdminSession
Description

Gets the OsidSession associated with the queue administration service.

Returnosid.tracking.QueueAdminSessiona QueueAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueAdmin() is false
ComplianceoptionalThis method must be implemented if supportsQueueAdmin() is true .
MethodgetQueueAdminSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.QueueAdminSessiona QueueAdminSession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueAdmin() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueAdmin() and supportsVisibleFederation() are true
MethodgetQueueNotificationSession
Description

Gets the OsidSession associated with the queue notification service.

Parametersosid.tracking.QueueReceiverqueueReceiverthe notification callback
Returnosid.tracking.QueueNotificationSessiona QueueNotificationSession
ErrorsNULL_ARGUMENTqueueReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueNotification() is false
ComplianceoptionalThis method must be implemented if supportsQueueNotification() is true .
MethodgetQueueNotificationSessionForFrontOffice
Description

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

Parametersosid.tracking.QueueReceiverqueueReceiverthe notification callback
osid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.QueueNotificationSessiona QueueNotificationSession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENTqueueReceiver or frontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueNotification() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueNotification() and supportsVisibleFederation() are true
MethodgetQueueFrontOfficeSession
Description

Gets the OsidSession to lookup queue/front office issues.

Returnosid.tracking.QueueFrontOfficeSessiona QueueFrontOfficeSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsQueueFrontOffice() is true .
MethodgetQueueFrontOfficeAssignmentSession
Description

Gets the OsidSession associated with assigning queues to frontOffices.

Returnosid.tracking.QueueFrontOfficeAssignmentSessiona QueueFrontOfficeAssignmentSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueFrontOfficeAssignment() is false
ComplianceoptionalThis method must be implemented if supportsQueueFrontOfficeAssignment() is true .
MethodgetQueueSmartFrontOfficeSession
Description

Gets the OsidSession to manage queue smart frontOffices.

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.QueueSmartFrontOfficeSessiona QueueSmartFrontOfficeSession
ErrorsNOT_FOUNDno front office found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueSmartFrontOffice() is false
ComplianceoptionalThis method must be implemented if supportsQueueSmartFrontOffice() is true .
MethodgetQueueResourcingSession
Description

Gets the OsidSession associated with the queue resourcing service.

Returnosid.tracking.QueueResourcingSessiona QueueResourcingSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueResourcing() is false
ComplianceoptionalThis method must be implemented if supportsQueueResourcing() is true .
MethodgetQueueResourcingSessionForFrontOffice
Description

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

Parametersosid.id.IdfrontOfficeIdthe Id of the FrontOffice
Returnosid.tracking.QueueResourcingSessiona QueueResourcingSession
ErrorsNOT_FOUNDno FrontOffice found by the given Id
NULL_ARGUMENTfrontOfficeId is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsQueueResourcing() or supportsVisibleFederation() is false
ComplianceoptionalThis method must be implemented if supportsQueueResourcing() and supportsVisibleFederation() are true
MethodgetFrontOfficeLookupSession
Description

Gets the OsidSession associated with the front office lookup service.

Returnosid.tracking.FrontOfficeLookupSessiona FrontOfficeLookupSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFrontOfficeLookup() is false
ComplianceoptionalThis method must be implemented if supportsFrontOfficeLookup() is true .
MethodgetFrontOfficeQuerySession
Description

Gets the OsidSession associated with the front office query service.

Returnosid.tracking.FrontOfficeQuerySessiona FrontOfficeQuerySession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFrontOfficeQuery() is false
ComplianceoptionalThis method must be implemented if supportsFrontOfficeQuery() is true .
MethodgetFrontOfficeSearchSession
Description

Gets the OsidSession associated with the front office search service.

Returnosid.tracking.FrontOfficeSearchSessiona FrontOfficeSearchSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFrontOfficeSearch() is false
ComplianceoptionalThis method must be implemented if supportsFrontOfficeSearch() is true .
MethodgetFrontOfficeAdminSession
Description

Gets the OsidSession associated with the front office administrative service.

Returnosid.tracking.FrontOfficeAdminSessiona FrontOfficeAdminSession
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFrontOfficeAdmin() is false
ComplianceoptionalThis method must be implemented if supportsFrontOfficeAdmin() is true .
MethodgetFrontOfficeNotificationSession
Description

Gets the OsidSession associated with the front office notification service.

Parametersosid.tracking.FrontOfficeReceiverfrontOfficeReceiverthe notification callback
Returnosid.tracking.FrontOfficeNotificationSessiona FrontOfficeNotificationSession
ErrorsNULL_ARGUMENTfrontOfficeReceiver is null
OPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFrontOfficeNotification() is false
ComplianceoptionalThis method must be implemented if supportsFrontOfficeNotification() is true .
MethodgetFrontOfficeHierarchySession
Description

Gets the OsidSession associated with the front office hierarchy service.

Returnosid.tracking.FrontOfficeHierarchySessiona hierarchy design session for front offices
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFrontOfficeHierarchy() is false
ComplianceoptionalThis method must be implemented if supportsFrontOfficeHierarchy() is true .
MethodgetFrontOfficeHierarchyDesignSession
Description

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

Returnosid.tracking.FrontOfficeHierarchyDesignSessiona hierarchy design session for front offices
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsFrontOfficeHierarchyDesign() is false
ComplianceoptionalThis method must be implemented if supportsFrontOfficeHierarchyDesign() is true .
MethodgetTrackingRulesManager
Description

Gets a TrackingRulesManager .

Returnosid.tracking.rules.TrackingRulesManagera TrackingRulesManager
ErrorsOPERATION_FAILEDunable to complete request
UNIMPLEMENTEDsupportsTrackingRules() is false
ComplianceoptionalThis method must be implemented if supportsTrackingRules() is true .