Editing API:EPrints/DataObj

<!-- 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' comments will be lost.
 -->{{API}}{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj.pm|package_name=EPrints::DataObj}}[[Category:API|DATAOBJ]][[Category:API:EPrints/DataObj|DATAOBJ]]<div><!-- Edit below this comment -->


<!-- Pod2Wiki=_private_ --><!-- Pod2Wiki=head_name -->
==NAME==
'''EPrints::DataObj''' - Base class for records in EPrints.

<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 is a base class that is inherited by [[API:EPrints/DataObj/EPrint|EPrints::DataObj::EPrint]], [[API:EPrints/DataObj/User|EPrints::DataObj::User]], [[API:EPrints/DataObj/Subject|EPrints::DataObj::Subject]] and [[API:EPrints/DataObj/Document|EPrints::DataObj::Document]] and various other classes representing data objects.

This class is abstract and its methods should not be called directly.

<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_synopsis -->
===Synopsis===
 $dataobj = $dataset-&gt;dataobj( $id );
 $dataobj-&gt;delete;
 $dataobj-&gt;commit( $force );
 $dataset = $dataobj-&gt;dataset;
 $repo = $dataobj-&gt;repository;
 $id = $dataobj-&gt;id;
 $dataobj-&gt;set_value( $fieldname, $value );
 $value = $dataobj-&gt;value( $fieldname );
 \@value = $dataobj-&gt;value( $fieldname ); # multiple
 $boolean = $dataobj-&gt;is_set( $fieldname );
 $xhtml = $dataobj-&gt;render_value( $fieldname );
 $xhtml = $dataobj-&gt;render_citation( $style, %opts );
 $uri = $dataobj-&gt;uri;
 $string = $dataobj-&gt;export( $plugin_id, %opts );
 $dataobj = $dataobj-&gt;create_subobject( $fieldname, $epdata );
  
<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_core_metadata_fields -->
==CORE METADATA FIELDS==
None. This is an abstract class from which real data objects  inherit and then add their metadata fields.

<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. This is an abstract class from which real data objects inherit and then add their references and related objects.

<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==
<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=item_$self->{changed} -->
===$self-&gt;{changed}===

A reference to a hash containing the old values of metadata that has changed since his the data object was last committed.

<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=item_$self->{data} -->
===$self-&gt;{data}===

A reference to a hash containing the metadata of this record.

<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=item_$self->{dataset} -->
===$self-&gt;{dataset}===

The [[API:EPrints/DataSet|EPrints::DataSet]] to which this record belongs.

<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=item_$self->{non_volatile_change} -->
===$self-&gt;{non_volatile_change}===

A boolean signifying whether the current changes include at least one change to a non-volatile field.

<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=item_$self->{session} -->
===$self-&gt;{session}===

The current [[API:EPrints/Repository|EPrints::Repository]]. This use to be [[API:EPrints/Session|EPrints::Session]] but was replaced in later versions. See [[API:EPrints/BackCompatibility|EPrints::BackCompatibility]].

<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=item_$self->{under_construction} -->
===$self-&gt;{under_construction}===

A boolean signifying if the data object is currently under construction and therefore know house-keeping should be carried out on the data object whilst set.

<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_methods -->
==METHODS==
<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_constructor_methods -->
===Constructor Methods===
<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=item_new -->
====new====

 $dataobj = EPrints::DataObj-&gt;new( $session, $id, [ $dataset ] )
Return new data object, created by loading it from the database.

If <tt>$dataset</tt> is not defined uses the default dataset for this 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=item_new_from_data -->
====new_from_data====

 $dataobj = EPrints::DataObj-&gt;new_from_data( $session, $data, [ $dataset ] )
Construct and and returns a new data object based on the <tt>$data</tt> hash reference of metadata.

