org.osid.authorization

Interface AuthorizationQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface AuthorizationQueryInspector
extends OsidRelationshipQueryInspector

The query inspector for examining authorization queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAgentIdTerms() Gets the agent Id query terms.
AgentQueryInspector[]	getAgentTerms() Gets the agent query terms.
AuthorizationQueryInspectorRecord	getAuthorizationQueryInspectorRecord(Type authorizationRecordType) Gets the authorization query inspector record corresponding to the given Authorization record Type.
BooleanTerm[]	getExplicitAuthorizationsTerms() Gets the explicit authorization query terms.
IdTerm[]	getFunctionIdTerms() Gets the function Id query terms.
FunctionQueryInspector[]	getFunctionTerms() Gets the function query terms.
IdTerm[]	getQualifierIdTerms() Gets the qualifier Id query terms.
QualifierQueryInspector[]	getQualifierTerms() Gets the qualifier query terms.
IdTerm[]	getRelatedAuthorizationIdTerms() Gets the related authorization Id query terms.
AuthorizationQueryInspector[]	getRelatedAuthorizationTerms() Gets the related authorization query terms.
IdTerm[]	getResourceIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource query terms.
IdTerm[]	getTrustIdTerms() Gets the trust Id query terms.
IdTerm[]	getVaultIdTerms() Gets the vault Id query terms.
VaultQueryInspector[]	getVaultTerms() Gets the vault query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getExplicitAuthorizationsTerms

BooleanTerm[] getExplicitAuthorizationsTerms()

Gets the explicit authorization query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRelatedAuthorizationIdTerms

IdTerm[] getRelatedAuthorizationIdTerms()

Gets the related authorization Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRelatedAuthorizationTerms

AuthorizationQueryInspector[] getRelatedAuthorizationTerms()

Gets the related authorization query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getTrustIdTerms

IdTerm[] getTrustIdTerms()

Gets the trust Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAgentIdTerms

IdTerm[] getAgentIdTerms()

Gets the agent Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAgentTerms

AgentQueryInspector[] getAgentTerms()

Gets the agent query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFunctionIdTerms

IdTerm[] getFunctionIdTerms()

Gets the function Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFunctionTerms

FunctionQueryInspector[] getFunctionTerms()

Gets the function query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getQualifierIdTerms

IdTerm[] getQualifierIdTerms()

Gets the qualifier Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getQualifierTerms

QualifierQueryInspector[] getQualifierTerms()

Gets the qualifier 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.

getAuthorizationQueryInspectorRecord

AuthorizationQueryInspectorRecord getAuthorizationQueryInspectorRecord(Type authorizationRecordType)
                                                                       throws OperationFailedException

Gets the authorization query inspector record corresponding to the given Authorization record Type.

Parameters:

authorizationRecordType - an authorization record type

Returns:

the authorization query inspector record

Throws:

NullArgumentException - authorizationRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(authorizationRecordType) is false

Compliance:

mandatory - This method must be implemented.