Interface | osid.authorization.AuthorizationQuery | ||
---|---|---|---|
Implements | osid.OsidRelationshipQuery | ||
Description |
The query for authorizations. | ||
Method | matchExplicitAuthorizations | ||
Description |
Matches explciit authorizations. | ||
Parameters | boolean | match | true to match explicit authorizations, false
to match implciit authorizations |
Compliance | mandatory | This method must be implemented. | |
Method | clearExplicitAuthorizationsTerms | ||
Description |
Clears the explicit authorization query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchRelatedAuthorizationId | ||
Description |
Adds an | ||
Parameters | osid.id.Id | id | Id to match |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | id is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearRelatedAuthorizationIdTerms | ||
Description |
Clears the related authorization | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsRelatedAuthorizationQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an authorization query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRelatedAuthorizationQuery | ||
Description |
Gets the authorization query. | ||
Parameters | boolean | match | true if a positive match, false for a
negative match |
Return | osid.authorization.AuthorizationQuery | the AuthorizationQuery | |
Errors | UNIMPLEMENTED | supportsRelatedAuthorizationQuery() is false | |
Compliance | optional | This method must be implemented if
supportsRelatedAuthorizationQuery() is true. | |
Method | clearRelatedAuthorizationTerms | ||
Description |
Clears the related authorization query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchResourceId | ||
Description |
Matches the resource identified by the given | ||
Parameters | osid.id.Id | resourceId | the Id of the Resource |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | resourceId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearResourceIdTerms | ||
Description |
Clears the resource | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsResourceQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a resource query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getResourceQuery | ||
Description |
Gets the resource query. | ||
Parameters | boolean | match | true if a positive match, false for a
negative match |
Return | osid.resource.ResourceQuery | the ResourceQuery | |
Errors | UNIMPLEMENTED | supportsResourceQuery() is false | |
Compliance | optional | This method must be implemented if supportsResourceQuery()
is true. | |
Method | matchAnyResource | ||
Description |
Matches authorizations that have any resource. | ||
Parameters | boolean | match | true to match authorizations with any resource, false
to match authorizations with no resource |
Compliance | mandatory | This method must be implemented. | |
Method | clearResourceTerms | ||
Description |
Clears the resource query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchTrustId | ||
Description |
Matches the trust identified by the given | ||
Parameters | osid.id.Id | trustId | the Id of the Trust |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | trustId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | matchAnyTrustId | ||
Description |
Matches authorizations that have any trust defined. | ||
Parameters | boolean | match | true to match authorizations with any trust, false
to match authorizations with no trusts |
Compliance | mandatory | This method must be implemented. | |
Method | clearTrustIdTerms | ||
Description |
Clears the trust | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAgentId | ||
Description |
Matches the agent identified by the given | ||
Parameters | osid.id.Id | agentId | the Id of the Agent |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | agentId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAgentIdTerms | ||
Description |
Clears the agent | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAgentQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an agent query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAgentQuery | ||
Description |
Gets the agent query. | ||
Parameters | boolean | match | true if a positive match, false for a
negative match |
Return | osid.authentication.AgentQuery | the AgentQuery | |
Errors | UNIMPLEMENTED | supportsAgentQuery() is false | |
Compliance | optional | This method must be implemented if supportsAgentQuery() is
true. | |
Method | matchAnyAgent | ||
Description |
Matches authorizations that have any agent. | ||
Parameters | boolean | match | true to match authorizations with any agent, false
to match authorizations with no agent |
Compliance | mandatory | This method must be implemented. | |
Method | clearAgentTerms | ||
Description |
Clears the agent query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchFunctionId | ||
Description |
Matches the function identified by the given | ||
Parameters | osid.id.Id | functionId | the Id of the Function |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | functionId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearFunctionIdTerms | ||
Description |
Clears the function | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsFunctionQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a function query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFunctionQuery | ||
Description |
Gets the function query. | ||
Parameters | boolean | match | true if a positive match, false for a
negative match |
Return | osid.authorization.FunctionQuery | the FunctinQuery | |
Errors | UNIMPLEMENTED | supportsFunctionQuery() is false | |
Compliance | optional | This method must be implemented if supportsFunctionQuery()
is true. | |
Method | clearFunctionTerms | ||
Description |
Clears the function query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchQualifierId | ||
Description |
Matches the qualifier identified by the given | ||
Parameters | osid.id.Id | qualifierId | the Id of the Qualifier |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | qualifierId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearQualifierIdTerms | ||
Description |
Clears the qualifier | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsQualifierQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a qualifier query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getQualifierQuery | ||
Description |
Gets the qualiier query. | ||
Parameters | boolean | match | true if a positive match, false for a
negative match |
Return | osid.authorization.QualifierQuery | the QualifierQuery | |
Errors | UNIMPLEMENTED | supportsQualifierQuery() is false | |
Compliance | optional | This method must be implemented if supportsQualifierQuery()
is true. | |
Method | clearQualifierTerms | ||
Description |
Clears the qualifier query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchVaultId | ||
Description |
Sets the vault | ||
Parameters | osid.id.Id | vaultId | a vault Id |
boolean | match | true for a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | vaultId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearVaultIdTerms | ||
Description |
Clears the vault | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsVaultQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a vault query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getVaultQuery | ||
Description |
Gets the query for a vault. Multiple retrievals produce
a nested | ||
Return | osid.authorization.VaultQuery | the vault query | |
Errors | UNIMPLEMENTED | supportsVaultQuery() is false | |
Compliance | optional | This method must be implemented if supportsVaultQuery() is
true. | |
Method | clearVaultTerms | ||
Description |
Clears the vault query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAuthorizationQueryRecord | ||
Description |
Gets the authorization query record corresponding to
the given | ||
Parameters | osid.type.Type | authorizationRecordType | an authorization record type |
Return | osid.authorization.records.AuthorizationQueryRecord | the authorization query record | |
Errors | NULL_ARGUMENT | authorizationRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(authorizationRecordType) is false
| ||
Compliance | mandatory | This method must be implemented. |