Interface | osid.billing.PeriodQuerySession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for searching among This session defines views that offer differing behaviors for searching.
Periods may have a query record indicated by their
respective record types. The query record is accessed via the
| ||
Method | getBusinessId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Business Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBusiness | ||
Description |
Gets the | ||
Return | osid.billing.Business | the business | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canSearchPeriods | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if search methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useFederatedBusinessView | ||
Description |
Federates the view for methods in this session. A federated view will include periods in business which are children of this business in the business hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedBusinessView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts lookups to this business only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getPeriodQuery | ||
Description |
Gets a period query. | ||
Return | osid.billing.PeriodQuery | the period query | |
Compliance | mandatory | This method must be implemented. | |
Method | getPeriodsByQuery | ||
Description |
Gets a list of | ||
Parameters | osid.billing.PeriodQuery | periodQuery | the period query |
Return | osid.billing.PeriodList | the returned PeriodList | |
Errors | NULL_ARGUMENT | periodQuery is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | periodQuery is not of this service | ||
Compliance | mandatory | This method must be implemented. |