Interface | osid.tracking.TrackingManager | ||
---|---|---|---|
Implements | osid.OsidManager | ||
osid.tracking.TrackingProfile | |||
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:
| ||
Method | getMyIssueSession | ||
Description |
Gets the | ||
Return | osid.tracking.MyIssueSession | a MyIssueSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsMyIssue() is false | ||
Compliance | optional | This method must be implemented if supportsMyIssue() is
true. | |
Method | getMyIssueSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.MyIssueSession | a MyIssueLookupSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsMyIssue() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsMyIssue() and
supportsVisibleFederation() are true | |
Method | getIssueTrackingSession | ||
Description |
Gets the | ||
Return | osid.tracking.IssueTrackingSession | an IssueTrackingSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsIssueTracking() is false | ||
Compliance | optional | This method must be implemented if supportsIssueTracking()
is true. | |
Method | getIssueTrackingSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.IssueTrackingSession | an IssueTrackingSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueTracking() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsIssueTracking()
and supportsVisibleFederation() are true | |
Method | getIssueResourcingSession | ||
Description |
Gets the | ||
Return | osid.tracking.IssueResourcingSession | an IssueResourcingSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsIssueResourcing() is false | ||
Compliance | optional | This method must be implemented if supportsIssueResourcing()
is true. | |
Method | getIssueResourcingSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.IssueResourcingSession | an IssueResourcingSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueResourcing() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsIssueResourcing()
and supportsVisibleFederation() are true | |
Method | getIssueTriagingSession | ||
Description |
Gets the | ||
Return | osid.tracking.IssueTriagingSession | an IssueTriagingSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsMyIssueLookup() is false | ||
Compliance | optional | This method must be implemented if supportsIssueTriaging()
is true. | |
Method | getIssueTriagingSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.IssueTriagingSession | an IssueTriagingSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueTriaging() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsIssueTriaging()
and supportsVisibleFederation() are true | |
Method | getIssueLookupSession | ||
Description |
Gets the | ||
Return | osid.tracking.IssueLookupSession | an IssueLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsIssueLookup() is false | ||
Compliance | optional | This method must be implemented if supportsIssueLookup() is
true. | |
Method | getIssueLookupSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.IssueLookupSession | an IssueLookupSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsIssueLookup() and
supportsVisibleFederation() are true | |
Method | getIssueQuerySession | ||
Description |
Gets the | ||
Return | osid.tracking.IssueQuerySession | an IssueQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsIssueQuery() is false | ||
Compliance | optional | This method must be implemented if supportsIssueQuery() is
true. | |
Method | getIssueQuerySessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.IssueQuerySession | an IssueQuerySession | |
Errors | NOT_FOUND | no front office found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsIssueQuery() and
supportsVisibleFederation() are true | |
Method | getIssueSearchSession | ||
Description |
Gets the | ||
Return | osid.tracking.IssueSearchSession | an IssueSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsIssueSearch() is false | ||
Compliance | optional | This method must be implemented if supportsIssueSearch() is
true. | |
Method | getIssueSearchSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.IssueSearchSession | an IssueSearchSession | |
Errors | NOT_FOUND | no front office found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsIssueSearch() and
supportsVisibleFederation() are true | |
Method | getIssueAdminSession | ||
Description |
Gets the | ||
Return | osid.tracking.IssueAdminSession | an IssueAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsIssueAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsIssueAdmin() is
true. | |
Method | getIssueAdminSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.IssueAdminSession | an IssueAdminSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsIssueAdmin() and
supportsVisibleFederation() are true | |
Method | getIssueNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.tracking.IssueReceiver | issueReceiver | the notification callback |
Return | osid.tracking.IssueNotificationSession | an IssueNotificationSession | |
Errors | NULL_ARGUMENT | issueReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueNotification() is false | ||
Compliance | optional | This method must be implemented if supportsIssueNotification()
is true. | |
Method | getIssueNotificationSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.tracking.IssueReceiver | issueReceiver | the notification callback |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
Return | osid.tracking.IssueNotificationSession | an IssueNotificationSession | |
Errors | NOT_FOUND | no front office found by the given Id | |
NULL_ARGUMENT | issueReceiver or frontOfficeId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsIssueNotification()
and supportsVisibleFederation() are true | |
Method | getIssueFrontOfficeSession | ||
Description |
Gets the | ||
Return | osid.tracking.IssueFrontOfficeSession | an IssueFrontOfficeSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsIssueFrontOffice() is false | ||
Compliance | optional | This method must be implemented if supportsIssueFrontOffice()
is true. | |
Method | getIssueFrontOfficeAssignmentSession | ||
Description |
Gets the | ||
Return | osid.tracking.IssueFrontOfficeAssignmentSession | an IssueFrontOfficeAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsIssueFrontOfficeAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsIssueFrontOfficeAssignment() is true. | |
Method | getIssueSmartFrontOfficeSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.IssueSmartFrontOfficeSession | an IssueSmartFrontOfficeSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueSmartFrontOffice() is false | ||
Compliance | optional | This method must be implemented if supportsIssueSmartFrontOffice()
is true. | |
Method | getSubtaskIssueLookupSession | ||
Description |
Gets the | ||
Return | osid.tracking.SubtaskIssueLookupSession | a SubtaskIssueLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubtaskIssueLookup() is false | ||
Compliance | optional | This method must be implemented if supportsSubtaskIssueLookup()
is true. | |
Method | getSubtaskIssueLookupSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.SubtaskIssueLookupSession | a SubtaskIssueLookupSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubtaskIssueLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubtaskIssueLookup()
and supportsVisibleFederation() are true | |
Method | getSubtaskIssueAdminSession | ||
Description |
Gets the | ||
Return | osid.tracking.SubtaskIssueAdminSession | a SubtaskIssueAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsSubtaskIssueAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsSubtaskIssueAdmin()
is true. | |
Method | getSubtaskIssueAdminSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.SubtaskIssueAdminSession | a SubtaskIssueAdminSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsSubtaskIssueAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsSubtaskIssueAdmin()
and supportsVisibleFederation() are true | |
Method | getDuplicateIssueLookupSession | ||
Description |
Gets the | ||
Return | osid.tracking.DuplicateIssueLookupSession | a DuplicateIssueLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDuplicateIssueLookup() is false | ||
Compliance | optional | This method must be implemented if supportsDuplicateIssueLookup()
is true. | |
Method | getDuplicateIssueLookupSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.DuplicateIssueLookupSession | a DuplicateIssueLookupSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDuplicateIssueLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDuplicateIssueLookup()
and supportsVisibleFederation() are true | |
Method | getDuplicateIssueAdminSession | ||
Description |
Gets the | ||
Return | osid.tracking.DuplicateIssueAdminSession | a DuplicateIssueAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsDuplicateIssueAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsDuplicateIssueAdmin()
is true. | |
Method | getDuplicateIssueAdminSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.DuplicateIssueAdminSession | a DuplicateIssueAdminSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsDuplicateIssueAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsDuplicateIssueAdmin()
and supportsVisibleFederation() are true | |
Method | getBranchedIssueLookupSession | ||
Description |
Gets the | ||
Return | osid.tracking.BranchedIssueLookupSession | a BranchedIssueLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBranchedIssueLookup() is false | ||
Compliance | optional | This method must be implemented if supportsBranchedIssueLookup()
is true. | |
Method | getBranchedIssueLookupSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.BranchedIssueLookupSession | a BranchedIssueLookupSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchedIssueLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsBranchedIssueLookup()
and supportsVisibleFederation() are true | |
Method | getBranchedIssueAdminSession | ||
Description |
Gets the | ||
Return | osid.tracking.BranchedIssueAdminSession | a BranchedIssueAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBranchedIssueAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBranchedIssueAdmin()
is true. | |
Method | getBranchedIssueAdminSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.BranchedIssueAdminSession | a BranchedIssueAdminSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBranchedIssueAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsBranchedIssueAdmin()
and supportsVisibleFederation() are true | |
Method | getBlockingIssueLookupSession | ||
Description |
Gets the | ||
Return | osid.tracking.BlockingIssueLookupSession | a BlockingIssueLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBlockingIssueLookup() is false | ||
Compliance | optional | This method must be implemented if supportsBlockingIssueLookup()
is true. | |
Method | getBlockingIssueLookupSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.BlockingIssueLookupSession | a BlockingIssueLookupSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockingIssueLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsBlockingIssueLookup()
and supportsVisibleFederation() are true | |
Method | getBlockingIssueAdminSession | ||
Description |
Gets the | ||
Return | osid.tracking.BlockingIssueAdminSession | a BlockingIssueAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsBlockingIssueAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsBlockingIssueAdmin()
is true. | |
Method | getBlockingIssueAdminSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the front office |
Return | osid.tracking.BlockingIssueAdminSession | a BlockingIssueAdminSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsBlockingIssueAdmin() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsBlockingIssueAdmin()
and supportsVisibleFederation() are true | |
Method | getLogEntryLookupSession | ||
Description |
Gets the | ||
Return | osid.tracking.LogEntryLookupSession | a LogEntryLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsLogEntryLookup() is false | ||
Compliance | optional | This method must be implemented if supportsLogEntryLookup()
is true. | |
Method | getLogEntryLookupSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.LogEntryLookupSession | a LogEntryLookupSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLogEntryLookup() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsLogEntryLookup()
and supportsVisibleFederation() are true | |
Method | getIssueMessagingSession | ||
Description |
Gets the | ||
Return | osid.tracking.IssueMessagingSession | an IssueMessagingSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsIssueMessaging() is false | ||
Compliance | optional | This method must be implemented if supportsIssueMessaging()
is true. | |
Method | getIssueMessagingSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.IssueMessagingSession | an IssueMessagingSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsIssueMessaging() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsIssueMessaging()
and supportsVisibleFederation() are true | |
Method | getLogEntryNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.tracking.LogEntryReceiver | logEntryReceiver | the notification callback |
Return | osid.tracking.LogEntryNotificationSession | a LogEntryNotificationSession | |
Errors | NULL_ARGUMENT | logEntryReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLogEntryNotification() is false | ||
Compliance | optional | This method must be implemented if supportsLogEntryNotification()
is true. | |
Method | getLogEntryNotificationSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.tracking.LogEntryReceiver | logEntryReceiver | the notification callback |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
Return | osid.tracking.LogEntryNotificationSession | a LogEntryNotificationSession | |
Errors | NOT_FOUND | no front office found by the given Id | |
NULL_ARGUMENT | logEntryReceiver or frontOfficeId is
null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsLogEntryNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsLogEntryNotification()
and supportsVisibleFederation() are true | |
Method | getQueueLookupSession | ||
Description |
Gets the | ||
Return | osid.tracking.QueueLookupSession | a QueueLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsQueueLookup() is false | ||
Compliance | optional | This method must be implemented if supportsQueueLookup() is
true. | |
Method | getQueueLookupSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.QueueLookupSession | a QueueLookupSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueLookup() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsQueueLookup() and
supportsVisibleFederation() are true | |
Method | getQueueQuerySession | ||
Description |
Gets the | ||
Return | osid.tracking.QueueQuerySession | a QueueQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsQueueQuery() is false | ||
Compliance | optional | This method must be implemented if supportsQueueQuery() is
true. | |
Method | getQueueQuerySessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.QueueQuerySession | a QueueQuerySession | |
Errors | NOT_FOUND | no front office found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueQuery() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsQueueQuery() and
supportsVisibleFederation() are true | |
Method | getQueueSearchSession | ||
Description |
Gets the | ||
Return | osid.tracking.QueueSearchSession | a QueueSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsQueueSearch() is false | ||
Compliance | optional | This method must be implemented if supportsQueueSearch() is
true. | |
Method | getQueueSearchSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.QueueSearchSession | a QueueSearchSession | |
Errors | NOT_FOUND | no front office found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueSearch() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsQueueSearch() and
supportsVisibleFederation() are true | |
Method | getQueueAdminSession | ||
Description |
Gets the | ||
Return | osid.tracking.QueueAdminSession | a QueueAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsQueueAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsQueueAdmin() is
true. | |
Method | getQueueAdminSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.QueueAdminSession | a QueueAdminSession | |
Errors | NOT_FOUND | no front office found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueAdmin() or supportsVisibleFederation()
is false | ||
Compliance | optional | This method must be implemented if supportsQueueAdmin() and
supportsVisibleFederation() are true | |
Method | getQueueNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.tracking.QueueReceiver | queueReceiver | the notification callback |
Return | osid.tracking.QueueNotificationSession | a QueueNotificationSession | |
Errors | NULL_ARGUMENT | queueReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueNotification() is false | ||
Compliance | optional | This method must be implemented if supportsQueueNotification()
is true. | |
Method | getQueueNotificationSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.tracking.QueueReceiver | queueReceiver | the notification callback |
osid.id.Id | frontOfficeId | the Id of the FrontOffice | |
Return | osid.tracking.QueueNotificationSession | a QueueNotificationSession | |
Errors | NOT_FOUND | no front office found by the given Id | |
NULL_ARGUMENT | queueReceiver or frontOfficeId is null
| ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueNotification() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsQueueNotification()
and supportsVisibleFederation() are true | |
Method | getQueueFrontOfficeSession | ||
Description |
Gets the | ||
Return | osid.tracking.QueueFrontOfficeSession | a QueueFrontOfficeSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsQueueFrontOffice() is false | ||
Compliance | optional | This method must be implemented if supportsQueueFrontOffice()
is true. | |
Method | getQueueFrontOfficeAssignmentSession | ||
Description |
Gets the | ||
Return | osid.tracking.QueueFrontOfficeAssignmentSession | a QueueFrontOfficeAssignmentSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsQueueFrontOfficeAssignment() is false | ||
Compliance | optional | This method must be implemented if
supportsQueueFrontOfficeAssignment() is true. | |
Method | getQueueSmartFrontOfficeSession | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.QueueSmartFrontOfficeSession | a QueueSmartFrontOfficeSession | |
Errors | NOT_FOUND | no front office found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueSmartFrontOffice() is false | ||
Compliance | optional | This method must be implemented if supportsQueueSmartFrontOffice()
is true. | |
Method | getQueueResourcingSession | ||
Description |
Gets the | ||
Return | osid.tracking.QueueResourcingSession | a QueueResourcingSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsQueueResourcing() is false | ||
Compliance | optional | This method must be implemented if supportsQueueResourcing()
is true. | |
Method | getQueueResourcingSessionForFrontOffice | ||
Description |
Gets the | ||
Parameters | osid.id.Id | frontOfficeId | the Id of the FrontOffice |
Return | osid.tracking.QueueResourcingSession | a QueueResourcingSession | |
Errors | NOT_FOUND | no FrontOffice found by the given Id | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsQueueResourcing() or
supportsVisibleFederation() is false | ||
Compliance | optional | This method must be implemented if supportsQueueResourcing()
and supportsVisibleFederation() are true | |
Method | getFrontOfficeLookupSession | ||
Description |
Gets the | ||
Return | osid.tracking.FrontOfficeLookupSession | a FrontOfficeLookupSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFrontOfficeLookup() is false | ||
Compliance | optional | This method must be implemented if supportsFrontOfficeLookup()
is true. | |
Method | getFrontOfficeQuerySession | ||
Description |
Gets the | ||
Return | osid.tracking.FrontOfficeQuerySession | a FrontOfficeQuerySession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFrontOfficeQuery() is false | ||
Compliance | optional | This method must be implemented if supportsFrontOfficeQuery()
is true. | |
Method | getFrontOfficeSearchSession | ||
Description |
Gets the | ||
Return | osid.tracking.FrontOfficeSearchSession | a FrontOfficeSearchSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFrontOfficeSearch() is false | ||
Compliance | optional | This method must be implemented if supportsFrontOfficeSearch()
is true. | |
Method | getFrontOfficeAdminSession | ||
Description |
Gets the | ||
Return | osid.tracking.FrontOfficeAdminSession | a FrontOfficeAdminSession | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFrontOfficeAdmin() is false | ||
Compliance | optional | This method must be implemented if supportsFrontOfficeAdmin()
is true. | |
Method | getFrontOfficeNotificationSession | ||
Description |
Gets the | ||
Parameters | osid.tracking.FrontOfficeReceiver | frontOfficeReceiver | the notification callback |
Return | osid.tracking.FrontOfficeNotificationSession | a FrontOfficeNotificationSession | |
Errors | NULL_ARGUMENT | frontOfficeReceiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNIMPLEMENTED | supportsFrontOfficeNotification() is false | ||
Compliance | optional | This method must be implemented if supportsFrontOfficeNotification()
is true. | |
Method | getFrontOfficeHierarchySession | ||
Description |
Gets the | ||
Return | osid.tracking.FrontOfficeHierarchySession | a hierarchy design session for front offices | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFrontOfficeHierarchy() is false | ||
Compliance | optional | This method must be implemented if supportsFrontOfficeHierarchy()
is true. | |
Method | getFrontOfficeHierarchyDesignSession | ||
Description |
Gets the | ||
Return | osid.tracking.FrontOfficeHierarchyDesignSession | a hierarchy design session for front offices | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsFrontOfficeHierarchyDesign() is false | ||
Compliance | optional | This method must be implemented if
supportsFrontOfficeHierarchyDesign() is true. | |
Method | getTrackingRulesManager | ||
Description |
Gets a | ||
Return | osid.tracking.rules.TrackingRulesManager | a TrackingRulesManager | |
Errors | OPERATION_FAILED | unable to complete request | |
UNIMPLEMENTED | supportsTrackingRules() is false | ||
Compliance | optional | This method must be implemented if supportsTrackingRules()
is true. |