Interface | osid.financials.ActivityLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines views that offer differing behaviors when retrieving multiple objects.
Generally, the comparative view should be used for most
applications as it permits operation even if there is data
that cannot be accessed. The methods | ||
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.financials.Business | the business | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupActivities | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeActivityView | ||
Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | usePlenaryActivityView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedBusinessView | ||
Description |
Federates the view for methods in this session. A federated view will include activities in businesses 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 | useEffectiveActivityView | ||
Description |
Only activities whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveActivityView | ||
Description |
All activities of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getActivity | ||
Description |
Gets the In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned. | ||
Parameters | osid.id.Id | activityId | Id of the Activity |
Return | osid.financials.Activity | the activity | |
Errors | NOT_FOUND | activityId not found | |
NULL_ARGUMENT | activityId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getActivitiesByIds | ||
Description |
Gets an In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned. | ||
Parameters | osid.id.IdList | activityIds | the list of Ids to retrieve |
Return | osid.financials.ActivityList | the returned Activity list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | activityIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivitiesByGenusType | ||
Description |
Gets an In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned. | ||
Parameters | osid.type.Type | activityGenusType | an activity genus type |
Return | osid.financials.ActivityList | the returned Activity list | |
Errors | NULL_ARGUMENT | activityGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivitiesByParentGenusType | ||
Description |
Gets an In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned. | ||
Parameters | osid.type.Type | activityGenusType | an activity genus type |
Return | osid.financials.ActivityList | the returned Activity list | |
Errors | NULL_ARGUMENT | activityGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivitiesByRecordType | ||
Description |
Gets an In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned. | ||
Parameters | osid.type.Type | activityRecordType | an activity record type |
Return | osid.financials.ActivityList | the returned Activity list | |
Errors | NULL_ARGUMENT | activityRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivitiesOnDate | ||
Description |
Gets an In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.financials.ActivityList | the returned Activity list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | activityRecordType is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivitiesByOrganization | ||
Description |
Gets an In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.financials.ActivityList | the returned Activity list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivitiesByOrganizationOnDate | ||
Description |
Gets an In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.financials.ActivityList | the returned Activity list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId or activityRecordType is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivitiesByCode | ||
Description |
Gets an In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned. | ||
Parameters | string | code | an activity code |
Return | osid.financials.ActivityList | the returned Activity list | |
Errors | NULL_ARGUMENT | code is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getActivities | ||
Description |
Gets all In plenary mode, the returned list contains all known activities or an error results. Otherwise, the returned list may contain only those activities that are accessible through this session. In effective mode, activities are returned that are currently effective. In any effective mode, effective activities and those currently expired are returned. | ||
Return | osid.financials.ActivityList | a list of Activities | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |