OSID - osid.financials.ActivityQuery Service Interface Definition

Interface	osid.financials.ActivityQuery
Implements	`osid.OsidObjectQuery`
	`osid.OsidFederateableQuery`
	`osid.OsidTemporalQuery`
Used By	`osid.billing.CustomerQuery`
	`osid.financials.ActivityQuery`
	`osid.financials.ActivityQuerySession`
	`osid.financials.ActivitySearchSession`
	`osid.financials.ActivitySmartBusinessSession`
	`osid.financials.BusinessQuery`
	`osid.financials.budgeting.BudgetQuery`
	`osid.financials.posting.PostEntryQuery`
Description	This is the query for searching activities. Each method match specifies an `AND` term while multiple invocations of the same method produce a nested `OR`.
Method	matchOrganizationId
Description	Sets the organization `Id` for this query.
Parameters	`osid.id.Id`	`organizationId`	a resource `Id`
Parameters	`boolean`	`match`	`true` if 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 the organization `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsOrganizationQuery
Description	Tests if a `ResourceQuery` 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. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsOrganizationQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsOrganizationQuery()` is `true`.
Method	matchAnyOrganization
Description	Matches an activity that has any organization.
Parameters	`boolean`	`match`	`true` to match activities with any organization, `false` to match activities with no organization
Compliance	`mandatory`		This method must be implemented.
Method	clearOrganizationTerms
Description	Clears the organization terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchSupervisorId
Description	Sets the supervisor `Id` for this query.
Parameters	`osid.id.Id`	`supervisorId`	a resource `Id`
Parameters	`boolean`	`match`	`true` if a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`supervisorId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearSupervisorIdTerms
Description	Clears the supervisor `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSupervisorQuery
Description	Tests if a `ResourceQuery` is available.
Return	`boolean`		`true` if a supervisor query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSupervisorQuery
Description	Gets the query for a supervisor. Multiple retrievals produce a nested `OR` term.
Return	`osid.resource.ResourceQuery`		the resource query
Errors	UNIMPLEMENTED		`supportsSupervisorQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSupervisorQuery()` is `true`.
Method	matchAnySupervisor
Description	Matches an activity that has any supervisor.
Parameters	`boolean`	`match`	`true` to match activities with any supervisor, `false` to match activities with no supervisor
Compliance	`mandatory`		This method must be implemented.
Method	clearSupervisorTerms
Description	Clears the supervisor terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchCode
Description	Matches an activity code.
Parameters	`string`	`code`	a code
	`osid.type.Type`	`stringMatchType`	the string match type
	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	INVALID_ARGUMENT		`code` is not of `stringMatchType`
	NULL_ARGUMENT		`code` is `null`
	UNSUPPORTED		`supportsStringMatchType(stringMatchType)` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	matchAnyCode
Description	Matches an activity that has any code assigned.
Parameters	`boolean`	`match`	`true` to match activities with any code, `false` to match activities with no code
Compliance	`mandatory`		This method must be implemented.
Method	clearCodeTerms
Description	Clears the code terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsSummaryQuery
Description	Tests if a `SummaryQuery` is available.
Return	`boolean`		`true` if a summery query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSummaryQuery
Description	Gets the query for a summary. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.SummaryQuery`		the summery query
Errors	UNIMPLEMENTED		`supportsSummeryQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsSupervisorQuery()` is `true`.
Method	clearSummaryTerms
Description	Clears the summary terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchAncestorActivityId
Description	Sets the activity `Id` for this query to match activities that have the specified activity as an ancestor.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`activityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorActivityIdTerms
Description	Clears the ancestor activity `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsAncestorActivityQuery
Description	Tests if an `ActivityQuery` is available.
Return	`boolean`		`true` if an activity query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAncestorActivityQuery
Description	Gets the query for an activity. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.ActivityQuery`		the activity query
Errors	UNIMPLEMENTED		`supportsAncestorActivityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsAncestorActivityQuery()` is `true`.
Method	matchAnyAncestorActivity
Description	Matches activities with any activity ancestor.
Parameters	`boolean`	`match`	`true` to match activities with any ancestor, `false` to match root activities
Compliance	`mandatory`		This method must be implemented.
Method	clearAncestorActivityTerms
Description	Clears the ancestor activity query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchDescendantActivityId
Description	Sets the activity `Id` for this query to match activities that have the specified activity as a descendant.
Parameters	`osid.id.Id`	`activityId`	an activity `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`activityId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantActivityIdTerms
Description	Clears the descendant activity `Id` query terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsDescendantActivityQuery
Description	Tests if an `ActivityQuery` is available.
Return	`boolean`		`true` if an activity query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getDescendantActivityQuery
Description	Gets the query for an activity. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.ActivityQuery`		the activity query
Errors	UNIMPLEMENTED		`supportsDescendantActivityQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsDescendantActivityQuery()` is `true`.
Method	matchAnyDescendantActivity
Description	Matches activities with any activity descendant.
Parameters	`boolean`	`match`	`true` to match activities with any descendant, `false` to match leaf activities
Compliance	`mandatory`		This method must be implemented.
Method	clearDescendantActivityTerms
Description	Clears the descendant activity query terms.
Compliance	`mandatory`		This method must be implemented.
Method	matchBusinessId
Description	Sets the business `Id` for this query to match activities assigned to businesses.
Parameters	`osid.id.Id`	`businessId`	the business `Id`
Parameters	`boolean`	`match`	`true` for a positive match, `false` for a negative match
Errors	NULL_ARGUMENT		`businessId` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	clearBusinessIdTerms
Description	Clears the business `Id` terms.
Compliance	`mandatory`		This method must be implemented.
Method	supportsBusinessQuery
Description	Tests if a `BusinessQuery` is available.
Return	`boolean`		`true` if a business query is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getBusinessQuery
Description	Gets the query for a business. Multiple retrievals produce a nested `OR` term.
Return	`osid.financials.BusinessQuery`		the business query
Errors	UNIMPLEMENTED		`supportsBusinessQuery()` is `false`
Compliance	`optional`		This method must be implemented if `supportsBusinessQuery()` is `true`.
Method	clearBusinessTerms
Description	Clears the business terms.
Compliance	`mandatory`		This method must be implemented.
Method	getActivityQueryRecord
Description	Gets the activity query record corresponding to the given `Activity` record `Type` .Multiple record retrievals produce a nested `OR` term.
Parameters	`osid.type.Type`	`activityRecordType`	an activity record type
Return	`osid.financials.records.ActivityQueryRecord`		the activity query record
Errors	NULL_ARGUMENT		`activityRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	UNSUPPORTED		`hasRecordType(activityRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.