OSID - osid.authentication.AgentQuery Service Interface Definition

Interface	osid.authentication.AgentQuery
Implements	`osid.OsidObjectQuery`
Description	This is the query for searching agents. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.` The following example returns agents whose display name begins with "Tom" and whose "login name" is "tom" or "tjcoppet" in an agent record specified by `companyAgentType.` Agent Query query = session.getAgentQuery(); query.matchDisplayName("Tom*", wildcardStringMatchType, true); companyAgentQuery = query.getAgentQueryRecord(companyAgentType); companyAgentQuery.matchLoginName("tom"); companyAgentQuery = query.getAgentQueryRecord(companyAgentType); companyAgentQuery.matchLoginName("tjcoppet"); AgentList agentList = session.getAgentsByQuery(query);
Method	matchResourceId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`agencyId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`agencyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceIdTerms
Description	Clears the resource `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsResourceQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a resource query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceQuery
Description	Gets the query for a resource. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsResourceQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsResourceQuery()` is `true.`
Method	matchAnyResource
Description	Matches agents with any resource.
Parameters	`boolean`	`match`	`true` if to match agents with a resource, `false` to match agents with no resource
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceTerms
Description	Clears the resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAgencyId
Description	Sets the agency `Id` for this query.
Parameters	`osid.id.Id`	`agencyId`	an agency `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for negative match
Errors	NULL_ARGUMENT		`agencyId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAgencyIdTerms
Description	Clears the agency `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAgencyQuery
Description	Tests if an `AgencyQuery` is available.
Return	`boolean`		`true` if an agency query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgencyQuery
Description	Gets the query for an agency. Multiple retrievals produce a nested `OR` term.
Return	`osid.authentication.AgencyQuery`		the agency query
Errors	UNIMPLEMENTED		`supportsAgencyQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAgencyQuery()` is `true.`
Method	clearAgencyTerms
Description	Clears the agency terms.
Compliance	`mandatory`		This method must be implemented.
Method	getAgentQueryRecord
Description	Gets the agent query record corresponding to the given `Agent` record `Type.` Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`agentRecordType`	an agent record type
Return	`osid.authentication.records.AgentQueryRecord`		the agent query record
Errors	NULL_ARGUMENT		`agentRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(agentRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.