Editing API:EPrints/DataSet (section)

==METHODS==
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_class_methods -->
===Class Methods===
<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_object_methods -->
===Object Methods===
 $id = $ds-&gt;base_id
<pre>  $ds = $repo-&gt;dataset( "inbox" );
  $id = $ds-&gt;base_id; # returns "eprint"</pre>

Returns the identifier of the base dataset for this dataset (same as [[API:EPrints/DataSet#id|id]] unless this dataset is virtual).

 $metafield = $ds-&gt;field( $fieldname )
Returns the [[API:EPrints/MetaField|EPrints::MetaField]] from this dataset with the given name, or undef.

 $id = $ds-&gt;id
Return the id of this dataset.

 $n = $ds-&gt;count( $session )
Return the number of records in this dataset.

 @fields = $ds-&gt;fields
Returns a list of the [[API:EPrints/MetaField|EPrints::MetaField]]s belonging to this dataset.

 $field = $ds-&gt;key_field
Return the [[API:EPrints/MetaField|EPrints::MetaField]] representing the primary key field.

Always the first field.

 $dataobj = $ds-&gt;make_dataobj( $epdata )
Return an object of the class associated with this dataset, always a subclass of [[API:EPrints/DataObj|EPrints::DataObj]].

$epdata is a hash of values for fields in this dataset.

Returns $epdata if no class is associated with this dataset.

 $obj = $ds-&gt;create_dataobj( $data )
Returns a new object in this dataset based on $data or undef on failure.

If $data describes sub-objects then those will also be created.

 $dataobj = $ds-&gt;dataobj( $id )
Returns the object from this dataset with the given id, or undefined.

 $repository = $ds-&gt;repository
Returns the [[API:EPrints/Repository|EPrints::Repository]] to which this dataset belongs.

 $searchexp = $ds-&gt;prepare_search( %options )
Returns a [[API:EPrints/Search|EPrints::Search]] for this dataset with %options.

 $list = $ds-&gt;search( %options )
Short-cut to [[API:EPrints/DataSet#prepare_search|prepare_search]]( %options )-&gt;execute.

* satisfy_all
<pre>   satisfy_all"=&gt;1</pre>

: Satify all conditions specified. 0 means satisfy any of the conditions specified. Default is 1

* staff
<pre>  "staff"=&gt;1</pre>

: Do search as an adminstrator means you get everything back

* custom_order
<pre>  "custom_order" =&gt; "field1/-field2/field3"</pre>

: Order the search results by field order. prefixing the field name with a "-" results in reverse ordering

* filters
<pre>  "filters" =&gt; \@(
                         { meta_fields=&gt;[ "field1", "field2" "document.field3" ],
                           merge=&gt;"ANY", match=&gt;"EX",
                           value=&gt;"bees"
                         },
                         { meta_fields=&gt;[ "field4" ],
                           value=&gt; qw( honey ),
                           match=&gt;"IN"
                         }
                       );</pre>

: This searchs for 'bees' in <code>field1</code> or <code>field2</code> or <code>document.field3</code>, and 'honey' in <code>field4</code>

: For details on the <code>merge</code> and <code>match</code> parameters, refer to [[API:EPrints/Search/Field|EPrints::Search::Field]]

<pre>  "limit" =&gt; 10</pre>

Only return 10 results

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_list -->
===list===

<source lang="perl">$list = $ds->list( $ids )

</source>
Returns a [[API:EPrints/List|EPrints::List]] for this dataset for the given $ids list.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_search_config -->
===search_config===

<source lang="perl">$sconf = $dataset->search_config( $searchid )

</source>
Retrieve the search configuration $searchid for this dataset. This typically contains a set of fields to search over, order values and rendering parameters.

<!-- Edit below this comment -->


<!-- Pod2Wiki= -->
<!-- Pod2Wiki=head_copyright -->