org.osid.authorization

Interface FunctionQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidRuleQuery, Suppliable

public interface FunctionQuery
extends OsidRuleQuery

This is the query for searching functions. Each method match request produces an AND term while multiple invocations of a method produces a nested OR.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearAuthorizationIdTerms() Clears the authorization Id query terms.
void	clearAuthorizationTerms() Clears the authorization query terms.
void	clearQualifierHierarchyIdTerms() Clears the qualifier hierarchy Id query terms.
void	clearQualifierHierarchyTerms() Clears the qualifier hierarchy query terms.
void	clearVaultIdTerms() Clears the vault Id query terms.
void	clearVaultTerms() Clears the vault query terms.
AuthorizationQuery	getAuthorizationQuery() Gets the query for an authorization.
FunctionQueryRecord	getFunctionQueryRecord(Type functionRecordType) Gets the function query record corresponding to the given Function record Type.
HierarchyQuery	getQualifierHierarchyQuery() Gets the query for a qualifier hierarchy.
VaultQuery	getVaultQuery() Gets the query for a vault.
void	matchAnyAuthorization(boolean match) Matches functions that have any authorization mapping.
void	matchAnyQualifierHierarchy(boolean match) Matches functions that have any qualifier hierarchy.
void	matchAuthorizationId(Id authorizationId, boolean match) Sets the authorization Id for this query.
void	matchQualifierHierarchyId(Id qualifierHierarchyId, boolean match) Sets the qualifier hierarchy Id for this query.
void	matchVaultId(Id vaultId, boolean match) Sets the vault Id for this query.
boolean	supportsAuthorizationQuery() Tests if an AuthorizationQuery is available.
boolean	supportsQualifierHierarchyQuery() Tests if a HierarchyQuery is available.
boolean	supportsVaultQuery() Tests if a VaultQuery is available.

Methods inherited from interface org.osid.OsidRuleQuery

clearRuleIdTerms, clearRuleTerms, getRuleQuery, matchAnyRule, matchRuleId, supportsRuleQuery

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

clearActiveTerms, clearDisabledTerms, clearEnabledTerms, clearOperationalTerms, matchActive, matchDisabled, matchEnabled, matchOperational

Method Detail

matchQualifierHierarchyId

void matchQualifierHierarchyId(Id qualifierHierarchyId,
                             boolean match)

Sets the qualifier hierarchy Id for this query.

Parameters:

qualifierHierarchyId - a hierarchy Id

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

Throws:

NullArgumentException - qualifierHierarchyId is null

Compliance:

mandatory - This method must be implemented.

clearQualifierHierarchyIdTerms

void clearQualifierHierarchyIdTerms()

Clears the qualifier hierarchy Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsQualifierHierarchyQuery

boolean supportsQualifierHierarchyQuery()

Tests if a HierarchyQuery is available.

Returns:

true if a qualifier hierarchy query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getQualifierHierarchyQuery

HierarchyQuery getQualifierHierarchyQuery()

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

Returns:

the qualifier hierarchy query

Throws:

UnimplementedException - supportsQualifierHierarchyQuery() is false

Compliance:

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

matchAnyQualifierHierarchy

void matchAnyQualifierHierarchy(boolean match)

Matches functions that have any qualifier hierarchy.

Parameters:

match - true to match functions with any qualifier hierarchy, false to match functions with no qualifier hierarchy

Compliance:

mandatory - This method must be implemented.

clearQualifierHierarchyTerms

void clearQualifierHierarchyTerms()

Clears the qualifier hierarchy 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 functions that have any authorization mapping.

Parameters:

match - true to match functions with any authorization mapping, false to match functions 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.

matchVaultId

void matchVaultId(Id vaultId,
                boolean match)

Sets the vault Id for this query.

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.

clearVaultIdTerms

void clearVaultIdTerms()

Clears the vault Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsVaultQuery

boolean supportsVaultQuery()

Tests if a VaultQuery is available.

Returns:

true if a vault query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getVaultQuery

VaultQuery getVaultQuery()

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

Returns:

the vault query

Throws:

UnimplementedException - supportsVaultQuery() is false

Compliance:

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

clearVaultTerms

void clearVaultTerms()

Clears the vault query terms.

Compliance:

mandatory - This method must be implemented.

getFunctionQueryRecord

FunctionQueryRecord getFunctionQueryRecord(Type functionRecordType)
                                           throws OperationFailedException

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

Parameters:

functionRecordType - a function record type

Returns:

the function query record

Throws:

NullArgumentException - functionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(functionRecordType) is false

Compliance:

mandatory - This method must be implemented.