API:EPrints/DataObj/Import

From EPrints Documentation
Revision as of 18:28, 11 August 2009 by Tdb01r (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

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

NAME

EPrints::DataObj::Import - bulk imports logging

DESCRIPTION

Inherits from EPrints::DataObj.

INSTANCE VARIABLES

$obj->{

 $obj->{ "data" }

$obj->{

 $obj->{ "dataset" }

$obj->{

 $obj->{ "session" }

CORE FIELDS

importid

Unique id for the import.

datestamp

Time of import.

userid

Id of the user responsible for causing the import.

source_repository

Source entity from which this import came.

url

Location of the imported content (e.g. the file name).

description

Human-readable description of the import.

METHODS

get_system_field_info

 $thing = EPrints::DataObj::Import->get_system_field_info

Core fields contained in a Web import.

Constructor Methods

new

 $thing = EPrints::DataObj::Import->new( $session, $importid )

The data object identified by $importid.

new_from_data

 $thing = EPrints::DataObj::Import->new_from_data( $session, $known )

A new EPrints::DataObj::Import object containing data $known (a hash reference).

Class Methods

remove_all

 EPrints::DataObj::Import::remove_all( $session )

Remove all records from the license dataset.

get_defaults

 $defaults = EPrints::DataObj::Import->get_defaults( $session, $data )

Return default values for this object based on the starting data.

Object Methods

remove

 $foo = $thing->remove()

Remove this record from the data set (see EPrints::Database).

run

 $list = $import->run( $processor )

Run this bulk import. Returns a list of EPrints created. $processor is used for reporting errors.

clear

 $import->clear()

Clear the contents of this bulk import.

get_from_source

 $eprint = $import->get_from_source( $sourceid )

Get the $eprint that is from this import set and identified by $sourceid.

SEE ALSO

EPrints::DataObj and EPrints::DataSet.