Interface | osid.financials.BusinessQuery | ||
---|---|---|---|
Implements | osid.OsidCatalogQuery | ||
Description |
This is the query for searching businesses. Each method
match specifies an | ||
Method | matchAccountId | ||
Description |
Sets the account | ||
Parameters | osid.id.Id | accountId | an account Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | accountId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearAccountIdTerms | ||
Description |
Clears the account | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAccountQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an account query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAccountQuery | ||
Description |
Gets the query for an account. Multiple retrievals
produce a nested | ||
Return | osid.financials.AccountQuery | the account query | |
Errors | UNIMPLEMENTED | supportsAccountQuery() is false | |
Compliance | optional | This method must be implemented if supportsAccountQuery() is
true. | |
Method | matchAnyAccount | ||
Description |
Matches businesses that have any account. | ||
Parameters | boolean | match | true to match businesses with any account, false
to match businesses with no accounts |
Compliance | mandatory | This method must be implemented. | |
Method | clearAccountTerms | ||
Description |
Clears the account query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchActivityId | ||
Description |
Sets the activity | ||
Parameters | osid.id.Id | activityId | an activity Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | activityId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearActivityIdTerms | ||
Description |
Clears the activity | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsActivityQuery | ||
Description |
Tests if an | ||
Return | boolean | true if an activity query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getActivityQuery | ||
Description |
Gets the query for an activity. Multiple retrievals
produce a nested | ||
Return | osid.financials.ActivityQuery | the activity query | |
Errors | UNIMPLEMENTED | supportsActivityQuery() is false | |
Compliance | optional | This method must be implemented if supportsActivityQuery()
is true. | |
Method | matchAnyActivity | ||
Description |
Matches businesses that have any activity. | ||
Parameters | boolean | match | true to match businesses with any activity, false
to match businesses with no activities |
Compliance | mandatory | This method must be implemented. | |
Method | clearActivityTerms | ||
Description |
Clears the activity query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchFiscalPeriodId | ||
Description |
Sets the fiscal period | ||
Parameters | osid.id.Id | fiscalPeriodId | a fiscal period Id |
boolean | match | true if a positive match, false for a
negative match | |
Errors | NULL_ARGUMENT | fiscalPeriodId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | clearFiscalPeriodIdTerms | ||
Description |
Clears the fiscal period | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsFiscalPeriodQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a fiscal period query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getFiscalPeriodQuery | ||
Description |
Gets the query for a fiscal period. Multiple retrievals
produce a nested | ||
Return | osid.financials.FiscalPeriodQuery | the fiscal period query | |
Errors | UNIMPLEMENTED | supportsFiscalPeriodQuery() is false | |
Compliance | optional | This method must be implemented if supportsFiscalPeriodQuery()
is true. | |
Method | matchAnyFiscalPeriod | ||
Description |
Matches businesses that have any fiscal period. | ||
Parameters | boolean | match | true to match businesses with any fiscal period,
false to match businesses with no fiscal period |
Compliance | mandatory | This method must be implemented. | |
Method | clearFiscalPeriodTerms | ||
Description |
Clears the fiscal period query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchAncestorBusinessId | ||
Description |
Sets the business | ||
Parameters | osid.id.Id | businessId | a business Id |
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 | clearAncestorBusinessIdTerms | ||
Description |
Clears the ancestor business | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsAncestorBusinessQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a business query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getAncestorBusinessQuery | ||
Description |
Gets the query for a business. Multiple retrievals
produce a nested | ||
Return | osid.financials.BusinessQuery | the business query | |
Errors | UNIMPLEMENTED | supportsAncestorBusinessQuery() is false | |
Compliance | optional | This method must be implemented if supportsAncestorBusinessQuery()
is true. | |
Method | matchAnyAncestorBusiness | ||
Description |
Matches businesses with any business ancestor. | ||
Parameters | boolean | match | true to match businesses with any ancestor, false
to match root businesses |
Compliance | mandatory | This method must be implemented. | |
Method | clearAncestorBusinessTerms | ||
Description |
Clears the ancestor business query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | matchDescendantBusinessId | ||
Description |
Sets the business | ||
Parameters | osid.id.Id | businessId | a business Id |
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 | clearDescendantBusinessIdTerms | ||
Description |
Clears the descendant business | ||
Compliance | mandatory | This method must be implemented. | |
Method | supportsDescendantBusinessQuery | ||
Description |
Tests if a | ||
Return | boolean | true if a business query is available, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDescendantBusinessQuery | ||
Description |
Gets the query for a business. Multiple retrievals
produce a nested | ||
Return | osid.financials.BusinessQuery | the business query | |
Errors | UNIMPLEMENTED | supportsDescendantBusinessQuery() is false | |
Compliance | optional | This method must be implemented if supportsDescendantBusinessQuery()
is true. | |
Method | matchAnyDescendantBusiness | ||
Description |
Matches agencies with any descendant business. | ||
Parameters | boolean | match | true to match businesses with any descendant, false
to match leaf businesses |
Compliance | mandatory | This method must be implemented. | |
Method | clearDescendantBusinessTerms | ||
Description |
Clears the descendant business query terms. | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBusinessQueryRecord | ||
Description |
Gets the business query record corresponding to the
given | ||
Parameters | osid.type.Type | businessRecordType | a business record type |
Return | osid.financials.records.BusinessQueryRecord | the business query record | |
Errors | NULL_ARGUMENT | businessRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | hasRecordType(businessRecordType) is false | ||
Compliance | mandatory | This method must be implemented. |