Difference between revisions of "API:EPrints/DataObj/SavedSearch"
| Line 350: | Line 350: | ||
<!-- Pod2Wiki= --> | <!-- Pod2Wiki= --> | ||
</div> | </div> | ||
| − | <!-- Pod2Wiki= | + | <!-- Pod2Wiki=head_utility_methods --> |
| − | === | + | ===Utility Methods=== |
<div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | <div style='background-color: #e8e8f; margin: 0.5em 0em 1em 0em; border: solid 1px #cce; padding: 0em 1em 0em 1em; font-size: 80%; '> | ||
<span style='display:none'>User Comments</span> | <span style='display:none'>User Comments</span> | ||
Latest revision as of 17:29, 10 January 2022
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
Contents
NAME
EPrints::DataObj::SavedSearch - Single saved search.
DESCRIPTION
A saved search is a sub class of EPrints::DataObj::SubObject.
Each one belongs to one and only one user, although one user may own multiple saved searches.
CORE METADATA FIELDS
id (counter)
The ID of the saved search,
name (text)
A name assigned to the saved search.
spec (search)
A serialization of the search specification.
frequency (set)
How often to send saves search email updates.
mailempty (boolean)
Whether to send saved search email updates if there are no results.
additional_recipients (text)
Additional email addresses to send updates about saved search results.
public (boolean)
If the saved search results should be publicly accessible.
REFERENCES AND RELATED OBJECTS
userid (itemref)
The ID of the user to whom created this saved search.
INSTANCE VARIABLES
Also see [[API:<EPrints/DataObj#INSTANCE_VARIABLES|EPrints::DataObj]].
$self->{user}
The user who owns this saved search.
METHODS
Constructor Methods
create
$saved_search = EPrints::DataObj::SavedSearch->create( $session, $userid )
Creates a new saved search, belonging to user with ID $userid.
Class Methods
get_system_field_info
$field_config = EPrints::DataObj::SavedSearch->get_system_field_info
Returns an array describing the system metadata of the saved search dataset.
get_dataset_id
$dataset = EPrints::DataObj::SavedSearch->get_dataset_id
Returns the ID of the EPrints::DataSet object to which this record belongs.
Object Methods
get_dataset
$dataset = $saved_search->get_dataset
Get the dataset that this saved search covers.
commit
$success = $saved_search->commit( [ $force ] )
Writes this object to the database.
If $force is not true then it only actually modifies the database if one or more fields have been changed.
Returns true if commit was successfully. Otherwise, returns false.
get_user
$user = $saved_search->get_user
Returns the EPrints::DataObj::User which owns this saved search.
make_searchexp
$searchexp = $saved_search->make_searchexp
Returns an EPrints::Search describing how to find the data objects which are in the scope of this saved search.
send_out_alert
$saved_search->send_out_alert
Sends out an email for this subscription. If there are no matching new data objects then an email is only sent if the saved search has mailempty set to true.
has_owner
$boolean = $saved_search->has_owner( $possible_owner )
Returns true if $possible_owner is the same as the owner of this saved search. Otherwise, returns false.
parent
$parent = $saved_search->parent
Returns the parent data object for this saved search. I.e. the user who owns this saved search. This is similar to get_user but is not as fault tolerant and does set instance variable:
$self->{user}
get_url
$url = $saved_search->get_url( [ $staff ] )
Gets the URL for this saved search. Currently $staff will not effect the URL but in future this may return a specialised URL for staff only.
Utility Methods
process_set
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.
get_last_timestamp
$timestamp = EPrints::DataObj::SavedSearch::get_last_timestamp( $session, $frequency );
Static method.
Return sthe timestamp of the last time this $frequency of alert was sent.
SEE ALSO
EPrints::DataObj::SubObject, EPrints::DataObj and EPrints::DataSet.
COPYRIGHT
© Copyright 2000-2024 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
http://www.eprints.org/eprints-3.4/
LICENSE
This file is part of EPrints 3.4 http://www.eprints.org/.
EPrints 3.4 and this file are released under the terms of the GNU Lesser General Public License version 3 as published by the Free Software Foundation unless otherwise stated.
EPrints 3.4 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with EPrints 3.4. If not, see http://www.gnu.org/licenses/.
