OSID Specifications
profile package
Version 3.0.0
Release Candidate Preview
profile package
Version 3.0.0
Release Candidate Preview
| Interface | osid.profile.ProfileQueryInspector | ||
|---|---|---|---|
| Implements | osid.OsidCatalogQueryInspector | ||
| Description |
This is the query inspector to examine profile queries. | ||
| Method | getProfileItemIdTerms | ||
| Description |
Gets the profile item | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProfileItemTerms | ||
| Description |
Gets the profile item query terms. | ||
| Return | osid.profile.ProfileItemQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProfileEntryIdTerms | ||
| Description |
Gets the profile entry | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProfileEntryTerms | ||
| Description |
Gets the profile entry query terms. | ||
| Return | osid.profile.ProfileEntryQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorProfileIdTerms | ||
| Description |
Gets the ancestor profile | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getAncestorProfileTerms | ||
| Description |
Gets the ancestor profile query terms. | ||
| Return | osid.profile.ProfileQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantProfileIdTerms | ||
| Description |
Gets the descendant profile | ||
| Return | osid.search.terms.IdTerm[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getDescendantProfileTerms | ||
| Description |
Gets the descendant profile query terms. | ||
| Return | osid.profile.ProfileQueryInspector[] | the query terms | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getProfileQueryInspectorRecord | ||
| Description |
Gets the profile query inspector record corresponding
to the given | ||
| Parameters | osid.type.Type | profileRecordType | a profile record type |
| Return | osid.profile.records.ProfileQueryInspectorRecord | the profile query inspector record | |
| Errors | NULL_ARGUMENT | profileRecordType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(profileRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |