<<

NAME

Koha::Recall - Koha Recall Object class

API

Class methods

biblio

    my $biblio = $recall->biblio;

Returns the related Koha::Biblio object for this recall.

item

    my $item = $recall->item;

Returns the related Koha::Item object for this recall.

patron

    my $patron = $recall->patron;

Returns the related Koha::Patron object for this recall.

library

    my $library = $recall->library;

Returns the related Koha::Library object for this recall.

checkout

    my $checkout = $recall->checkout;

Returns the related Koha::Checkout object for this recall.

requested

    if ( $recall->requested )

    [% IF recall.requested %]

Return true if recall status is requested.

waiting

    if ( $recall->waiting )

    [% IF recall.waiting %]

Return true if recall is awaiting pickup.

overdue

    if ( $recall->overdue )

    [% IF recall.overdue %]

Return true if recall is overdue to be returned.

in_transit

    if ( $recall->in_transit )

    [% IF recall.in_transit %]

Return true if recall is in transit.

expired

    if ( $recall->expired )

    [% IF recall.expired %]

Return true if recall has expired.

cancelled

    if ( $recall->cancelled )

    [% IF recall.cancelled %]

Return true if recall has been cancelled.

fulfilled

    if ( $recall->fulfilled )

    [% IF recall.fulfilled %]

Return true if the recall has been fulfilled.

calc_expirationdate

    my $expirationdate = $recall->calc_expirationdate;
    $recall->update({ expirationdate => $expirationdate });

Calculate the expirationdate to set based on circulation rules and system preferences.

start_transfer

    my ( $recall, $dotransfer, $messages ) = $recall->start_transfer({ item => $item_object });

Set the recall as in transit.

revert_transfer

    $recall->revert_transfer;

If a transfer is cancelled, revert the recall to requested.

set_waiting

    $recall->set_waiting(
        {   expirationdate => $expirationdate,
            item           => $item_object
        }
    );

Set the recall as waiting and update expiration date. Notify the recall requester.

revert_waiting

    $recall->revert_waiting;

Revert recall waiting status.

should_be_overdue

    if ( $recall->should_be_overdue ) {
        $recall->set_overdue;
    }

Return true if this recall should be marked overdue

set_overdue

    $recall->set_overdue;

Set a recall as overdue when the recall has been requested and the borrower who has checked out the recalled item is late to return it. This can be done manually by the library or by cronjob. The interface is either 'INTRANET' or 'COMMANDLINE' for logging purposes.

set_expired

    $recall->set_expired({ interface => 'INTRANET' });

Set a recall as expired. This may be done manually or by a cronjob, either when the borrower that placed the recall takes more than RecallsMaxPickUpDelay number of days to collect their item, or if the specified expirationdate passes. The interface is either 'INTRANET' or 'COMMANDLINE' for logging purposes.

set_cancelled

    $recall->set_cancelled;

Set a recall as cancelled. This may be done manually, either by the borrower that placed the recall, or by the library.

set_fulfilled

    $recall->set_fulfilled;

Set a recall as finished. This should only be called when the item allocated to a recall is checked out to the borrower who requested the recall.

strings_map

Returns a map of column name to string representations including the string.

Internal methods

_type

<<