API:EPrints/DataObj/MetaField

From EPrints Documentation
Revision as of 18:29, 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::MetaField - metadata fields

DESCRIPTION

This is an internal class that shouldn't be used outside EPrints::Database.

METHODS

get_system_field_info

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

Core fields.

Constructor Methods

new

 $thing = EPrints::DataObj::MetaField->new( $session, $metafieldid )

The data object identified by $metafieldid.

new_from_data

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

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

get_perl_struct

 $data = EPrints::DataObj::MetaField->get_perl_struct

Returns the Perl data structure representation of this field, as you would find defined in the configuration or DataObj classes.

Class Methods

remove_all

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

Remove all records from the metafield dataset.

get_defaults

 $defaults = EPrints::DataObj::MetaField->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).

remove_from_workflow

 $ok = $mf->remove_from_workflow()

Remove all occurrences of this field from the workflow. Will remove the "local" stage if it is empty.

SEE ALSO

EPrints::DataObj and EPrints::DataSet.

UNDOCUMENTED METHODS

Warning These methods were found in the source code but didn't have any POD associated with them. This may be because we haven't got around to documenting them yet or it could be because they are internal to the API and not intended for use by other parts of EPrints.

add_to_phrases

add_to_workflow

commit

destroy_field

get_config_file

get_config_path

get_field

get_perl_file_config

get_valid_datasets

get_warnings

get_xml_file_config

load_all

move_to_archive

move_to_deletion

move_to_inbox

save_all

validate