Interface OfficeQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
This is the query inspector for examining office queries.
-
Method Summary
Modifier and TypeMethodDescriptionIdTerm[]Gets the ancestor officeIdquery terms.Gets the ancestor office query terms.IdTerm[]Gets the descendant officeIdquery terms.Gets the descendant office query terms.getOfficeQueryInspectorRecord(Type officeRecordType) Gets the office query inspector record corresponding to the givenOfficerecordType.IdTerm[]Gets the processIdquery terms.Gets the process query terms.IdTerm[]Gets the stepIdquery terms.Gets the step query terms.IdTerm[]Gets the workIdquery terms.Gets the work query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.Methods inherited from interface OsidSourceableQueryInspector
getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms
-
Method Details
-
getProcessIdTerms
IdTerm[] getProcessIdTerms()Gets the processIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getProcessTerms
ProcessQueryInspector[] getProcessTerms()Gets the process query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getStepIdTerms
IdTerm[] getStepIdTerms()Gets the stepIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getStepTerms
StepQueryInspector[] getStepTerms()Gets the step query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getWorkIdTerms
IdTerm[] getWorkIdTerms()Gets the workIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getWorkTerms
WorkQueryInspector[] getWorkTerms()Gets the work query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getAncestorOfficeIdTerms
IdTerm[] getAncestorOfficeIdTerms()Gets the ancestor officeIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getAncestorOfficeTerms
OfficeQueryInspector[] getAncestorOfficeTerms()Gets the ancestor office query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getDescendantOfficeIdTerms
IdTerm[] getDescendantOfficeIdTerms()Gets the descendant officeIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getDescendantOfficeTerms
OfficeQueryInspector[] getDescendantOfficeTerms()Gets the descendant office query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getOfficeQueryInspectorRecord
OfficeQueryInspectorRecord getOfficeQueryInspectorRecord(Type officeRecordType) throws OperationFailedException Gets the office query inspector record corresponding to the givenOfficerecordType.- Parameters:
officeRecordType- an office record type- Returns:
- the office query inspector record
- Throws:
NullArgumentException-officeRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(officeRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-