OSID - osid.personnel.OrganizationQuery Service Interface Definition

Interface	osid.personnel.OrganizationQuery
Implements	`osid.OsidObjectQuery`
	`osid.OsidFederateableQuery`
	`osid.OsidTemporalQuery`
Description	This is the query for searching organizations. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR.`
Method	matchDisplayLabel
Description	Matches a display label.
Parameters	`string`	`label`	a display label
	`osid.type.Type`	`stringMatchType`	a string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`label` is not of `stringMatchType`
	NULL_ARGUMENT		`label` or `stringMatchType` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyDisplayLabel
Description	Matches organizations with any display label.
Parameters	`boolean`	`match`	`true` to match organizations with any display label, `false` to match organizations with no display label
Compliance	`mandatory`		This method must be implemented.
Method	clearDisplayLabelTerms
Description	Clears all display label terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorOrganizationId
Description	Sets the organization `Id` for this query to match organizations that have the specified organization as an ancestor.
Parameters	`osid.id.Id`	`organizationId`	an organization `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`organizationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorOrganizationIdTerms
Description	Clears the ancestor organization `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorOrganizationQuery
Description	Tests if an `OrganizationQuery` is available.
Return	`boolean`		`true` if an organization query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorOrganizationQuery
Description	Gets the query for an organization. Multiple retrievals produce a nested `OR` term.
Return	`osid.personnel.OrganizationQuery`		the organization query
Errors	UNIMPLEMENTED		`supportsAncestorOrganizationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorOrganizationQuery()` is `true.`
Method	matchAnyAncestorOrganization
Description	Matches agencies with any organization ancestor.
Parameters	`boolean`	`match`	`true` to match organizations with any ancestor, `false` to match root organizations
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorOrganizationTerms
Description	Clears the ancestor organization query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantOrganizationId
Description	Sets the organization `Id` for this query to match organizations that have the specified organization as a descendant.
Parameters	`osid.id.Id`	`organizationId`	an organization `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`organizationId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantOrganizationIdTerms
Description	Clears the descendant organization `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantOrganizationQuery
Description	Tests if an `OrganizationQuery` is available.
Return	`boolean`		`true` if an organization query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantOrganizationQuery
Description	Gets the query for an organization. Multiple retrievals produce a nested `OR` term.
Return	`osid.personnel.OrganizationQuery`		the organization query
Errors	UNIMPLEMENTED		`supportsDescendantOrganizationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantOrganizationQuery()` is `true.`
Method	matchAnyDescendantOrganization
Description	Matches organizations with any organization descendant.
Parameters	`boolean`	`match`	`true` to match organizations with any descendant, `false` to match leaf organizations
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantOrganizationTerms
Description	Clears the descendant organization query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchRealmId
Description	Sets the realm `Id` for this query to match organizations assigned to realms.
Parameters	`osid.id.Id`	`realmId`	a realm `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`realmId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearRealmIdTerms
Description	Clears all realm `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsRealmQuery
Description	Tests if a `RealmQuery` is available.
Return	`boolean`		`true` if a realm query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRealmQuery
Description	Gets the query for a realm query. Multiple retrievals produce a nested `OR` term.
Return	`osid.personnel.RealmQuery`		the realm query
Errors	UNIMPLEMENTED		`supportsRealmQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsRealmQuery()` is `true.`
Method	clearRealmTerms
Description	Clears all realm terms.
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationQueryRecord
Description	Gets the organization query record corresponding to the given `Organization` record `Type.` Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`organizationRecordType`	an organization record type
Return	`osid.personnel.records.OrganizationQueryRecord`		the organization query record
Errors	NULL_ARGUMENT		`organizationRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(organizationRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.