API:EPrints/DataObj/Access

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::Access - Accesses to the Web server

DESCRIPTION

Inherits from EPrints::DataObj.

INSTANCE VARIABLES

$obj->{

 $obj->{ "data" }

$obj->{

 $obj->{ "dataset" }

$obj->{

 $obj->{ "session" }

CORE FIELDS

accessid

Unique id for the access.

datestamp

Time of access.

requester_id

Id of the requesting user-agent (typically IP address).

requester_user_agent

The HTTP user agent string (useful for robots spotting).

requester_country

Country the request originated from.

requester_institution

Institution the request originated from.

referring_entity_id

Id of the object from which the user agent came from (i.e. HTTP referrer).

service_type_id

Id of the type of service requested.

referent_id

Id of the object requested.

referent_docid

Id of the document requested (if relevent).

METHODS

get_system_field_info

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

Core fields contained in a Web access.

Constructor Methods

new

 $thing = EPrints::DataObj::Access->new( $session, $accessid )

The data object identified by $accessid.

new_from_data

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

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

Class Methods

remove_all

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

Remove all records from the license dataset.

get_gid

 $dataset = $eprint->get_gid

Returns the OAI identifier for this access.

get_defaults

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

get_referent_id

 $dataobj->get_referent_id()

Return the fully qualified referent id.

get_requester_id

 $dataobj->get_requester_id()

Return the fully qualified requester id.

SEE ALSO

EPrints::DataObj and EPrints::DataSet.