org.osid.tracking

Interface TrackingProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

TrackingManager, TrackingProxyManager

public interface TrackingProfile
extends OsidProfile

The tracking profile describes the interoperability among tracking services.

Method Summary

Methods

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

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

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.

Returns:

true if visible federation is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsMyIssue

boolean supportsMyIssue()

Tests if an issue service is supported for the current agent.

Returns:

true if my issue is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueTracking

boolean supportsIssueTracking()

Tests if an issue tracking service is supported.

Returns:

true if issue tracking is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueResourcing

boolean supportsIssueResourcing()

Tests if an issue resourcing service is supported.

Returns:

true if issue resourcing is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueTriaging

boolean supportsIssueTriaging()

Tests if an issue triaging service is supported.

Returns:

true if issue triaging is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueLookup

boolean supportsIssueLookup()

Tests if looking up issues is supported.

Returns:

true if issue lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueQuery

boolean supportsIssueQuery()

Tests if querying issues is supported.

Returns:

true if issue query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueSearch

boolean supportsIssueSearch()

Tests if searching issues is supported.

Returns:

true if issue search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueAdmin

boolean supportsIssueAdmin()

Tests if issue administrative service is supported.

Returns:

true if issue administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueNotification

boolean supportsIssueNotification()

Tests if an issue notification service is supported.

Returns:

true if issue notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueFrontOffice

boolean supportsIssueFrontOffice()

Tests if an issue front office lookup service is supported.

Returns:

true if an issue front office lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueFrontOfficeAssignment

boolean supportsIssueFrontOfficeAssignment()

Tests if an issue front office assignment service is supported.

Returns:

true if an issue to front office assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueSmartFrontOffice

boolean supportsIssueSmartFrontOffice()

Tests if an issue smart front office service is supported.

Returns:

true if an issue smart front office service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubtaskIssueLookup

boolean supportsSubtaskIssueLookup()

Tests if looking up subtasks is supported.

Returns:

true if subtask lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsSubtaskIssueAdmin

boolean supportsSubtaskIssueAdmin()

Tests if managing subtasks is supported.

Returns:

true if subtask admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDuplicateIssueLookup

boolean supportsDuplicateIssueLookup()

Tests if looking up duplicate issues is supported.

Returns:

true if duplicate issue lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsDuplicateIssueAdmin

boolean supportsDuplicateIssueAdmin()

Tests if managing duplicate issues is supported.

Returns:

true if duplicate issue admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBranchedIssueLookup

boolean supportsBranchedIssueLookup()

Tests if looking up issue branches is supported.

Returns:

true if branched issue lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBranchedIssueAdmin

boolean supportsBranchedIssueAdmin()

Tests if managing issue branches is supported.

Returns:

true if branched issue admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBlockingIssueLookup

boolean supportsBlockingIssueLookup()

Tests if looking up blocking issues is supported.

Returns:

true if blocking issue lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsBlockingIssueAdmin

boolean supportsBlockingIssueAdmin()

Tests if managing issue blocks is supported.

Returns:

true if blocking issue admin is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLogEntryLookup

boolean supportsLogEntryLookup()

Tests if looking up log entries is supported.

Returns:

true if log entry lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsIssueMessaging

boolean supportsIssueMessaging()

Tests if issue commenting and customer messaging is supported.

Returns:

true if issue messaging is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsLogEntryNotification

boolean supportsLogEntryNotification()

Tests if log entry notification is supported.

Returns:

true if log entry notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueLookup

boolean supportsQueueLookup()

Tests if looking up queues is supported.

Returns:

true if queue lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueQuery

boolean supportsQueueQuery()

Tests if querying queues is supported.

Returns:

true if queue query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueSearch

boolean supportsQueueSearch()

Tests if searching queues is supported.

Returns:

true if queue search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueAdmin

boolean supportsQueueAdmin()

Tests if queue administrative service is supported.

Returns:

true if queue administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueNotification

boolean supportsQueueNotification()

Tests if a queue notification service is supported.

Returns:

true if queue notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueFrontOffice

boolean supportsQueueFrontOffice()

Tests if a queue front office lookup service is supported.

Returns:

true if a queue front office lookup service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueFrontOfficeAssignment

boolean supportsQueueFrontOfficeAssignment()

Tests if a queue front office service is supported.

Returns:

true if queue to front office assignment service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueSmartFrontOffice

boolean supportsQueueSmartFrontOffice()

Tests if a queue smart front office lookup service is supported.

Returns:

true if a queue smart front office service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsQueueResourcing

boolean supportsQueueResourcing()

Tests if a queue resourcing is supported.

Returns:

true if a queue resourcing service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFrontOfficeLookup

boolean supportsFrontOfficeLookup()

Tests if looking up front offices is supported.

Returns:

true if front office lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFrontOfficeQuery

boolean supportsFrontOfficeQuery()

Tests if querying front offices is supported.

Returns:

true if a front office query service is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFrontOfficeSearch

boolean supportsFrontOfficeSearch()

Tests if searching front offices is supported.

Returns:

true if front office search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFrontOfficeAdmin

boolean supportsFrontOfficeAdmin()

Tests if front office administrative service is supported.

Returns:

true if front office administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFrontOfficeNotification

boolean supportsFrontOfficeNotification()

Tests if a front office notification service is supported.

Returns:

true if front office notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsFrontOfficeHierarchy

boolean supportsFrontOfficeHierarchy()

Tests for the availability of a front office hierarchy traversal service.

Returns:

true if front office hierarchy traversal is available, false otherwise

Compliance:

mandatory - This method must be implemented in all providers.

supportsFrontOfficeHierarchyDesign

boolean supportsFrontOfficeHierarchyDesign()

Tests for the availability of a front office hierarchy design service.

Returns:

true if front office hierarchy design is available, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsTrackingRules

boolean supportsTrackingRules()

Tests for the availability of a tracking rules service.

Returns:

true if a tracking rules service is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getIssueRecordTypes

TypeList getIssueRecordTypes()

Gets the supported Issue record types.

Returns:

a list containing the supported Issue record types

Compliance:

mandatory - This method must be implemented.

supportsIssueRecordType

boolean supportsIssueRecordType(Type issueRecordType)

Tests if the given Issue record type is supported.

Parameters:

issueRecordType - a Type indicating an Issue record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - issueRecordType is null

Compliance:

mandatory - This method must be implemented.

getIssueSearchRecordTypes

TypeList getIssueSearchRecordTypes()

Gets the supported Issue search types.

Returns:

a list containing the supported Issue search types

Compliance:

mandatory - This method must be implemented.

supportsIssueSearchRecordType

boolean supportsIssueSearchRecordType(Type issueSearchRecordType)

Tests if the given Issue search type is supported.

Parameters:

issueSearchRecordType - a Type indicating an Issue search type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - issueSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getLogEntryRecordTypes

TypeList getLogEntryRecordTypes()

Gets the supported LogEntry record types.

Returns:

a list containing the supported LogEntry record types

Compliance:

mandatory - This method must be implemented.

supportsLogEntryRecordType

boolean supportsLogEntryRecordType(Type logEntryRecordType)

Tests if the given LogEntry record type is supported.

Parameters:

logEntryRecordType - a Type indicating a LogEntry record type

Returns:

true if the given record type is supported, false otherwise

Throws:

NullArgumentException - logEntryRecordType is null

Compliance:

mandatory - This method must be implemented.

getQueueRecordTypes

TypeList getQueueRecordTypes()

Gets the supported Queue record types.

Returns:

a list containing the supported Queue record types

Compliance:

mandatory - This method must be implemented.

supportsQueueRecordType

boolean supportsQueueRecordType(Type queueRecordType)

Tests if the given Queue record type is supported.

Parameters:

queueRecordType - a Type indicating a Queue record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - queueRecordType is null

Compliance:

mandatory - This method must be implemented.

getQueueSearchRecordTypes

TypeList getQueueSearchRecordTypes()

Gets the supported Queue search record types.

Returns:

a list containing the supported Queue search record types

Compliance:

mandatory - This method must be implemented.

supportsQueueSearchRecordType

boolean supportsQueueSearchRecordType(Type queueSearchRecordType)

Tests if the given Queue search record type is supported.

Parameters:

queueSearchRecordType - a Type indicating a Queue search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - queueSearchRecordType is null

Compliance:

mandatory - This method must be implemented.

getFrontOfficeRecordTypes

TypeList getFrontOfficeRecordTypes()

Gets the supported FrontOffice record types.

Returns:

a list containing the supported FrontOffice types

Compliance:

mandatory - This method must be implemented.

supportsFrontOfficeRecordType

boolean supportsFrontOfficeRecordType(Type frontOfficeRecordType)

Tests if the given FrontOffice record type is supported.

Parameters:

frontOfficeRecordType - a Type indicating a FrontOffice record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - frontOfficeRecordType is null

Compliance:

mandatory - This method must be implemented.

getFrontOfficeSearchRecordTypes

TypeList getFrontOfficeSearchRecordTypes()

Gets the supported FrontOffice search record types.

Returns:

a list containing the supported FrontOffice search record types

Compliance:

mandatory - This method must be implemented.

supportsFrontOfficeSearchRecordType

boolean supportsFrontOfficeSearchRecordType(Type frontOfficeSearchRecordType)

Tests if the given FrontOffice search record type is supported.

Parameters:

frontOfficeSearchRecordType - a Type indicating a FrontOffice search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - frontOfficeSearchRecordType is null

Compliance:

mandatory - This method must be implemented.