documentation:developer:zzz_archive:backend-devel:open-ils_storage_methods_action
Table of Contents
open-ils.storage.action.circulation.overdue
Finds overdue circulations.
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: Op enILS::Application::Storage::Publisher::action::grab_overdue
- Streaming Method: Yes
- Cachable Method: No
- Parameters:
- grace_period_size
The number of fine_interval's to allow for a return grace period after the circulation is overdue based on due_date.
- Returns:
- Success
A stream of Fieldmapper::action::circulation objects, or not if none are overdue. - Failure
An exception explaining the failure.
open-ils.storage.action.circulation.overdue.generate_fines
Initiates fine generation on one or all overdue circulations.
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: Ope nILS::Application::Storage::Publisher::money::generate_fines
- Streaming Method: Yes
- Cachable Method: No
- Parameters:
- grace_period_size
The number of fine_interval's to allow for a return grace period after the circulation is overdue based on due_date. - circulation_id (optional)
A specific cirulation on which to generate fines, as opposed to all overdue circulations.
- Returns:
- Success
A stream of text messages explaining the progress of fine generation process. - Failure
An execption explaining the failure.
open-ils.storage.action.circulation.patron_summary
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenILS::Application::Storage::Publisher::action::patron_circ_summary
- Streaming Method: No
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
open-ils.storage.action.survey.all
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenILS::Application::Storage::Publisher::action::find_local_surveys
- Streaming Method: Yes
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
open-ils.storage.action.survey.all.atomic
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenSRF::Application::make_stream_atomic
- Streaming Method: No
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
open-ils.storage.action.survey.opac
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenILS::Application::Storage::Publisher::action::find_opac_surveys
- Streaming Method: Yes
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
open-ils.storage.action.survey.opac.atomic
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenSRF::Application::make_stream_atomic
- Streaming Method: No
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
open-ils.storage.action.survey.optional
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenILS::Application::Storage::Publisher::action::find_optional_surveys
- Streaming Method: Yes
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
open-ils.storage.action.survey.optional.atomic
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenSRF::Application::make_stream_atomic
- Streaming Method: No
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
open-ils.storage.action.survey.required
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenILS::Application::Storage::Publisher::action::find_required_surveys
- Streaming Method: Yes
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
open-ils.storage.action.survey.required.atomic
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenSRF::Application::make_stream_atomic
- Streaming Method: No
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
open-ils.storage.action.survey.usr_summary
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenILS::Application::Storage::Publisher::action::find_usr_summary_surveys
- Streaming Method: Yes
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
===== open-ils.storage.action.survey.usr_summary.atomic =====
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenSRF::Application::make_stream_atomic
- Streaming Method: No
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
open-ils.storage.action.survey_response.next_group_id
what I do
- API Level: 1
- Server Class: open-ils.storage
- Implementation Method: OpenILS::Application::Storage::Publisher::action::next_resp_group_id
- Streaming Method: No
- Cachable Method: No
- Parameters:
- param1
what it is…
- Returns:
- Success
successful format - Failure
failure format (exception, etc)
documentation/developer/zzz_archive/backend-devel/open-ils_storage_methods_action.txt · Last modified: 2022/02/10 13:34 by 127.0.0.1