Difference between revisions of "API:EPrints/DataObj/Message"

From EPrints Documentation
Jump to: navigation, search
(New page: <!-- Pod2Wiki=_preamble_ This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost. -...)
 
m (adding Category:Rubbish, page was emptied 9 years ago and has been untouched since)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
<!-- Pod2Wiki=_preamble_
+
[[Category: Rubbish]]
This page has been automatically generated from the EPrints source. Any wiki changes made between the 'Pod2Wiki=*' and 'End of Pod2Wiki' comments will be lost.
+
-->{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/Message.pm|package_name=EPrints::DataObj::Message}}[[Category:API|Message]]<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=head_name -->=NAME=
+
'''EPrints::DataObj::Message''' - user system message
+
 
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=head_description -->=DESCRIPTION=
+
This is an internal class that shouldn't be used outside [[API:EPrints/Database|EPrints::Database]].
+
 
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=head_methods -->=METHODS=
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=item_get_system_field_info -->==get_system_field_info==
+
 
+
  $thing = EPrints::DataObj::Access-&gt;get_system_field_info
+
 
+
Core fields.
+
 
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=head_constructor_methods -->==Constructor Methods==
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=item_new -->===new===
+
 
+
  $thing = EPrints::DataObj::Message-&gt;new( $session, $id )
+
 
+
The data object identified by $id.
+
 
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=item_new_from_data -->===new_from_data===
+
 
+
  $thing = EPrints::DataObj::Message-&gt;new_from_data( $session, $known )
+
 
+
A new <tt>EPrints::DataObj::Message</tt> object containing data $known (a hash reference).
+
 
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=head_class_methods -->==Class Methods==
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=item_remove_all -->===remove_all===
+
 
+
  EPrints::DataObj::Message::remove_all( $session )
+
 
+
Remove all records from the message dataset.
+
 
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=item_get_defaults -->===get_defaults===
+
 
+
  $defaults = EPrints::DataObj::Message-&gt;get_defaults( $session, $data )
+
 
+
Return default values for this object based on the starting data.
+
 
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=head_object_methods -->==Object Methods==
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=item_remove -->===remove===
+
 
+
  $foo = $thing-&gt;remove()
+
 
+
Remove this record from the data set (see [[API:EPrints/Database|EPrints::Database]]).
+
 
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=head_see_also -->=SEE ALSO=
+
[[API:EPrints/DataObj|EPrints::DataObj]] and [[API:EPrints/DataSet|EPrints::DataSet]].
+
 
+
<!-- End of Pod2Wiki -->
+
<!-- Pod2Wiki=_postamble_ --><!-- End of Pod2Wiki -->
+

Latest revision as of 00:26, 3 October 2018