OSID Specifications
tracking package
Version 3.0.0
Release Candidate Preview
tracking package
Version 3.0.0
Release Candidate Preview
| Interface | osid.tracking.FrontOfficeQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector for examining front office queries. | ||
| Method | getIssueIdTerms | ||
| Description |
Gets the issue | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueTerms | ||
| Description |
Gets the issue query terms. | ||
| Return | osid.tracking.IssueQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQueueIdTerms | ||
| Description |
Gets the queue | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getQueueTerms | ||
| Description |
Gets the queue query terms. | ||
| Return | osid.tracking.QueueQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorFrontOfficeIdTerms | ||
| Description |
Gets the ancestor front office | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorFrontOfficeTerms | ||
| Description |
Gets the ancestor front office query terms. | ||
| Return | osid.tracking.FrontOfficeQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantFrontOfficeIdTerms | ||
| Description |
Gets the descendant front office | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantFrontOfficeTerms | ||
| Description |
Gets the descendant front office query terms. | ||
| Return | osid.tracking.FrontOfficeQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getFrontOfficeQueryInspectorRecord | ||
| Description |
Gets the front office query inspector record
corresponding to the given | ||
| Parameters | osid.type.Type | frontOfficeRecordType | a front office record type |
| Return | osid.tracking.records.FrontOfficeQueryInspectorRecord | the front office query inspector record | |
| Errors | NULL_ARGUMENT | frontOfficeRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(frontOfficeRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |