org.osid.control

Interface ActionGroupQueryInspector

All Superinterfaces:

Extensible, OsidAggregateableQueryInspector, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector

public interface ActionGroupQueryInspector
extends OsidObjectQueryInspector, OsidAggregateableQueryInspector

This is the query inspector for examining action group queries.

Method Summary

Methods

Modifier and Type	Method and Description
ActionGroupQueryInspectorRecord	getActionGroupQueryInspectorRecord(Type actionGroupRecordType) Gets the action group query inspector record corresponding to the given ActionGroup record Type.
IdTerm[]	getActionIdTerms() Gets the action Id query terms.
ActionQueryInspector[]	getActionTerms() Gets the action query terms.
IdTerm[]	getSystemIdTerms() Gets the system Id query terms.
SystemQueryInspector[]	getSystemTerms() Gets the system query terms.

Methods inherited from interface org.osid.OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

getActionIdTerms

IdTerm[] getActionIdTerms()

Gets the action Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getActionTerms

ActionQueryInspector[] getActionTerms()

Gets the action query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSystemIdTerms

IdTerm[] getSystemIdTerms()

Gets the system Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSystemTerms

SystemQueryInspector[] getSystemTerms()

Gets the system query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getActionGroupQueryInspectorRecord

ActionGroupQueryInspectorRecord getActionGroupQueryInspectorRecord(Type actionGroupRecordType)
                                                                   throws OperationFailedException

Gets the action group query inspector record corresponding to the given ActionGroup record Type.

Parameters:

actionGroupRecordType - an action group record type

Returns:

the action group query inspector record

Throws:

NullArgumentException - actionGroupRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(actionGroupRecordType) is false

Compliance:

mandatory - This method must be implemented.