org.osid.authorization

Interface VaultQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidCatalogQuery, OsidExtensibleQuery, OsidFederateableQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidSourceableQuery, Suppliable

public interface VaultQuery
extends OsidCatalogQuery

This is the query for searching vaults. Each method specifies an AND term while multiple invocations of the same method produce a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAncestorVaultIdTerms() Clears the ancestor vault Id query terms.
void	clearAncestorVaultTerms() Clears the ancestor vault query terms.
void	clearAuthorizationIdTerms() Clears the authorization Id query terms.
void	clearAuthorizationTerms() Clears the authorization query terms.
void	clearDescendantVaultIdTerms() Clears the descendant vault Id query terms.
void	clearDescendantVaultTerms() Clears the descendant vault query terms.
void	clearFunctionIdTerms() Clears the function Id query terms.
void	clearFunctionTerms() Clears the function query terms.
void	clearQualifierIdTerms() Clears the qualifier Id query terms.
void	clearQualifierTerms() Clears the qualifier query terms.
VaultQuery	getAncestorVaultQuery() Gets the query for a vault.
AuthorizationQuery	getAuthorizationQuery() Gets the query for an authorization.
VaultQuery	getDescendantVaultQuery() Gets the query for a vault.
FunctionQuery	getFunctionQuery() Gets the query for a function.
QualifierQuery	getQualifierQuery() Gets the query for a qualifier.
VaultQueryRecord	getVaultQueryRecord(Type vaultRecordType) Gets the vault query record corresponding to the given Vault record Type.
void	matchAncestorVaultId(Id vaultId, boolean match) Sets the vault Id for this query to match vaults that have the specified vault as an ancestor.
void	matchAnyAncestorVault(boolean match) Matches vaults that have any ancestor.
void	matchAnyAuthorization(boolean match) Matches vaults that have any authorization.
void	matchAnyDescendantVault(boolean match) Matches vaults that have any descendant.
void	matchAnyFunction(boolean match) Matches vaults that have any function.
void	matchAnyQualifier(boolean match) Matches vaults that have any qualifier.
void	matchAuthorizationId(Id authorizationId, boolean match) Sets the authorization Id for this query.
void	matchDescendantVaultId(Id vaultId, boolean match) Sets the vault Id for this query to match vaults that have the specified vault as a descendant.
void	matchFunctionId(Id functionId, boolean match) Sets the function Id for this query.
void	matchQualifierId(Id qualifierId, boolean match) Sets the qualifier Id for this query.
boolean	supportsAncestorVaultQuery() Tests if a VaultQuery is available.
boolean	supportsAuthorizationQuery() Tests if an AuthorizationQuery is available.
boolean	supportsDescendantVaultQuery() Tests if a VaultQuery is available.
boolean	supportsFunctionQuery() Tests if a FunctionQuery is available.
boolean	supportsQualifierQuery() Tests if a QualifierQuery is available.

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidSourceableQuery

clearBrandingIdTerms, clearBrandingTerms, clearLicenseTerms, clearProviderIdTerms, clearProviderTerms, getBrandingQuery, getProviderQuery, matchAnyBranding, matchAnyLicense, matchAnyProvider, matchBrandingId, matchLicense, matchProviderId, supportsBrandingQuery, supportsProviderQuery

Method Detail

matchFunctionId

void matchFunctionId(Id functionId,
                   boolean match)

Sets the function Id for this query.

Parameters:

functionId - a function Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - functionId is null

Compliance:

mandatory - This method must be implemented.

clearFunctionIdTerms

void clearFunctionIdTerms()

Clears the function Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsFunctionQuery

boolean supportsFunctionQuery()

Tests if a FunctionQuery is available.

Returns:

true if a function query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getFunctionQuery

FunctionQuery getFunctionQuery()

Gets the query for a function. Multiple retrievals produce a nested OR term.

Returns:

the function query

Throws:

UnimplementedException - supportsFunctionQuery() is false

Compliance:

optional - This method must be implemented if supportsFunctionQuery() is true.

matchAnyFunction

void matchAnyFunction(boolean match)

Matches vaults that have any function.

Parameters:

match - true to match vaults with any function mapping, false to match vaults with no function mapping

Compliance:

mandatory - This method must be implemented.

clearFunctionTerms

void clearFunctionTerms()

Clears the function query terms.

Compliance:

mandatory - This method must be implemented.

matchQualifierId

void matchQualifierId(Id qualifierId,
                    boolean match)

Sets the qualifier Id for this query.

Parameters:

qualifierId - a qualifier Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - qualifierId is null

Compliance:

mandatory - This method must be implemented.

clearQualifierIdTerms

void clearQualifierIdTerms()

Clears the qualifier Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsQualifierQuery

boolean supportsQualifierQuery()

Tests if a QualifierQuery is available.

Returns:

true if a qualifier query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getQualifierQuery

QualifierQuery getQualifierQuery()

Gets the query for a qualifier. Multiple retrievals produce a nested OR term.

