org.osid.authorization.rules

Interface AuthorizationEnablerQueryInspector

All Superinterfaces:

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

public interface AuthorizationEnablerQueryInspector
extends OsidEnablerQueryInspector

This is the query inspector for examining authorization enabler queries.

Method Summary

Methods

Modifier and Type	Method and Description
AuthorizationEnablerQueryInspectorRecord	getAuthorizationEnablerQueryInspectorRecord(Type authorizationEnablerRecordType) Gets the authorization enabler query inspector record corresponding to the given AuthorizationEnabler record Type.
IdTerm[]	getRuledAuthorizationIdTerms() Gets the authorization Id query terms.
AuthorizationQueryInspector[]	getRuledAuthorizationTerms() Gets the authorization query terms.
IdTerm[]	getVaultIdTerms() Gets the vault Id query terms.
VaultQueryInspector[]	getVaultTerms() Gets the vault query terms.

Methods inherited from interface org.osid.OsidEnablerQueryInspector

getCyclicEventIdTerms, getCyclicEventTerms, getDemographicIdTerms, getDemographicTerms, getEventIdTerms, getEventTerms, getScheduleIdTerms, getScheduleTerms

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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getRuledAuthorizationIdTerms

IdTerm[] getRuledAuthorizationIdTerms()

Gets the authorization Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledAuthorizationTerms

AuthorizationQueryInspector[] getRuledAuthorizationTerms()

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.

getAuthorizationEnablerQueryInspectorRecord

AuthorizationEnablerQueryInspectorRecord getAuthorizationEnablerQueryInspectorRecord(Type authorizationEnablerRecordType)
                                                                                     throws OperationFailedException

Gets the authorization enabler query inspector record corresponding to the given AuthorizationEnabler record Type.

Parameters:

authorizationEnablerRecordType - an authorization enabler record type

Returns:

the authorization enabler query inspector record

Throws:

NullArgumentException - authorizationEnablerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(authorizationEnablerRecordType) is false

Compliance:

mandatory - This method must be implemented.