org.osid.authorization

Interface VaultQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface VaultQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining vault queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorVaultIdTerms() Gets the ancestor vault Id query terms.
VaultQueryInspector[]	getAncestorVaultTerms() Gets the ancestor vault query terms.
IdTerm[]	getAuthorizationIdTerms() Gets the authorization Id query terms.
AuthorizationQueryInspector[]	getAuthorizationTerms() Gets the authorization query terms.
IdTerm[]	getDescendantVaultIdTerms() Gets the descendant vault Id query terms.
VaultQueryInspector[]	getDescendantVaultTerms() Gets the descendant vault 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.
VaultQueryInspectorRecord	getVaultQueryInspectorRecord(Type vaultRecordType) Gets the vault query inspector record corresponding to the given Vault record Type.

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

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

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.

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.

getAncestorVaultIdTerms

IdTerm[] getAncestorVaultIdTerms()

Gets the ancestor vault Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorVaultTerms

VaultQueryInspector[] getAncestorVaultTerms()

Gets the ancestor vault query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantVaultIdTerms

IdTerm[] getDescendantVaultIdTerms()

Gets the descendant vault Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantVaultTerms

VaultQueryInspector[] getDescendantVaultTerms()

Gets the descendant vault query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getVaultQueryInspectorRecord

VaultQueryInspectorRecord getVaultQueryInspectorRecord(Type vaultRecordType)
                                                       throws OperationFailedException

Gets the vault query inspector record corresponding to the given Vault record Type.

Parameters:

vaultRecordType - a vault query inspector record type

Returns:

the vault query inspector record

Throws:

NullArgumentException - vaultRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(vaultRecordType) is false

Compliance:

mandatory - This method must be implemented.