API:EPrints/DataObj/RichDataObj
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
NAME[edit]
EPrints::DataObj::RichDataObj - A richer version of a data object
DESCRIPTION[edit]
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[edit]
None.
REFERENCES AND RELATED OBJECTS[edit]
None.
INSTANCE VARIABLES[edit]
See EPrints::DataObj.
METHODS[edit]
Class Methods[edit]
get_dataset_id[edit]
$dataset = EPrints::DataObj::RichDataObj->get_dataset_id
Returns the ID of the EPrints::DataSet object to which this record belongs.
indexable[edit]
$indexable = EPrints::DataObj::RichDataObj->indexable
Always returns true, as a rich data objects.
get_system_field_info[edit]
$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[edit]
$richdataobj = EPrints::DataObj::RichDataObj->create_obj( $session, $data )
Creates and returns rich data object based on data $data.
delete_obj[edit]
EPrints::DataObj::RichDataObj->delete_obj( $session )
Deletes rich data object.
Object Methods[edit]
local_path[edit]
$path = $richdataobj->local_path
Returns local path for rich data object.
Needed as well as l<EPrints::DataObj#local_path>.
commit[edit]
$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[edit]
$richdataobj->get_control_url
Returns the control URL for this rich data object.
Utility Methods[edit]
history_update_trigger[edit]
EPrints::DataObj::RichDataObj::history_update_trigger( $session, $obj )
Utility method for updating the revision history on the rich data object.
SEE ALSO[edit]
EPrints::DataObj and EPrints::DataSet.
COPYRIGHT[edit]
© Copyright 2000-2024 University of Southampton.
EPrints 3.4 is supplied by EPrints Services.
http://www.eprints.org/eprints-3.4/
LICENSE[edit]
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/.