Interface AuthorizationQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable
public interface AuthorizationQuery extends OsidRelationshipQuery

The query for authorizations.

  • Method Details

    • matchExplicitAuthorizations

      void matchExplicitAuthorizations(boolean match)
      Matches explciit authorizations.
      Parameters:
      match - true to match explicit authorizations, false to match implciit authorizations
      Compliance:
      mandatory - This method must be implemented.

    • clearExplicitAuthorizationsTerms

      void clearExplicitAuthorizationsTerms()
      Clears the explicit authorization query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRelatedAuthorizationId

      void matchRelatedAuthorizationId(Id id, boolean match)
      Adds an Id to match explicit or implicitly related authorizations depending on matchExplicitAuthorizations() . Multiple Ids can be added to perform a boolean OR among them.
      Parameters:
      id - Id to match
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - id is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRelatedAuthorizationIdTerms

      void clearRelatedAuthorizationIdTerms()
      Clears the related authorization Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsRelatedAuthorizationQuery

      boolean supportsRelatedAuthorizationQuery()
      Tests if an AuthorizationQuery is available.
      Returns:
      true if an authorization query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRelatedAuthorizationQuery

      AuthorizationQuery getRelatedAuthorizationQuery(boolean match)
      Gets the authorization query.
      Parameters:
      match - true if a positive match, false for a negative match
      Returns:
      the AuthorizationQuery
      Throws:
      UnimplementedException - supportsRelatedAuthorizationQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRelatedAuthorizationQuery()} is {@code true} .

    • clearRelatedAuthorizationTerms

      void clearRelatedAuthorizationTerms()
      Clears the related authorization query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchResourceId

      void matchResourceId(Id resourceId, boolean match)
      Matches the resource identified by the given Id .
      Parameters:
      resourceId - the Id of the Resource
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearResourceIdTerms

      void clearResourceIdTerms()
      Clears the resource Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourceQuery

      boolean supportsResourceQuery()
      Tests if a ResourceQuery is available.
      Returns:
      true if a resource query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getResourceQuery

      ResourceQuery getResourceQuery(boolean match)
      Gets the resource query.
      Parameters:
      match - true if a positive match, false for a negative match
      Returns:
      the ResourceQuery
      Throws:
      UnimplementedException - supportsResourceQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResourceQuery()} is {@code true} .

    • matchAnyResource

      void matchAnyResource(boolean match)
      Matches authorizations that have any resource.
      Parameters:
      match - true to match authorizations with any resource, false to match authorizations with no resource
      Compliance:
      mandatory - This method must be implemented.

    • clearResourceTerms

      void clearResourceTerms()
      Clears the resource query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchTrustId

      void matchTrustId(Id trustId, boolean match)
      Matches the trust identified by the given Id .
      Parameters:
      trustId - the Id of the Trust
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - trustId is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyTrustId

      void matchAnyTrustId(boolean match)
      Matches authorizations that have any trust defined.
      Parameters:
      match - true to match authorizations with any trust, false to match authorizations with no trusts
      Compliance:
      mandatory - This method must be implemented.

    • clearTrustIdTerms

      void clearTrustIdTerms()
      Clears the trust Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAgentId

      void matchAgentId(Id agentId, boolean match)
      Matches the agent identified by the given Id .
      Parameters:
      agentId - the Id of the Agent
      match - true if a positive match, false for a negative match
      Throws:
      NullArgumentException - agentId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAgentIdTerms

      void clearAgentIdTerms()
      Clears the agent Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsAgentQuery

      boolean supportsAgentQuery()
      Tests if an AgentQuery is available.
      Returns:
      true if an agent query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAgentQuery

      AgentQuery getAgentQuery(boolean match)
      Gets the agent query.
      Parameters:
      match - true if a positive match, false for a negative match
      Returns:
      the AgentQuery
      Throws:
      UnimplementedException - supportsAgentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAgentQuery()} is {@code true} .

    • matchAnyAgent

      void matchAnyAgent(boolean match)
      Matches authorizations that have any agent.
      Parameters:
      match - true to match authorizations with any agent, false to match authorizations with no agent
      Compliance:
      mandatory - This method must be implemented.

    • clearAgentTerms

      void clearAgentTerms()
      Clears the agent query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchFunctionId

      void matchFunctionId(Id functionId, boolean match)
      Matches the function identified by the given Id .
      Parameters:
      functionId - the Id of the Function
      match - true if 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(boolean match)
      Gets the function query.
      Parameters:
      match - true if a positive match, false for a negative match
      Returns:
      the FunctinQuery
      Throws:
      UnimplementedException - supportsFunctionQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsFunctionQuery()} is {@code true} .

    • clearFunctionTerms

      void clearFunctionTerms()
      Clears the function query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchQualifierId

      void matchQualifierId(Id qualifierId, boolean match)
      Matches the qualifier identified by the given Id .
      Parameters:
      qualifierId - the Id of the Qualifier
      match - true if 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(boolean match)
      Gets the qualiier query.
      Parameters:
      match - true if a positive match, false for a negative match
      Returns:
      the QualifierQuery
      Throws:
      UnimplementedException - supportsQualifierQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsQualifierQuery()} is {@code true} .

    • clearQualifierTerms

      void clearQualifierTerms()
      Clears the qualifier 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 {@code supportsVaultQuery()} is {@code true} .

    • clearVaultTerms

      void clearVaultTerms()
      Clears the vault query terms.
      Compliance:
      mandatory - This method must be implemented.

    • getAuthorizationQueryRecord

      AuthorizationQueryRecord getAuthorizationQueryRecord(Type authorizationRecordType) throws OperationFailedException
      Gets the authorization query record corresponding to the given Authorization record Type . Multiple retrievals produce a nested OR term.
      Parameters:
      authorizationRecordType - an authorization record type
      Returns:
      the authorization query record
      Throws:
      NullArgumentException - authorizationRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(authorizationRecordType) is false
      Compliance:
      mandatory - This method must be implemented.