API:EPrints/DataObj/MetaField
Latest Source Code (3.4, 3.3) | Revision Log | Before editing this page please read Pod2Wiki
Contents
- 1 NAME
- 2 DESCRIPTION
- 3 METHODS
- 4 SEE ALSO
- 5 UNDOCUMENTED METHODS
- 5.1 add_to_phrases
- 5.2 add_to_workflow
- 5.3 commit
- 5.4 destroy_field
- 5.5 get_config_file
- 5.6 get_config_path
- 5.7 get_field
- 5.8 get_perl_file_config
- 5.9 get_valid_datasets
- 5.10 get_warnings
- 5.11 get_xml_file_config
- 5.12 load_all
- 5.13 move_to_archive
- 5.14 move_to_deletion
- 5.15 move_to_inbox
- 5.16 save_all
- 5.17 validate
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
 |
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. |
