OSID Logo
OSID Specifications
authorization package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authorization.AuthorizationQuery
Implementsosid.OsidRelationshipQuery
Description

The query for authorizations.

MethodmatchExplicitAuthorizations
Description

Matches explciit authorizations.

Parametersbooleanmatch true to match explicit authorizations, false to match implciit authorizations
CompliancemandatoryThis method must be implemented.
MethodclearExplicitAuthorizationsTerms
Description

Clears the explicit authorization query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchRelatedAuthorizationId
Description

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.

Parametersosid.id.Idid Id to match
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT id is null
CompliancemandatoryThis method must be implemented.
MethodclearRelatedAuthorizationIdTerms
Description

Clears the related authorization Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsRelatedAuthorizationQuery
Description

Tests if an AuthorizationQuery is available.

Returnboolean true if an authorization query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetRelatedAuthorizationQuery
Description

Gets the authorization query.

Parametersbooleanmatch true if a positive match, false for a negative match
Returnosid.authorization.AuthorizationQuerythe AuthorizationQuery
ErrorsUNIMPLEMENTED supportsRelatedAuthorizationQuery() is false
ComplianceoptionalThis method must be implemented if supportsRelatedAuthorizationQuery() is true.
MethodclearRelatedAuthorizationTerms
Description

Clears the related authorization query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchResourceId
Description

Matches the resource identified by the given Id.

Parametersosid.id.IdresourceIdthe Id of the Resource
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT resourceId is null
CompliancemandatoryThis method must be implemented.
MethodclearResourceIdTerms
Description

Clears the resource Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsResourceQuery
Description

Tests if a ResourceQuery is available.

Returnboolean true if a resource query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetResourceQuery
Description

Gets the resource query.

Parametersbooleanmatch true if a positive match, false for a negative match
Returnosid.resource.ResourceQuerythe ResourceQuery
ErrorsUNIMPLEMENTED supportsResourceQuery() is false
ComplianceoptionalThis method must be implemented if supportsResourceQuery() is true.
MethodmatchAnyResource
Description

Matches authorizations that have any resource.

Parametersbooleanmatch true to match authorizations with any resource, false to match authorizations with no resource
CompliancemandatoryThis method must be implemented.
MethodclearResourceTerms
Description

Clears the resource query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchTrustId
Description

Matches the trust identified by the given Id.

Parametersosid.id.IdtrustIdthe Id of the Trust
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT trustId is null
CompliancemandatoryThis method must be implemented.
MethodmatchAnyTrustId
Description

Matches authorizations that have any trust defined.

Parametersbooleanmatch true to match authorizations with any trust, false to match authorizations with no trusts
CompliancemandatoryThis method must be implemented.
MethodclearTrustIdTerms
Description

Clears the trust Id query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchAgentId
Description

Matches the agent identified by the given Id.

Parametersosid.id.IdagentIdthe Id of the Agent
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT agentId is null
CompliancemandatoryThis method must be implemented.
MethodclearAgentIdTerms
Description

Clears the agent Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsAgentQuery
Description

Tests if an AgentQuery is available.

Returnboolean true if an agent query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAgentQuery
Description

Gets the agent query.

Parametersbooleanmatch true if a positive match, false for a negative match
Returnosid.authentication.AgentQuerythe AgentQuery
ErrorsUNIMPLEMENTED supportsAgentQuery() is false
ComplianceoptionalThis method must be implemented if supportsAgentQuery() is true.
MethodmatchAnyAgent
Description

Matches authorizations that have any agent.

Parametersbooleanmatch true to match authorizations with any agent, false to match authorizations with no agent
CompliancemandatoryThis method must be implemented.
MethodclearAgentTerms
Description

Clears the agent query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchFunctionId
Description

Matches the function identified by the given Id.

Parametersosid.id.IdfunctionIdthe Id of the Function
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT functionId is null
CompliancemandatoryThis method must be implemented.
MethodclearFunctionIdTerms
Description

Clears the function Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsFunctionQuery
Description

Tests if a FunctionQuery is available.

Returnboolean true if a function query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetFunctionQuery
Description

Gets the function query.

Parametersbooleanmatch true if a positive match, false for a negative match
Returnosid.authorization.FunctionQuerythe FunctinQuery
ErrorsUNIMPLEMENTED supportsFunctionQuery() is false
ComplianceoptionalThis method must be implemented if supportsFunctionQuery() is true.
MethodclearFunctionTerms
Description

Clears the function query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchQualifierId
Description

Matches the qualifier identified by the given Id.

Parametersosid.id.IdqualifierIdthe Id of the Qualifier
booleanmatch true if a positive match, false for a negative match
ErrorsNULL_ARGUMENT qualifierId is null
CompliancemandatoryThis method must be implemented.
MethodclearQualifierIdTerms
Description

Clears the qualifier Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsQualifierQuery
Description

Tests if a QualifierQuery is available.

Returnboolean true if a qualifier query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetQualifierQuery
Description

Gets the qualiier query.

Parametersbooleanmatch true if a positive match, false for a negative match
Returnosid.authorization.QualifierQuerythe QualifierQuery
ErrorsUNIMPLEMENTED supportsQualifierQuery() is false
ComplianceoptionalThis method must be implemented if supportsQualifierQuery() is true.
MethodclearQualifierTerms
Description

Clears the qualifier query terms.

CompliancemandatoryThis method must be implemented.
MethodmatchVaultId
Description

Sets the vault Id for this query.

Parametersosid.id.IdvaultIda vault Id
booleanmatch true for a positive match, false for a negative match
ErrorsNULL_ARGUMENT vaultId is null
CompliancemandatoryThis method must be implemented.
MethodclearVaultIdTerms
Description

Clears the vault Id query terms.

CompliancemandatoryThis method must be implemented.
MethodsupportsVaultQuery
Description

Tests if a VaultQuery is available.

Returnboolean true if a vault query is available, false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetVaultQuery
Description

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

Returnosid.authorization.VaultQuerythe vault query
ErrorsUNIMPLEMENTED supportsVaultQuery() is false
ComplianceoptionalThis method must be implemented if supportsVaultQuery() is true.
MethodclearVaultTerms
Description

Clears the vault query terms.

CompliancemandatoryThis method must be implemented.
MethodgetAuthorizationQueryRecord
Description

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

Parametersosid.type.TypeauthorizationRecordTypean authorization record type
Returnosid.authorization.records.AuthorizationQueryRecordthe authorization query record
ErrorsNULL_ARGUMENT authorizationRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(authorizationRecordType) is false
CompliancemandatoryThis method must be implemented.