Interface TrackingProfile
- All Superinterfaces:
OsidProfile, Sourceable
- All Known Subinterfaces:
TrackingManager, TrackingProxyManager
The tracking profile describes the interoperability among tracking services.
-
Method Summary
Modifier and TypeMethodDescriptionGets the supportedFrontOfficerecord types.Gets the supportedFrontOfficesearch record types.Gets the supportedIssuerecord types.Gets the supportedIssuesearch types.Gets the supportedLogEntryrecord types.Gets the supportedQueuerecord types.Gets the supportedQueuesearch record types.booleanTests if managing issue blocks is supported.booleanTests if looking up blocking issues is supported.booleanTests if managing issue branches is supported.booleanTests if looking up issue branches is supported.booleanTests if managing duplicate issues is supported.booleanTests if looking up duplicate issues is supported.booleanTests if front office administrative service is supported.booleanTests for the availability of a front office hierarchy traversal service.booleanTests for the availability of a front office hierarchy design service.booleanTests if looking up front offices is supported.booleanTests if a front office notification service is supported.booleanTests if querying front offices is supported.booleansupportsFrontOfficeRecordType(Type frontOfficeRecordType) Tests if the givenFrontOfficerecord type is supported.booleanTests if searching front offices is supported.booleansupportsFrontOfficeSearchRecordType(Type frontOfficeSearchRecordType) Tests if the givenFrontOfficesearch record type is supported.booleanTests if issue administrative service is supported.booleanTests if an issue front office lookup service is supported.booleanTests if an issue front office assignment service is supported.booleanTests if looking up issues is supported.booleanTests if issue commenting and customer messaging is supported.booleanTests if an issue notification service is supported.booleanTests if querying issues is supported.booleansupportsIssueRecordType(Type issueRecordType) Tests if the givenIssuerecord type is supported.booleanTests if an issue resourcing service is supported.booleanTests if searching issues is supported.booleansupportsIssueSearchRecordType(Type issueSearchRecordType) Tests if the givenIssuesearch type is supported.booleanTests if an issue smart front office service is supported.booleanTests if an issue tracking service is supported.booleanTests if an issue triaging service is supported.booleanTests if looking up log entries is supported.booleanTests if log entry notification is supported.booleansupportsLogEntryRecordType(Type logEntryRecordType) Tests if the givenLogEntryrecord type is supported.booleanTests if an issue service is supported for the current agent.booleanTests if queue administrative service is supported.booleanTests if a queue front office lookup service is supported.booleanTests if a queue front office service is supported.booleanTests if looking up queues is supported.booleanTests if a queue notification service is supported.booleanTests if querying queues is supported.booleansupportsQueueRecordType(Type queueRecordType) Tests if the givenQueuerecord type is supported.booleanTests if a queue resourcing is supported.booleanTests if searching queues is supported.booleansupportsQueueSearchRecordType(Type queueSearchRecordType) Tests if the givenQueuesearch record type is supported.booleanTests if a queue smart front office lookup service is supported.booleanTests if managing subtasks is supported.booleanTests if looking up subtasks is supported.booleanTests for the availability of a tracking rules service.booleanTests if any front office federation is exposed.Methods inherited from interface OsidProfile
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordTypeModifier and TypeMethodDescriptionGets this service branch.Gets theBranch Idrepresenting this service branch.Gets a description of this service implementation.Gets a display name for this service implementation.getId()Gets an identifier for this service implementation.Gets the locales supported in this service.Gets the proxy recordTypessupported in this service.Gets the date this service implementation was released.Gets the version of this service implementation.booleanTest for support of a journal branching service.booleanTest for support of a journaling rollback service.booleansupportsOSIDVersion(Version version) Test for support of an OSID specification version.booleansupportsProxyRecordType(Type proxyRecordType) Test for support of a proxy type.Methods inherited from interface Sourceable
getBranding, getBrandingIds, getLicense, getProvider, getProviderIdModifier and TypeMethodDescriptionGets a branding, such as an image or logo, expressed using theAssetinterface.Gets the branding assetIds.Gets the terms of usage.Gets theResourcerepresenting the provider.Gets theIdof the provider.
-
Method Details
-
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:
trueif visible federation is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsMyIssue
boolean supportsMyIssue()Tests if an issue service is supported for the current agent.- Returns:
trueif my issue is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueTracking
boolean supportsIssueTracking()Tests if an issue tracking service is supported.- Returns:
trueif issue tracking is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueResourcing
boolean supportsIssueResourcing()Tests if an issue resourcing service is supported.- Returns:
trueif issue resourcing is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueTriaging
boolean supportsIssueTriaging()Tests if an issue triaging service is supported.- Returns:
trueif issue triaging is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueLookup
boolean supportsIssueLookup()Tests if looking up issues is supported.- Returns:
trueif issue lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueQuery
boolean supportsIssueQuery()Tests if querying issues is supported.- Returns:
trueif issue query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueSearch
boolean supportsIssueSearch()Tests if searching issues is supported.- Returns:
trueif issue search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueAdmin
boolean supportsIssueAdmin()Tests if issue administrative service is supported.- Returns:
trueif issue administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueNotification
boolean supportsIssueNotification()Tests if an issue notification service is supported.- Returns:
trueif issue notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueFrontOffice
boolean supportsIssueFrontOffice()Tests if an issue front office lookup service is supported.- Returns:
trueif an issue front office lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueFrontOfficeAssignment
boolean supportsIssueFrontOfficeAssignment()Tests if an issue front office assignment service is supported.- Returns:
trueif an issue to front office assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueSmartFrontOffice
boolean supportsIssueSmartFrontOffice()Tests if an issue smart front office service is supported.- Returns:
trueif an issue smart front office service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSubtaskIssueLookup
boolean supportsSubtaskIssueLookup()Tests if looking up subtasks is supported.- Returns:
trueif subtask lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsSubtaskIssueAdmin
boolean supportsSubtaskIssueAdmin()Tests if managing subtasks is supported.- Returns:
trueif subtask admin is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDuplicateIssueLookup
boolean supportsDuplicateIssueLookup()Tests if looking up duplicate issues is supported.- Returns:
trueif duplicate issue lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsDuplicateIssueAdmin
boolean supportsDuplicateIssueAdmin()Tests if managing duplicate issues is supported.- Returns:
trueif duplicate issue admin is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBranchedIssueLookup
boolean supportsBranchedIssueLookup()Tests if looking up issue branches is supported.- Returns:
trueif branched issue lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBranchedIssueAdmin
boolean supportsBranchedIssueAdmin()Tests if managing issue branches is supported.- Returns:
trueif branched issue admin is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBlockingIssueLookup
boolean supportsBlockingIssueLookup()Tests if looking up blocking issues is supported.- Returns:
trueif blocking issue lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsBlockingIssueAdmin
boolean supportsBlockingIssueAdmin()Tests if managing issue blocks is supported.- Returns:
trueif blocking issue admin is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsLogEntryLookup
boolean supportsLogEntryLookup()Tests if looking up log entries is supported.- Returns:
trueif log entry lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsIssueMessaging
boolean supportsIssueMessaging()Tests if issue commenting and customer messaging is supported.- Returns:
trueif issue messaging is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsLogEntryNotification
boolean supportsLogEntryNotification()Tests if log entry notification is supported.- Returns:
trueif log entry notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsQueueLookup
boolean supportsQueueLookup()Tests if looking up queues is supported.- Returns:
trueif queue lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsQueueQuery
boolean supportsQueueQuery()Tests if querying queues is supported.- Returns:
trueif queue query is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsQueueSearch
boolean supportsQueueSearch()Tests if searching queues is supported.- Returns:
trueif queue search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsQueueAdmin
boolean supportsQueueAdmin()Tests if queue administrative service is supported.- Returns:
trueif queue administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsQueueNotification
boolean supportsQueueNotification()Tests if a queue notification service is supported.- Returns:
trueif queue notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsQueueFrontOffice
boolean supportsQueueFrontOffice()Tests if a queue front office lookup service is supported.- Returns:
trueif a queue front office lookup service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsQueueFrontOfficeAssignment
boolean supportsQueueFrontOfficeAssignment()Tests if a queue front office service is supported.- Returns:
trueif queue to front office assignment service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsQueueSmartFrontOffice
boolean supportsQueueSmartFrontOffice()Tests if a queue smart front office lookup service is supported.- Returns:
trueif a queue smart front office service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsQueueResourcing
boolean supportsQueueResourcing()Tests if a queue resourcing is supported.- Returns:
trueif a queue resourcing service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsFrontOfficeLookup
boolean supportsFrontOfficeLookup()Tests if looking up front offices is supported.- Returns:
trueif front office lookup is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsFrontOfficeQuery
boolean supportsFrontOfficeQuery()Tests if querying front offices is supported.- Returns:
trueif a front office query service is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsFrontOfficeSearch
boolean supportsFrontOfficeSearch()Tests if searching front offices is supported.- Returns:
trueif front office search is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsFrontOfficeAdmin
boolean supportsFrontOfficeAdmin()Tests if front office administrative service is supported.- Returns:
trueif front office administration is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsFrontOfficeNotification
boolean supportsFrontOfficeNotification()Tests if a front office notification service is supported.- Returns:
trueif front office notification is supported,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsFrontOfficeHierarchy
boolean supportsFrontOfficeHierarchy()Tests for the availability of a front office hierarchy traversal service.- Returns:
trueif front office hierarchy traversal is available,falseotherwise- 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:
trueif front office hierarchy design is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
supportsTrackingRules
boolean supportsTrackingRules()Tests for the availability of a tracking rules service.- Returns:
trueif a tracking rules service is available,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getIssueRecordTypes
TypeList getIssueRecordTypes()Gets the supportedIssuerecord types.- Returns:
- a list containing the supported
Issuerecord types - Compliance:
mandatory- This method must be implemented.
-
supportsIssueRecordType
Tests if the givenIssuerecord type is supported.- Parameters:
issueRecordType- aTypeindicating anIssuerecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-issueRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getIssueSearchRecordTypes
TypeList getIssueSearchRecordTypes()Gets the supportedIssuesearch types.- Returns:
- a list containing the supported
Issuesearch types - Compliance:
mandatory- This method must be implemented.
-
supportsIssueSearchRecordType
Tests if the givenIssuesearch type is supported.- Parameters:
issueSearchRecordType- aTypeindicating anIssuesearch type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-issueSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getLogEntryRecordTypes
TypeList getLogEntryRecordTypes()Gets the supportedLogEntryrecord types.- Returns:
- a list containing the supported
LogEntryrecord types - Compliance:
mandatory- This method must be implemented.
-
supportsLogEntryRecordType
Tests if the givenLogEntryrecord type is supported.- Parameters:
logEntryRecordType- aTypeindicating aLogEntryrecord type- Returns:
trueif the given record type is supported,falseotherwise- Throws:
NullArgumentException-logEntryRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getQueueRecordTypes
TypeList getQueueRecordTypes()Gets the supportedQueuerecord types.- Returns:
- a list containing the supported
Queuerecord types - Compliance:
mandatory- This method must be implemented.
-
supportsQueueRecordType
Tests if the givenQueuerecord type is supported.- Parameters:
queueRecordType- aTypeindicating aQueuerecord type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-queueRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getQueueSearchRecordTypes
TypeList getQueueSearchRecordTypes()Gets the supportedQueuesearch record types.- Returns:
- a list containing the supported
Queuesearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsQueueSearchRecordType
Tests if the givenQueuesearch record type is supported.- Parameters:
queueSearchRecordType- aTypeindicating aQueuesearch record type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-queueSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getFrontOfficeRecordTypes
TypeList getFrontOfficeRecordTypes()Gets the supportedFrontOfficerecord types.- Returns:
- a list containing the supported
FrontOfficetypes - Compliance:
mandatory- This method must be implemented.
-
supportsFrontOfficeRecordType
Tests if the givenFrontOfficerecord type is supported.- Parameters:
frontOfficeRecordType- aTypeindicating aFrontOfficerecord type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-frontOfficeRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-
getFrontOfficeSearchRecordTypes
TypeList getFrontOfficeSearchRecordTypes()Gets the supportedFrontOfficesearch record types.- Returns:
- a list containing the supported
FrontOfficesearch record types - Compliance:
mandatory- This method must be implemented.
-
supportsFrontOfficeSearchRecordType
Tests if the givenFrontOfficesearch record type is supported.- Parameters:
frontOfficeSearchRecordType- aTypeindicating aFrontOfficesearch record type- Returns:
trueif the givenTypeis supported,falseotherwise- Throws:
NullArgumentException-frontOfficeSearchRecordTypeisnull- Compliance:
mandatory- This method must be implemented.
-