Difference between revisions of "API:EPrints/DataObj/RichDataObj"
(Created page with "<!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints 3.4 source. Any wiki changes made between the 'Pod2Wiki=*' and 'Edit below this comment'...") |
|||
| Line 32: | Line 32: | ||
<!-- Pod2Wiki=head_core_metadata_fields --> | <!-- Pod2Wiki=head_core_metadata_fields --> | ||
==CORE METADATA FIELDS== | ==CORE METADATA FIELDS== | ||
| − | + | None. | |
| + | |||
| + | <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_references_and_related_objects --> | ||
| + | ==REFERENCES AND RELATED OBJECTS== | ||
| + | None. | ||
| + | |||
| + | <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_instance_variables --> | ||
| + | ==INSTANCE 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%; '> | ||
| Line 192: | Line 214: | ||
EPrints::DataObj::RichDataObj::history_update_trigger( $session, $obj ) | EPrints::DataObj::RichDataObj::history_update_trigger( $session, $obj ) | ||
Utility method for updating the revision history on the rich data object. | Utility method for updating the revision history on the rich data object. | ||
| + | |||
| + | <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_see_also --> | ||
| + | ==SEE ALSO== | ||
| + | [[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]]. | ||
<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 10:58, 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::RichDataObj - A richer version of a data object
DESCRIPTION
UNDER DEVELOPMENT
Designed to extend EPrints::DataObj in a number of generically useful ways, (e.g. add revision history). Not currently used by any data object classes.
Not designed to be instantiated directly.
CORE METADATA FIELDS
None.
REFERENCES AND RELATED OBJECTS
None.
INSTANCE VARIABLES
See EPrints::DataObj.
METHODS
Class Methods
get_dataset_id
$dataset = EPrints::DataObj::RichDataObj->get_dataset_id
Returns the ID of the EPrints::DataSet object to which this record belongs.
indexable
$indexable = EPrints::DataObj::RichDataObj->indexable
Always returns true, as a rich data objects.
get_system_field_info
$indexable = EPrints::DataObj::RichDataObj->get_system_field_info
Returns an array describing the system metadata of the rich data object dataset.
In fact, there are no fields for the rich data object dataset, as it is an abstract dataset.
create_obj
$richdataobj = EPrints::DataObj::RichDataObj->create_obj( $session, $data )
Creates and returns rich data object based on data $data.
delete_obj
EPrints::DataObj::RichDataObj->delete_obj( $session )
Deletes rich data object.
Object Methods
local_path
$path = $richdataobj->local_path
Returns local path for rich data object.
Needed as well as l<EPrints::DataObj#local_path>.
commit
$richdataobj->commit( [ $force ] )
Commit handler to maintain the rev_number.
Set $force to true toforce commit, even if there is no changes.
get_control_url
$richdataobj->get_control_url
Returns the control URL for this rich data object.
Utility Methods
history_update_trigger
EPrints::DataObj::RichDataObj::history_update_trigger( $session, $obj )
Utility method for updating the revision history on the rich data object.
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/.
