org.osid.authorization

Interface FunctionQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface FunctionQueryInspector
extends OsidRuleQueryInspector

This is the query inspector for examining function queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAuthorizationIdTerms() Gets the authorization Id query terms.
AuthorizationQueryInspector[]	getAuthorizationTerms() Gets the authorization query terms.
FunctionQueryInspectorRecord	getFunctionQueryInspectorRecord(Type functionRecordType) Gets the function query inspector record corresponding to the given Function record Type.
IdTerm[]	getQualifierHierarchyIdTerms() Gets the qualifier hierarchy Id query terms.
HierarchyQueryInspector[]	getQualifierHierarchyTerms() Gets the qualifier hierarchy query terms.
IdTerm[]	getVaultIdTerms() Gets the vault Id query terms.
VaultQueryInspector[]	getVaultTerms() Gets the vault query terms.

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

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

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Method Detail

getQualifierHierarchyIdTerms

IdTerm[] getQualifierHierarchyIdTerms()

Gets the qualifier hierarchy Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getQualifierHierarchyTerms

HierarchyQueryInspector[] getQualifierHierarchyTerms()

Gets the qualifier hierarchy query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAuthorizationIdTerms

IdTerm[] getAuthorizationIdTerms()

Gets the authorization Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAuthorizationTerms

AuthorizationQueryInspector[] getAuthorizationTerms()

Gets the authorization query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVaultIdTerms

IdTerm[] getVaultIdTerms()

Gets the vault Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVaultTerms

VaultQueryInspector[] getVaultTerms()

Gets the vault query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFunctionQueryInspectorRecord

FunctionQueryInspectorRecord getFunctionQueryInspectorRecord(Type functionRecordType)
                                                             throws OperationFailedException

Gets the function query inspector record corresponding to the given Function record Type.

Parameters:

functionRecordType - a function record type

Returns:

the function query inspector record

Throws:

NullArgumentException - functionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(functionRecordType) is false

Compliance:

mandatory - This method must be implemented.