Difference between revisions of "API:EPrints/DataObj/Request"

From EPrints Documentation
Jump to: navigation, search
 
(One intermediate revision by the same user not shown)
Line 6: Line 6:
 
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
 
==NAME==
 
==NAME==
'''EPrints::DataObj::Request''' - Log document requests and responses  (for request document button).
+
'''EPrints::DataObj::Request''' - User requests.
 +
 
 +
<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>
 +
<!-- Edit below this comment -->
 +
 
 +
 
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_description -->
 +
==DESCRIPTION==
 +
This class stores user requests and their responses for requesting a copy of a document.
  
 
<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%; '>
Line 157: Line 168:
  
 
The ID of the user to whom this request is assigned.
 
The ID of the user to whom this request is assigned.
 +
 +
<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>
 +
<!-- Edit below this comment -->
 +
 +
 +
<!-- Pod2Wiki= -->
 +
</div>
 +
<!-- Pod2Wiki=head_instances_variables -->
 +
==INSTANCES VARIABLES==
 +
See [[API:EPrints/DataObj#INSTANCE_VARIABLES|EPrints::DataObj]].
  
 
<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%; '>

Latest revision as of 11:07, 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


API: Core API

Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki


NAME

EPrints::DataObj::Request - User requests.

User Comments


DESCRIPTION

This class stores user requests and their responses for requesting a copy of a document.

User Comments


CORE METADATA FIELDS

User Comments


requestid (counter)

The unique identifier for this request

User Comments


docid (text)

The ID for any document this request may relate.

User Comments


datestamp (timestamp)

The datestamp this request was created.

User Comments


email (email)

The email address to which this request is sent.

User Comments


requester_email (email)

The email address of the requester.

User Comments


reason (longtext)

The reason the request was made.

User Comments


expiry_date (time)

The time at which this request will expires.

User Comments


code (text)

The code for this request, which can be used to created private URLS.

User Comments


captcha (recaptcha)

The ReCAPTCHA field for the form for this request.

User Comments


REFERENCES AND RELATED OBJECTS

User Comments


eprintid (itemref)

The ID of the eprint data object associated with this request.

User Comments


userid (itemref)

The ID of the user to whom this request is assigned.

User Comments


INSTANCES VARIABLES

See EPrints::DataObj.

User Comments


METHODS

User Comments


Class Methods

User Comments


get_system_field_info

$fields = EPrints::DataObj::Request->get_system_field_info

Returns an array describing the system metadata of the request dataset.

User Comments


get_dataset_id

$dataset = EPrints::DataObj::Request->get_dataset_id

Returns the ID of the EPrints::DataSet object to which this record belongs.

User Comments


new_from_code

$request = EPrints::DataObj::Request->new_from_code( $session, $code )

Returns request that matches provided $code.

User Comments


Object Methods

User Comments


has_expired

$boolean = $request->has_expired

Returns a boolean depending on whether this request has expired.

User Comments


SEE ALSO

EPrints::DataObj and EPrints::DataSet.

User Comments


COPYRIGHT

© Copyright 2022 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/.

User Comments