OSID - osid.personnel.RealmQuery Service Interface Definition

Interface	osid.personnel.RealmQuery
Implements	`osid.OsidCatalogQuery`
Used By	`osid.personnel.AppointmentQuery`
	`osid.personnel.OrganizationQuery`
	`osid.personnel.PersonQuery`
	`osid.personnel.PositionQuery`
	`osid.personnel.RealmQuery`
	`osid.personnel.RealmQuerySession`
	`osid.personnel.RealmSearchSession`
Description	This is the query for searching for realms. Each method specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchPersonId
Description	Sets the person `Id` for this query to match persons assigned to realms.
Parameters	`osid.id.Id`	`personId`	a person `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`personId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPersonIdTerms
Description	Clears all person `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPersonQuery
Description	Tests if a person query is available.
Return	`boolean`		`true` if a person query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPersonQuery
Description	Gets the query for a person.
Return	`osid.personnel.PersonQuery`		the person query
Errors	UNIMPLEMENTED		`supportsPersonQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPersonQuery()` is `true`.
Method	matchAnyPerson
Description	Matches realms with any person.
Parameters	`boolean`	`match`	`true` to match realms with any person, `false` to match realms with no persons
Compliance	`mandatory`		This method must be implemented.
Method	clearPersonTerms
Description	Clears all person terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchOrganizationId
Description	Sets the organization `Id` for this query to match organizations assigned to realms.
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	clearOrganizationIdTerms
Description	Clears all organization `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrganizationQuery
Description	Tests if an organization query is available.
Return	`boolean`		`true` if an organization query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getOrganizationQuery
Description	Gets the query for an organization.
Return	`osid.personnel.OrganizationQuery`		the organization query
Errors	UNIMPLEMENTED		`supportsOrganizationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOrganizationQuery()` is `true`.
Method	matchAnyOrganization
Description	Matches realms with any organization.
Parameters	`boolean`	`match`	`true` to match realms with any organization, `false` to match realms with no organizations
Compliance	`mandatory`		This method must be implemented.
Method	clearOrganizationTerms
Description	Clears all organization terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchPositionId
Description	Sets the position `Id` for this query to match positions assigned to realms.
Parameters	`osid.id.Id`	`positionId`	a position `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`positionId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearPositionIdTerms
Description	Clears all position `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsPositionQuery
Description	Tests if a position query is available.
Return	`boolean`		`true` if a position query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getPositionQuery
Description	Gets the query for a position.
Return	`osid.personnel.PositionQuery`		the position query
Errors	UNIMPLEMENTED		`supportsPositionQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsPositionQuery()` is `true`.
Method	matchAnyPosition
Description	Matches realms with any position.
Parameters	`boolean`	`match`	`true` to match realms with any position, `false` to match realms with no positions
Compliance	`mandatory`		This method must be implemented.
Method	clearPositionTerms
Description	Clears all position terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAppointmentId
Description	Sets the appointment `Id` for this query to match positions assigned to realms.
Parameters	`osid.id.Id`	`appointmentId`	an appointment `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`appointmentId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAppointmentIdTerms
Description	Clears all appointment `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAppointmentQuery
Description	Tests if an appointment query is available.
Return	`boolean`		`true` if an appointment query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAppointmentQuery
Description	Gets the query for an appointment.
Return	`osid.personnel.AppointmentQuery`		the appointment query
Errors	UNIMPLEMENTED		`supportsAppointmentQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAppointmentQuery()` is `true`.
Method	matchAnyAppointment
Description	Matches realms with any appointment.
Parameters	`boolean`	`match`	`true` to match realms with any appointment, `false` to match realms with no appointments
Compliance	`mandatory`		This method must be implemented.
Method	clearAppointmentTerms
Description	Clears all appointment terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorRealmId
Description	Sets the realm `Id` for this query to match realms that have the specified realm as an ancestor.
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	clearAncestorRealmIdTerms
Description	Clears all ancestor realm `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorRealmQuery
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	getAncestorRealmQuery
Description	Gets the query for a realm. Multiple retrievals produce a nested `OR` term.
Return	`osid.personnel.RealmQuery`		the realm query
Errors	UNIMPLEMENTED		`supportsAncestorRealmQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorRealmQuery()` is `true`.
Method	matchAnyAncestorRealm
Description	Matches realms with any ancestor.
Parameters	`boolean`	`match`	`true` to match realms with any ancestor, `false` to match root realms
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorRealmTerms
Description	Clears all ancestor realm terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantRealmId
Description	Sets the realm `Id` for this query to match realms that have the specified realm as a descendant.
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	clearDescendantRealmIdTerms
Description	Clears all descendant realm `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantRealmQuery
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	getDescendantRealmQuery
Description	Gets the query for a realm. Multiple retrievals produce a nested `OR` term.
Return	`osid.personnel.RealmQuery`		the realm query
Errors	UNIMPLEMENTED		`supportsDescendantRealmQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantRealmQuery()` is `true`.
Method	matchAnyDescendantRealm
Description	Matches realms with any descendant.
Parameters	`boolean`	`match`	`true` to match realms with any descendant, `false` to match leaf realms
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantRealmTerms
Description	Clears all descendant realm terms.
Compliance	`mandatory`		This method must be implemented.
Method	getRealmQueryRecord
Description	Gets the record query corresponding to the given `Realm` record `Type`.Multiple record retrievals produce a nested boolean `OR` term.
Parameters	`osid.type.Type`	`realmRecordType`	a realm record type
Return	`osid.personnel.records.RealmQueryRecord`		the realm query record
Errors	NULL_ARGUMENT		`realmRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(realmRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.