Returns:

the qualifier query

Throws:

UnimplementedException - supportsQualifierQuery() is false

Compliance:

optional - This method must be implemented if supportsQualifierQuery() is true.

matchAnyQualifier

void matchAnyQualifier(boolean match)

Matches vaults that have any qualifier.

Parameters:

match - true to match vaults with any qualifier mapping, false to match vaults with no qualifier mapping

Compliance:

mandatory - This method must be implemented.

clearQualifierTerms

void clearQualifierTerms()

Clears the qualifier query terms.

Compliance:

mandatory - This method must be implemented.

matchAuthorizationId

void matchAuthorizationId(Id authorizationId,
                        boolean match)

Sets the authorization Id for this query.

Parameters:

authorizationId - an authorization Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - authorizationId is null

Compliance:

mandatory - This method must be implemented.

clearAuthorizationIdTerms

void clearAuthorizationIdTerms()

Clears the authorization Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAuthorizationQuery

boolean supportsAuthorizationQuery()

Tests if an AuthorizationQuery is available.

Returns:

true if an authorization query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAuthorizationQuery

AuthorizationQuery getAuthorizationQuery()

Gets the query for an authorization. Multiple retrievals produce a nested OR term.

Returns:

the authorization query

Throws:

UnimplementedException - supportsAuthorizationQuery() is false

Compliance:

optional - This method must be implemented if supportsAuthorizationQuery() is true.

matchAnyAuthorization

void matchAnyAuthorization(boolean match)

Matches vaults that have any authorization.

Parameters:

match - true to match vaults with any authorization mapping, false to match vaults with no authorization mapping

Compliance:

mandatory - This method must be implemented.

clearAuthorizationTerms

void clearAuthorizationTerms()

Clears the authorization query terms.

Compliance:

mandatory - This method must be implemented.

matchAncestorVaultId

void matchAncestorVaultId(Id vaultId,
                        boolean match)

Sets the vault Id for this query to match vaults that have the specified vault as an ancestor.

Parameters:

vaultId - a vault Id

match - true for a positive match, false for a negative match

Throws:

NullArgumentException - vaultId is null

Compliance:

mandatory - This method must be implemented.

clearAncestorVaultIdTerms

void clearAncestorVaultIdTerms()

Clears the ancestor vault Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsAncestorVaultQuery

boolean supportsAncestorVaultQuery()

Tests if a VaultQuery is available.

Returns:

true if a vault query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getAncestorVaultQuery

VaultQuery getAncestorVaultQuery()

Gets the query for a vault. Multiple retrievals produce a nested OR term.

Returns:

the vault query

Throws:

UnimplementedException - supportsAncestorVaultQuery() is false

Compliance:

optional - This method must be implemented if supportsAncestorVaultQuery() is true.

matchAnyAncestorVault

void matchAnyAncestorVault(boolean match)

Matches vaults that have any ancestor.

Parameters:

match - true to match vaults with any ancestor, false to match root vaults

Compliance:

mandatory - This method must be implemented.

clearAncestorVaultTerms

void clearAncestorVaultTerms()

Clears the ancestor vault query terms.

Compliance:

mandatory - This method must be implemented.

matchDescendantVaultId

void matchDescendantVaultId(Id vaultId,
                          boolean match)

Sets the vault Id for this query to match vaults that have the specified vault as a descendant.

Parameters:

vaultId - a vault Id

match - true for a positive match, false for negative match

Throws:

NullArgumentException - vaultId is null

Compliance:

mandatory - This method must be implemented.

clearDescendantVaultIdTerms

void clearDescendantVaultIdTerms()

Clears the descendant vault Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsDescendantVaultQuery

boolean supportsDescendantVaultQuery()

Tests if a VaultQuery is available.

Returns:

true if a vault query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getDescendantVaultQuery

VaultQuery getDescendantVaultQuery()

Gets the query for a vault. Multiple retrievals produce a nested OR term.

Returns:

the vault query

Throws:

UnimplementedException - supportsDescendantVaultQuery() is false

Compliance:

optional - This method must be implemented if supportsDescendantVaultQuery() is true.

matchAnyDescendantVault

void matchAnyDescendantVault(boolean match)

Matches vaults that have any descendant.

Parameters:

match - true to match vaults with any Ddscendant, false to match leaf vaults

Compliance:

mandatory - This method must be implemented.

clearDescendantVaultTerms

void clearDescendantVaultTerms()

Clears the descendant vault query terms.

Compliance:

mandatory - This method must be implemented.

getVaultQueryRecord

VaultQueryRecord getVaultQueryRecord(Type vaultRecordType)
                                     throws OperationFailedException

Gets the vault query record corresponding to the given Vault record Type. Multiple record retrievals produce a nested OR term.

Parameters:

vaultRecordType - a vault record type

Returns:

the vault query record

Throws:

NullArgumentException - vaultRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(vaultRecordType) is false

Compliance:

mandatory - This method must be implemented.