API:EPrints/DataObj/Request
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::Request - User requests.
DESCRIPTION
This class stores user requests and their responses for requesting a copy of a document.
CORE METADATA FIELDS
requestid (counter)
The unique identifier for this request
docid (text)
The ID for any document this request may relate.
datestamp (timestamp)
The datestamp this request was created.
email (email)
The email address to which this request is sent.
requester_email (email)
The email address of the requester.
reason (longtext)
The reason the request was made.
expiry_date (time)
The time at which this request will expires.
code (text)
The code for this request, which can be used to created private URLS.
captcha (recaptcha)
The ReCAPTCHA field for the form for this request.
REFERENCES AND RELATED OBJECTS
eprintid (itemref)
The ID of the eprint data object associated with this request.
userid (itemref)
The ID of the user to whom this request is assigned.
INSTANCES VARIABLES
See EPrints::DataObj.
METHODS
Class Methods
get_system_field_info
$fields = EPrints::DataObj::Request->get_system_field_info
Returns an array describing the system metadata of the request dataset.
get_dataset_id
$dataset = EPrints::DataObj::Request->get_dataset_id
Returns the ID of the EPrints::DataSet object to which this record belongs.
new_from_code
$request = EPrints::DataObj::Request->new_from_code( $session, $code )
Returns request that matches provided $code.
Object Methods
has_expired
$boolean = $request->has_expired
Returns a boolean depending on whether this request has expired.
SEE ALSO
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/.
