OSID - osid.tracking.TrackingProfile Service Interface Definition

Interface	osid.tracking.TrackingProfile
Implements	`osid.OsidProfile`
Implemented By	`osid.tracking.TrackingManager`
Implemented By	`osid.tracking.TrackingProxyManager`
Description	The tracking profile describes the interoperability among tracking services.
Method	supportsVisibleFederation
Description	Tests if any front office federation is exposed. Federation is exposed when a specific front office may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of front offices appears as a single front office.
Return	`boolean`		`true` if visible federation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsMyIssue
Description	Tests if an issue service is supported for the current agent.
Return	`boolean`		`true` if my issue is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueTracking
Description	Tests if an issue tracking service is supported.
Return	`boolean`		`true` if issue tracking is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueResourcing
Description	Tests if an issue resourcing service is supported.
Return	`boolean`		`true` if issue resourcing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueTriaging
Description	Tests if an issue triaging service is supported.
Return	`boolean`		`true` if issue triaging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueLookup
Description	Tests if looking up issues is supported.
Return	`boolean`		`true` if issue lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueQuery
Description	Tests if querying issues is supported.
Return	`boolean`		`true` if issue query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueSearch
Description	Tests if searching issues is supported.
Return	`boolean`		`true` if issue search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueAdmin
Description	Tests if issue administrative service is supported.
Return	`boolean`		`true` if issue administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueNotification
Description	Tests if an issue notification service is supported.
Return	`boolean`		`true` if issue notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueFrontOffice
Description	Tests if an issue front office lookup service is supported.
Return	`boolean`		`true` if an issue front office lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueFrontOfficeAssignment
Description	Tests if an issue front office assignment service is supported.
Return	`boolean`		`true` if an issue to front office assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueSmartFrontOffice
Description	Tests if an issue smart front office service is supported.
Return	`boolean`		`true` if an issue smart front office service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubtaskIssueLookup
Description	Tests if looking up subtasks is supported.
Return	`boolean`		`true` if subtask lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsSubtaskIssueAdmin
Description	Tests if managing subtasks is supported.
Return	`boolean`		`true` if subtask admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDuplicateIssueLookup
Description	Tests if looking up duplicate issues is supported.
Return	`boolean`		`true` if duplicate issue lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsDuplicateIssueAdmin
Description	Tests if managing duplicate issues is supported.
Return	`boolean`		`true` if duplicate issue admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchedIssueLookup
Description	Tests if looking up issue branches is supported.
Return	`boolean`		`true` if branched issue lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBranchedIssueAdmin
Description	Tests if managing issue branches is supported.
Return	`boolean`		`true` if branched issue admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockingIssueLookup
Description	Tests if looking up blocking issues is supported.
Return	`boolean`		`true` if blocking issue lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsBlockingIssueAdmin
Description	Tests if managing issue blocks is supported.
Return	`boolean`		`true` if blocking issue admin is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLogEntryLookup
Description	Tests if looking up log entries is supported.
Return	`boolean`		`true` if log entry lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueMessaging
Description	Tests if issue commenting and customer messaging is supported.
Return	`boolean`		`true` if issue messaging is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsLogEntryNotification
Description	Tests if log entry notification is supported.
Return	`boolean`		`true` if log entry notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueLookup
Description	Tests if looking up queues is supported.
Return	`boolean`		`true` if queue lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueQuery
Description	Tests if querying queues is supported.
Return	`boolean`		`true` if queue query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueSearch
Description	Tests if searching queues is supported.
Return	`boolean`		`true` if queue search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueAdmin
Description	Tests if queue administrative service is supported.
Return	`boolean`		`true` if queue administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueNotification
Description	Tests if a queue notification service is supported.
Return	`boolean`		`true` if queue notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueFrontOffice
Description	Tests if a queue front office lookup service is supported.
Return	`boolean`		`true` if a queue front office lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueFrontOfficeAssignment
Description	Tests if a queue front office service is supported.
Return	`boolean`		`true` if queue to front office assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueSmartFrontOffice
Description	Tests if a queue smart front office lookup service is supported.
Return	`boolean`		`true` if a queue smart front office service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueResourcing
Description	Tests if a queue resourcing is supported.
Return	`boolean`		`true` if a queue resourcing service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFrontOfficeLookup
Description	Tests if looking up front offices is supported.
Return	`boolean`		`true` if front office lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFrontOfficeQuery
Description	Tests if querying front offices is supported.
Return	`boolean`		`true` if a front office query service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFrontOfficeSearch
Description	Tests if searching front offices is supported.
Return	`boolean`		`true` if front office search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFrontOfficeAdmin
Description	Tests if front office administrative service is supported.
Return	`boolean`		`true` if front office administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFrontOfficeNotification
Description	Tests if a front office notification service is supported.
Return	`boolean`		`true` if front office notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsFrontOfficeHierarchy
Description	Tests for the availability of a front office hierarchy traversal service.
Return	`boolean`		`true` if front office hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsFrontOfficeHierarchyDesign
Description	Tests for the availability of a front office hierarchy design service.
Return	`boolean`		`true` if front office hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsTrackingRules
Description	Tests for the availability of a tracking rules service.
Return	`boolean`		`true` if a tracking rules service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueRecordTypes
Description	Gets the supported `Issue` record types.
Return	`osid.type.TypeList`		a list containing the supported `Issue` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueRecordType
Description	Tests if the given `Issue` record type is supported.
Parameters	`osid.type.Type`	`issueRecordType`	a `Type` indicating an `Issue` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`issueRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIssueSearchRecordTypes
Description	Gets the supported `Issue` search types.
Return	`osid.type.TypeList`		a list containing the supported `Issue` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsIssueSearchRecordType
Description	Tests if the given `Issue` search type is supported.
Parameters	`osid.type.Type`	`issueSearchRecordType`	a `Type` indicating an `Issue` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`issueSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLogEntryRecordTypes
Description	Gets the supported `LogEntry` record types.
Return	`osid.type.TypeList`		a list containing the supported `LogEntry` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsLogEntryRecordType
Description	Tests if the given `LogEntry` record type is supported.
Parameters	`osid.type.Type`	`logEntryRecordType`	a `Type` indicating a `LogEntry` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`logEntryRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getQueueRecordTypes
Description	Gets the supported `Queue` record types.
Return	`osid.type.TypeList`		a list containing the supported `Queue` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueRecordType
Description	Tests if the given `Queue` record type is supported.
Parameters	`osid.type.Type`	`queueRecordType`	a `Type` indicating a `Queue` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`queueRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getQueueSearchRecordTypes
Description	Gets the supported `Queue` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Queue` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsQueueSearchRecordType
Description	Tests if the given `Queue` search record type is supported.
Parameters	`osid.type.Type`	`queueSearchRecordType`	a `Type` indicating a `Queue` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`queueSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOfficeRecordTypes
Description	Gets the supported `FrontOffice` record types.
Return	`osid.type.TypeList`		a list containing the supported `FrontOffice` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsFrontOfficeRecordType
Description	Tests if the given `FrontOffice` record type is supported.
Parameters	`osid.type.Type`	`frontOfficeRecordType`	a `Type` indicating a `FrontOffice` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`frontOfficeRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getFrontOfficeSearchRecordTypes
Description	Gets the supported `FrontOffice` search record types.
Return	`osid.type.TypeList`		a list containing the supported `FrontOffice` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsFrontOfficeSearchRecordType
Description	Tests if the given `FrontOffice` search record type is supported.
Parameters	`osid.type.Type`	`frontOfficeSearchRecordType`	a `Type` indicating a `FrontOffice` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`frontOfficeSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.