API:EPrints/DataObj/SavedSearch
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
NAME
EPrints::DataObj::SavedSearch - Single saved search.
DESCRIPTION
A saved search is a sub class of EPrints::DataObj.
Each one belongs to one and only one user, although one user may own multiple saved searches.
$field_config = EPrints::DataObj::SavedSearch->get_system_field_info
Return an array describing the system metadata of the saved search. dataset.
$dataset = EPrints::DataObj::SavedSearch->get_dataset_id
Returns the id of the EPrints::DataSet object to which this record belongs.
$success = $saved_search->commit( [$force] )
Write this object to the database.
If $force isn't true then it only actually modifies the database if one or more fields have been changed.
$user = $saved_search->get_user
Return the EPrints::User which owns this saved search.
$searchexp = $saved_search->make_searchexp
Return a EPrints::Search describing how to find the eprints which are in the scope of this saved search.
$saved_search->send_out_alert
Send out an email for this subcription. If there are no matching new items then an email is only sent if the saved search has mailempty set to true.
EPrints::DataObj::SavedSearch::process_set( $session, $frequency );
Static method. Calls send_out_alert on every saved search with a frequency matching $frequency.
Also saves a file logging that the alerts for this frequency was sent out at the current time.
$timestamp = EPrints::DataObj::SavedSearch::get_last_timestamp( $session, $frequency );
Static method. Return the timestamp of the last time this frequency of alert was sent.
$boolean = $user->has_owner( $possible_owner )
True if the users are the same record.
