Difference between revisions of "API:EPrints/DataObj/Request"
Latest revision as of 11:07, 10 January 2022
- 1 NAME
- 2 DESCRIPTION
- 3 CORE METADATA FIELDS
- 4 REFERENCES AND RELATED OBJECTS
- 5 INSTANCES VARIABLES
- 6 METHODS
- 7 SEE ALSO
- 8 COPYRIGHT
EPrints::DataObj::Request - User requests.
This class stores user requests and their responses for requesting a copy of a document.
CORE METADATA FIELDS
The unique identifier for this request
The ID for any document this request may relate.
The datestamp this request was created.
The email address to which this request is sent.
The email address of the requester.
The reason the request was made.
The time at which this request will expires.
The code for this request, which can be used to created private URLS.
The ReCAPTCHA field for the form for this request.
REFERENCES AND RELATED OBJECTS
The ID of the eprint data object associated with this request.
The ID of the user to whom this request is assigned.
$fields = EPrints::DataObj::Request->get_system_field_info
Returns an array describing the system metadata of the request dataset.
$dataset = EPrints::DataObj::Request->get_dataset_id
Returns the ID of the EPrints::DataSet object to which this record belongs.
$request = EPrints::DataObj::Request->new_from_code( $session, $code )
Returns request that matches provided $code.
$boolean = $request->has_expired
Returns a boolean depending on whether this request has expired.
© Copyright 2022 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
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/.