|
|
| Line 1: |
Line 1: |
| <!-- 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.
| |
| -->{{Pod2Wiki}}{{API:Source|file=EPrints/DataObj/Access.pm|package_name=EPrints::DataObj::Access}}[[Category:API|Access]]<!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_name -->=NAME=
| |
| '''EPrints::DataObj::Access''' - Accesses to the Web server
| |
|
| |
|
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_description -->=DESCRIPTION=
| |
| Inherits from [[API:EPrints/DataObj|EPrints::DataObj]].
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_instance_variables -->=INSTANCE VARIABLES=
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_$obj->{ -->==$obj->{==
| |
|
| |
| $obj->{ "data" }
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_$obj->{ -->==$obj->{==
| |
|
| |
| $obj->{ "dataset" }
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_$obj->{ -->==$obj->{==
| |
|
| |
| $obj->{ "session" }
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_core_fields -->=CORE FIELDS=
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_accessid -->==accessid==
| |
|
| |
| Unique id for the access.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_datestamp -->==datestamp==
| |
|
| |
| Time of access.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_requester_id -->==requester_id==
| |
|
| |
| Id of the requesting user-agent (typically IP address).
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_requester_user_agent -->==requester_user_agent==
| |
|
| |
| The HTTP user agent string (useful for robots spotting).
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_requester_country -->==requester_country==
| |
|
| |
| Country the request originated from.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_requester_institution -->==requester_institution==
| |
|
| |
| Institution the request originated from.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_referring_entity_id -->==referring_entity_id==
| |
|
| |
| Id of the object from which the user agent came from (i.e. HTTP referrer).
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_service_type_id -->==service_type_id==
| |
|
| |
| Id of the type of service requested.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_referent_id -->==referent_id==
| |
|
| |
| Id of the object requested.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_referent_docid -->==referent_docid==
| |
|
| |
| Id of the document requested (if relevent).
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_methods -->=METHODS=
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_system_field_info -->==get_system_field_info==
| |
|
| |
| $thing = EPrints::DataObj::Access->get_system_field_info
| |
|
| |
| Core fields contained in a Web access.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=head_constructor_methods -->==Constructor Methods==
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_new -->===new===
| |
|
| |
| $thing = EPrints::DataObj::Access->new( $session, $accessid )
| |
|
| |
| The data object identified by $accessid.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_new_from_data -->===new_from_data===
| |
|
| |
| $thing = EPrints::DataObj::Access->new_from_data( $session, $known )
| |
|
| |
| A new <tt>EPrints::DataObj::Access</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::Access::remove_all( $session )
| |
|
| |
| Remove all records from the license dataset.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_gid -->===get_gid===
| |
|
| |
| $dataset = $eprint->get_gid
| |
|
| |
| Returns the OAI identifier for this access.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_defaults -->===get_defaults===
| |
|
| |
| $defaults = EPrints::DataObj::Access->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->remove()
| |
|
| |
| Remove this record from the data set (see [[API:EPrints/Database|EPrints::Database]]).
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_referent_id -->===get_referent_id===
| |
|
| |
| $dataobj->get_referent_id()
| |
|
| |
| Return the fully qualified referent id.
| |
|
| |
| <!-- End of Pod2Wiki -->
| |
| <!-- Pod2Wiki=item_get_requester_id -->===get_requester_id===
| |
|
| |
| $dataobj->get_requester_id()
| |
|
| |
| Return the fully qualified requester id.
| |
|
| |
| <!-- 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 -->
| |