OSID - osid.transport.EndpointQuery Service Interface Definition

Interface	osid.transport.EndpointQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.transport.EndpointQuery`
	`osid.transport.EndpointQuerySession`
	`osid.transport.EndpointSearchSession`
Description	This is the query for searching endpoints. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchResourceId
Description	Sets the resource `Id` for this query.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`boolean`	`match`	`true` for 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 `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 endpoints with any resource.
Parameters	`boolean`	`match`	`true` to match endpoints with any resource, `false` to match endpoints with no resources
Compliance	`mandatory`		This method must be implemented.
Method	clearResourceTerms
Description	Clears the resource terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorEndpointId
Description	Sets the endpoint `Id` for this query to match endpoints that have the specified endpoint as an ancestor.
Parameters	`osid.id.Id`	`endpointid`	a endpoint `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`endpointId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorEndpointIdTerms
Description	Clears the ancestor endpoint `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorEndpointQuery
Description	Tests if a `EndpointQuery` is available.
Return	`boolean`		`true` if a endpoint query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorEndpointQuery
Description	Gets the query for a endpoint. Multiple retrievals produce a nested `OR` term.
Return	`osid.transport.EndpointQuery`		the endpoint query
Errors	UNIMPLEMENTED		`supportsAncestorEndpointQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorEndpointQuery()` is `true`.
Method	matchAnyAncestorEndpoint
Description	Matches endpoints with any ancestor.
Parameters	`boolean`	`match`	`true` to match endpoints with any ancestor, `false` to match root endpoints
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorEndpointTerms
Description	Clears the ancestor endpoint terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantEndpointId
Description	Sets the endpoint `Id` for this query to match endpoints that have the specified endpoint as a descendant.
Parameters	`osid.id.Id`	`endpointid`	a endpoint `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`endpointId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantEndpointIdTerms
Description	Clears the descendant endpoint `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantEndpointQuery
Description	Tests if a `EndpointQuery` is available.
Return	`boolean`		`true` if a endpoint query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantEndpointQuery
Description	Gets the query for a endpoint. Multiple retrievals produce a nested `OR` term.
Return	`osid.transport.EndpointQuery`		the endpoint query
Errors	UNIMPLEMENTED		`supportsDescendantEndpointQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantEndpointQuery()` is `true`.
Method	matchAnyDescendantEndpoint
Description	Matches endpoints with any descendant.
Parameters	`boolean`	`match`	`true` to match endpoints with any descendant, `false` to match leaf endpoints
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantEndpointTerms
Description	Clears the descendant endpoint terms.
Compliance	`mandatory`		This method must be implemented.
Method	getEndpointQueryRecord
Description	Gets the endpoint query record corresponding to the given `Endpoint` record `Type` .Multiple retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`endpointRecordType`	a endpoint record type
Return	`osid.transport.records.EndpointQueryRecord`		the endpoint query record
Errors	NULL_ARGUMENT		`endpointRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(endpointRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.