This is usually called by [[API:EPrints/DataObj#create_from_data|create_from_data]] to ensure default values are set for those field values not initially included in <tt>$data</tt> before this method constructs the data object.

<tt>$dataset</tt> is determined from the class if not provided.

<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=item_create -->
====create====

 $dataobj = EPrints::DataObj::create( $session, @default_data )
ABSTRACT

Create a new object of this type in the database.

The syntax for <tt>@default_data</tt> depends on the type of 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=item_create_from_data -->
====create_from_data====

 $dataobj = EPrints::DataObj-&gt;create_from_data( $session, $data, [ $dataset ] )
Creates and returns a new data object of this type in the database.

<tt>$data</tt> is a structured hash reference with multiple dimensions to encompass compound, multiple and sub-object field values.

<tt>$dataset</tt> is the dataset to which the new data object will belong. If this is not defined, it is determined from the class.

This will pull in defaults for unset field values in <tt>$data</tt> before calling [[API:EPrints/DataObj#new_from_data|new_from_data]]. It will also create any sub-objects as well as the main object.

Call this via:

 $dataset-&gt;create_object( $session, $data )
  
<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_class_methods -->
===Class Methods===
<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=item_get_system_field_info -->
====get_system_field_info====

 $sys_fields = EPrints::DataObj-&gt;get_system_field_info
Return an array describing the system metadata of the this  dataset.

<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=item_get_defaults -->
====get_defaults====

 $defaults = EPrints::DataObj-&gt;get_defaults( $session, $data, [ $dataset ] )
Return default values for this object based on the starting <tt>$data</tt>. Uses the data object class to determine dataset if <tt>$dataset</tt> not set.

Should be subclassed.

<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=item_get_dataset_id -->
====get_dataset_id====

 $dataset = EPrints::DataObj-&gt;get_dataset_id
Returns the ID of the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.

<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=item_xml_to_epdata -->
====xml_to_epdata====

 $epdata = EPrints::DataObj-&gt;xml_to_epdata( $session, $xml, %opts )
Populates <tt>$epdata</tt> based on <tt>$xml</tt> using options in <tt>%opts</tt>. This is the inverse of [[API:EPrints/DataObj#to_xml|to_xml]] but doesn't create a new 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=item_export_fieldlist -->
====export_fieldlist====

 EPrints::DataObj-&gt;export_fieldlist
Returns fields to be exported by plugins that do not have pre-defined fields to export, (e.g. {{API:PodLink|file=Export/XML|package_name=Export::XML|section=|text=Export::XML}}).

<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=item_in_export_fieldlist -->
====in_export_fieldlist====

 EPrints::DataObj-&gt;in_export_fieldlist
Returns whether a field is in the export fieldlist for a particular data object.  Returns <tt>true</tt> if there is no fieldlist restriction.

<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=item_start_element -->
====start_element====

 EPrints::DataObj-&gt;start_element( $data, $epdata, $state )
Consumes a SAX event.

<tt>$data</tt> is the SAX node data.

<tt>$epdata</tt> is an EPrints data structure to write values to.

<tt>$state</tt> maintains state between SAX calls but must contain at least:

    dataset - the dataset the class belongs to
  
<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=item_end_element -->
====end_element====

 EPrints::DataObj-&gt;end_element( $data, $epdata, $state )
Ends element from [[API:EPrints/DataObj#start_element|start_element]].

<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=item_characters -->
====characters====

 EPrints::DataObj-&gt;characters( $data, $epdata, $state )
Consumes characters within [[API:EPrints/DataObj#start_element|start_element]].

<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_object_methods -->
===Object Methods===
<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=item_clone -->
====clone====

 $clone = $dataobj-&gt;clone
Clone the current data object, by creating a new data object of the same type and metadata but a new ID.

<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=item_create_subdataobj -->
====create_subdataobj====

 $subdataobj = $dataobj-&gt;create_subdataobj( $fieldname, $epdata )
Creates and returns a new data object that is a sub-object of this  object in field <tt>$fieldname</tt> with initial data <tt>$epdata</tt>.

Clears the sub-object cache for this <tt>$fieldname</tt> which is equivalent  to:

 $dataobj-&gt;set_value( $fieldname, undef );
  
<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=item_local_path -->
====local_path====

 $local_path = $dataobj-&gt;local_path
Return local_path string for the history of the data object.

Should be subclassed.

<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=item_update_triggers -->
====update_triggers====

 $dataobj-&gt;update_triggers
Update all the stuff that needs to be updated before the data object  is written to the database.

<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=item_delete -->
====delete====

 $success = $dataobj-&gt;delete
Delete this data object from the database and any sub-objects or  related files. 

Alias for:
 
 $dataobj-&gt;remove
  
Return <tt>true</tt> if successful.

<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=item_empty -->
====empty====

 $dataobj-&gt;empty
Remove all of this object's values that may be imported.

<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=item_update -->
====update====

 $dataobj-&gt;update( $epdata [, %opts ] )
Update this object's values from $epdata. Ignores any values that do not exist in the dataset or do not have the 'import' property set.

  include_subdataobjs - replace sub-dataobjs if given
  
  # replaces all documents in $dataobj
  $dataobj-&gt;update( {
    title =&gt; "Wombats on Fire",
    documents =&gt; [{
      main =&gt; "wombat.pdf",
      ...
    }],
  }, include_subdataobjs =&gt; 1 );
  
<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=item_set_under_construction -->
====set_under_construction====

 $dataobj-&gt;set_under_construction( $boolean )
Set a flag to indicate this object is being constructed and any house  keeping will be handled by the method constructing it so don't do it  elsewhere.

<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=item_under_construction -->
====under_construction====

 $boolean = $dataobj-&gt;under_construction 
Returns c&lt;true&gt; if this object is part way through being constructed.

<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=item_clear_changed -->
====clear_changed====

 $dataobj-&gt;clear_changed
Clear any changed fields, which will result in them not being  committed unless force is used.

This method is used by the [[API:EPrints/Database|EPrints::Database]] to avoid unnecessary  commits.

<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=item_clear_citationcaches -->
====clear_citationcaches====

 $dataobj-&gt;clear_citationcaches
Clear any [[API:EPrints/DataObj/CitationCache|EPrints::DataObj::CitationCache]] objects associated with  the 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=item_commit -->
====commit====

 $success = $dataobj-&gt;commit( [ $force ] )
Write this object to the database and reset the changed fields.

If <tt>$force</tt> isn't true then it only actually modifies the database if  one or more fields have been changed.

Commit may also queue indexer jobs or log changes, depending on the  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=item_value -->
====value====

 $value = $dataobj-&gt;value( $fieldname )
Get a the value of a metadata field with <tt>$fieldname</tt>. If the field  is not set then it returns undef unless the field has the property  multiple set, in which case it returns [] (a reference to an empty a rray).

Alias for:

 $dataobj-&gt;get_value( $fieldname )
  
<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=item_set_value -->
====set_value====

 $dataobj-&gt;set_value( $fieldname, $value )
Set the <tt>$value</tt> of the named metadata field <tt>$fieldname</tt> for this 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=item_set_value_raw -->
====set_value_raw====

 $dataobj-&gt;set_value_raw( $fieldname, $value )
Set the <tt>$value</tt> of the named metadata field <tt>$fieldname</tt> for this data object by directly modifying its <tt>data</tt> hash reference. Use  with care!

<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=item_get_values -->
====get_values====

 @values = $dataobj-&gt;get_values( $fieldnames )
Returns a list of all the values in this record of all the $fields  specified by <tt>$fieldnames</tt>. These should be in the format used by  browse views, using <tt>/</tt> to seperate individual field names with an  optional <tt>.id</tt> suffix to indicate the ID part rather than the main  part. 

E.g. <tt>author.id/editor.id</tt> would return a list of all author and  editor IDs from this record.

<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=item_repository -->
====repository====

 $session = $dataobj-&gt;repository
Returns the [[API:EPrints/Repository|EPrints::Repository]] object to which this record  belongs.

Alias for:

 $dataobj-&gt;get_session
  
<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=item_get_data -->
====get_data====

 $data = $dataobj-&gt;get_data
Returns a reference to the hash of all the metadata for this record  keyed by fieldname.

<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=item_get_dataset -->
====get_dataset====

 $dataset = $dataobj-&gt;get_dataset
Returns the [[API:EPrints/DataSet|EPrints::DataSet]] object to which this record belongs.

<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=item_is_set -->
====is_set====

 $boolean = $dataobj-&gt;is_set( $fieldname )
Returns <tt>true</tt> if the field with <tt>$fieldname</tt> is set in this record,  otherwise <tt>false</tt>.

Warns if the field with <tt>$fieldname</tt> does not exist.

<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=item_exists_and_set -->
====exists_and_set====

 $boolean = $dataobj-&gt;exists_and_set( $fieldname )
Returns <tt>true</tt> if the field with <tt>$fieldname</tt> is set in this record,  otherwise <tt>false</tt>.

If the field does not exist, just return <tt>false</tt>.

This method is useful for plugins which may operate on multiple  repositories, when field not existing is not an issue for a particular repository.

<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=item_id -->
====id====

 $id = $dataobj-&gt;id
Returns the value of the primary key of this record.

Alias for:

 $dataobj-&gt;get_id
  
<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=item_get_gid -->
====get_gid====

 $gid = $dataobj-&gt;get_gid
DEPRECATED (see [[API:EPrints/DataObj#uri|uri]])

Returns the globally referential fully-qualified identifier for this  data object or <tt>undef</tt> if this object can not be externally  referenced.

<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=item_get_datestamp -->
====get_datestamp====

 $datestamp = $dataobj-&gt;get_datestamp
Returns the datestamp of this object in "YYYY-MM-DD hh:mm:ss" format.

<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=item_render_value -->
====render_value====

 $xhtml = $dataobj-&gt;render_value( $fieldname, [ $showall ] )
Returns the rendered version of the value of the given <tt>$fieldname</tt>  as appropriate for the current session. If <tt>$showall</tt> is <tt>true</tt> then  all values are rendered - this is usually used for staff viewing data.

<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=item_render_citation -->
====render_citation====

 $xhtml = $dataobj-&gt;render_citation( [ $style, %params ] )
Renders the record as a citation. If $style is set then it uses that  citation style from the citations config file. Otherwise <tt>$style</tt> defaults to the type of this record. If <tt>$params{url}</tt> is set then  the citation will link to the specified URL.

If <tt>$style</tt> is unset then use <tt>default</tt>.

<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=item_render_citation_link -->
====render_citation_link====

 $xhtml = $dataobj-&gt;render_citation_link( [ $style, %params ] )
Renders a citation as like [[API:EPrints/DataObj#render_citation|render_citation]] but as a link to the  URL for this item. E.g. the abstract page of an eprint. 

<tt>$params{url}</tt> is set to data object's URL if not set.

<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=item_render_citation_link -->
====render_citation_link====

 $xhtml = $dataobj-&gt;render_citation_link( [ $style, %params ] )
Renders a citation as like [[API:EPrints/DataObj#render_citation|render_citation]] but as a link to the control URL for this item. E.g. for items that are not yet in the live archive.

<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=item_render_description -->
====render_description====

 $xhtml = $dataobj-&gt;render_description
Returns a short description of this object using the <tt>brief</tt> citation  style for this dataset or the <tt>default</tt> citation style of the former does not exist.

<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=item_render -->
====render====

 ( $xhtml, $title ) = $dataobj-&gt;render
Return a chunk of XHTML DOM describing this object in the normal way. This is the public view of the record, not the staff view.

<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=item_render_full -->
====render_full====

 $xhtml = $dataobj-&gt;render_full
Return an XHTML table in DOM describing this record. All values of all fields are listed. This is the staff view.

<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=item_render_export_links -->
====render_export_links====

 $xhtml_ul_list = $dataobj-&gt;render_export_links( [ $staff ] )
Return a <tt>&lt;ul&gt;</tt> list containing links to all the formats this  eprint is available in. 

If <tt>$staff</tt> is <tt>true</tt> then show all formats available to staff and  link to the staff export URL.

<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=item_render_export_bar -->
====render_export_bar====

 $xhtml = $dataobj-&gt;render_export_bar( [ $staff ] )
Returns a rendered drop-down list of exports.  

If <tt>$staff</tt> is <tt>true</tt> then include both public and staff visible  export options.

<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=item_uri -->
====uri====

 $url = $dataobj-&gt;uri
Returns a unique URI for this object. Not certain to resolve as a  URL.

If <tt>$c-</tt>{dataobj_uri}-&gt;{eprint}&gt; is a function, call that to work  it out.

<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=item_internal_uri -->
====internal_uri====

 $uri = $dataobj-&gt;internal_uri
Return an internal URI for this object (independent of repository hostname).

To retrieve an object by internal URI use  [[API:EPrints/DataSet|EPrints::DataSet]]::get_object_from_uri().

<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=item_path -->
====path====

 $path = $dataobj-&gt;path
Returns the relative path to this object from the repository's base  URL, if the object has a URL.

Does not include any leading slash.

<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=item_url -->
====url====

 $url = $dataobj-&gt;url
Returns the URL for this record, e.g.the URL of the abstract page of  an eprint.

Alias for:

 $dataobj-&gt;get_url
  
<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=item_get_control_url -->
====get_control_url====

 $url = $dataobj-&gt;get_control_url
Returns the URL for the control page for this 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=item_get_type -->
====get_type====

 $type = $dataobj-&gt;get_type
ABSTRACT.

Returns the type of this data object. This not the dataset it belongs to but the specific type within the dataset (e.g. c&lt;user&gt; could be <tt>editor</tt>, <tt>admin</tt>, etc.).

<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=item_to_xml -->
====to_xml====

 $xmlfragment = $dataobj-&gt;to_xml( %opts )
Convert this object into an XML fragment using options <tt>%opts</tt>.

Options:

 no_xmlns - Do not include a xmlns attribute in the outer element. 
 (This assumes this chunk appears in a larger tree where the xmlns is 
 already set correctly.
 showempty - Fields with no value are shown.
 embed - Include the data of a file, not just it's URL.
  
<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=item_to_sax -->
====to_sax====

 $dataobj-&gt;to_sax( %opts )
Stream this object to a SAX handler using the options in <tt>$opts</tt>.

Options:
 Handler - the SAX handler to build the output.
 revision_generation - Generate XML for revision files rather than 
 export.

This does not output any document-level events.

<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=item_export -->
====export====

 $plugin_output = $dataobj-&gt;export( $plugin_id, %params )
Apply an export plugin with <tt>$plugin_id</tt> to this data object, using  the parameters provided by <tt>%params</tt> and supplying them to the <tt>output_dataobj</tt> method of the [[API:EPrints/Plugin:Export|EPrints::Plugin:Export]] plugin.

Return the output of the export plugin.

<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=item_queue_changes -->
====queue_changes====

 $dataobj-&gt;queue_changes
Add all the changed fields into the indexers todo queue.

<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=item_queue_all -->
====queue_all====

 $dataobj-&gt;queue_all
Add all the fields into the indexers todo queue.

<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=item_queue_fulltext -->
====queue_fulltext====

 $dataobj-&gt;queue_fulltext
Add a fulltext index into the indexers todo queue.

<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=item_queue_removed -->
====queue_removed====

 $dataobj-&gt;queue_removed
Add an index removed event to the indexer's queue.

<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=item_has_owner -->
====has_owner====

 $boolean = $dataobj-&gt;has_owner( $user )
Return <tt>true</tt> if <tt>$user</tt> owns this record. Normally this means they  created it, but a group of users could count as owners of the same record if you wanted.

It's <tt>false</tt> on most data objects, except those which override this  method.

<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=item_permit -->
====permit====

 $rc = $dataobj-&gt;permit( $priv, [ $user ] )
  # current user can edit via editorial role
  if( $dataobj-&gt;permit( "xxx/edit", $user ) &amp; 8 )
  {
    ...
  }
  # anyone can view this object
  if( $dataobj-&gt;permit( "xxx/view" ) )
  {
  }
  
Returns <tt>true</tt> if the specified <tt>$user</tt> (or 'anybody') can perform  this action.

Returns a bit mask where:

  0 - not permitted
  1 - anybody
  2 - logged in user
  4 - user as owner
  8 - user as editor
  
See also [[API:EPrints/Repository#allow_anybody|EPrints::Repository/allow_anybody]] and  [[API:EPrints/DataObj/User#allow|EPrints::DataObj::User/allow]].

<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=item_in_editorial_scope_of -->
====in_editorial_scope_of====

 $boolean = $dataobj-&gt;in_editorial_scope_of( $user )
As for [[API:EPrints/DataObj#has_owner|has_owner]], but if the <tt>$user</tt> is identified as someone  with an editorial scope which includes this record.

Defaults to <tt>true</tt>. Which doesn't mean that they have the right to  edit it, just that their scope matches. You also need editor rights to use this. It's currently used just to filter eprint editors so that only ones with appropriate scope and privilege can edit.

<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=item_validate -->
====validate====

 $problems = $dataobj-&gt;validate( $for_archive )
Validate this data object. Not used on all sub-classed. <tt>$for_archive</tt>  being <tt>true</tt> indicates that the item is beting validated to go live.

Returns a reference to an array of XHTML DOM objects describing validation problems with the entire data object for the supplied  <tt>$for_archive</tt> archive ID.

A reference to an empty array indicates no problems.

<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=item_get_warnings -->
====get_warnings====

 $warnings = $dataobj-&gt;get_warnings
Returns a reference to an array of XHTML DOM objects describing problems with the entire data object.

A reference to an empty array indicates no problems.

<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=item_validate_field -->
====validate_field====

 @problems = $dataobj-&gt;validate_field( $fieldname )
Check if a field named <tt>$fieldname</tt> is valid. 

Returns a reference to an array of XHTML problems.  

A reference to an empty array indicates no problems.

<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=item_tidy -->
====tidy====

 $dataobj-&gt;tidy
Cleans up any multiple fields with gaps.

<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=item_add_stored_file -->
====add_stored_file====

 $file = $dataobj-&gt;add_stored_file( $filename, $filehandle, $filesize )
Convenience method to add (or replace) the file record for  <tt>$filename</tt> to this object. Reads <tt>$filesize</tt> bytes from  <tt>$filehandle</tt>.

Returns the file object or <tt>undef</tt> if the storage failed.

<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=item_stored_file -->
====stored_file====

 $file = $dataobj-&gt;stored_file( $filename )
Get the file object for <tt>$filename</tt>.

Returns the file object or <tt>undef</tt> if the file doesn't exist.

Has alias:

 $dataobj-&gt;get_stored_file( $filename )
  
<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=item_add_dataobj_relations -->
====add_dataobj_relations====

 $dataobj-&gt;add_dataobj_relations( $target, %relations )
Add a relation from this data object to the <tt>$target</tt> data object  using predicates defined in the keys of the <tt>%relations</tt> hash. If  values are defined in the hash reciprocal relationships from the  <tt>$target</tt> data object to this data object are also.

You must commit <tt>$target</tt> data object after calling this method.

Has alias:

 $dataobj-&gt;add_object_relations( $target, %relations )
  
<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=item_has_dataobj_relations -->
====has_dataobj_relations====

 $boolean = $dataobj-&gt;has_dataobj_relations( $target, @required )
Returns <tt>true</tt> if this object is related to <tt>$target</tt> by all  <tt>@required</tt>.

If <tt>@required</tt> is empty will return <tt>true</tt> if any relationships  exist.

Has alias:

 $dataobj-&gt;has_object_relations( $target, @required )
  
<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=item_has_related_dataobjs -->
====has_related_dataobjs====

 $boolean = $dataobj-&gt;has_related_dataobjs( @required )
Returns <tt>true</tt> if [[API:EPrints/DataObj#related_dataobjs|related_dataobjs]] would return some objects but  without actually retrieving the related objects from the database.

Has alias:

 $dataobj-&gt;has_related_objects( @required )
  
<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=item_related_dataobjs -->
====related_dataobjs====

 @dataobjs = $dataobj-&gt;related_dataobjs( @required )
Returns a list of objects related to this data object by a relation in <tt>@required</tt>.

Has alias:

 $dataobj-&gt;get_related_objects( @required )
  
<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=item_remove_dataobj_relations -->
====remove_dataobj_relations====

 $dataobj-&gt;remove_dataobj_relations( $target, %relations )
Remove relations between this data object and the <tt>$target</tt> data  object. If <tt>%relations</tt> is not empty only remove those relationships which are keys in this hash.

You must [[API:EPrints/DataObj#commit|commit]] this object and <tt>$target</tt> to write the changes.

Has alias:
 $dataobj-&gt;remove_object_relations( $target, %relations )

<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/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%; '>
<span style='display:none'>User Comments</span>
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
</div>
<!-- Pod2Wiki=head_copyright -->
==COPYRIGHT==
{{API:Copyright}}
<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=_postamble_ --><!-- Edit below this comment -->