Open Journal Systems  3.3.0
DataObjectTombstone Class Reference
Inheritance diagram for DataObjectTombstone:
DataObject

Public Member Functions

 getDataObjectId ()
 
 getDateDeleted ()
 
 getOAIIdentifier ()
 
 getOAISetObjectId ($assocType)
 
 getOAISetObjectsIds ()
 
 getSetName ()
 
 getSetSpec ()
 
 setDataObjectId ($dataObjectId)
 
 setDateDeleted ($dateDeleted)
 
 setOAIIdentifier ($oaiIdentifier)
 
 setOAISetObjectId ($assocType, $assocId)
 
 setOAISetObjectsIds ($OAISetObjectsIds)
 
 setSetName ($setName)
 
 setSetSpec ($setSpec)
 
 stampDateDeleted ()
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Base class for data object tombstones.

Definition at line 16 of file DataObjectTombstone.inc.php.

Member Function Documentation

◆ getDataObjectId()

DataObjectTombstone::getDataObjectId ( )

get data object id

Returns
int

Definition at line 22 of file DataObjectTombstone.inc.php.

References DataObject\getData().

◆ getDateDeleted()

DataObjectTombstone::getDateDeleted ( )

get date deleted

Returns
date

Definition at line 38 of file DataObjectTombstone.inc.php.

References DataObject\getData().

◆ getOAIIdentifier()

DataObjectTombstone::getOAIIdentifier ( )

Get oai identifier.

Returns
string

Definition at line 93 of file DataObjectTombstone.inc.php.

References DataObject\getData().

◆ getOAISetObjectId()

DataObjectTombstone::getOAISetObjectId (   $assocType)

Get an specific object id that is part of the OAI set of this tombstone.

Parameters
$assocTypeint
Returns
int The object id.

Definition at line 111 of file DataObjectTombstone.inc.php.

References getOAISetObjectsIds().

◆ getOAISetObjectsIds()

DataObjectTombstone::getOAISetObjectsIds ( )

Get all objects ids that are part of the OAI set of this tombstone.

Returns
array assocType => assocId

Definition at line 138 of file DataObjectTombstone.inc.php.

References DataObject\getData().

Referenced by getOAISetObjectId(), and setOAISetObjectId().

◆ getSetName()

DataObjectTombstone::getSetName ( )

Get oai setName.

Returns
string

Definition at line 77 of file DataObjectTombstone.inc.php.

References DataObject\getData().

◆ getSetSpec()

DataObjectTombstone::getSetSpec ( )

Get oai setSpec.

Returns
string

Definition at line 61 of file DataObjectTombstone.inc.php.

References DataObject\getData().

◆ setDataObjectId()

DataObjectTombstone::setDataObjectId (   $dataObjectId)

set data object id

Parameters
$dataObjectIdint

Definition at line 30 of file DataObjectTombstone.inc.php.

References DataObject\setData().

◆ setDateDeleted()

DataObjectTombstone::setDateDeleted (   $dateDeleted)

set date deleted

Parameters
$dateDeleteddate

Definition at line 46 of file DataObjectTombstone.inc.php.

References DataObject\setData().

Referenced by stampDateDeleted().

◆ setOAIIdentifier()

DataObjectTombstone::setOAIIdentifier (   $oaiIdentifier)

Set oai identifier.

Parameters
$oaiIdentifierstring

Definition at line 101 of file DataObjectTombstone.inc.php.

References DataObject\setData().

◆ setOAISetObjectId()

DataObjectTombstone::setOAISetObjectId (   $assocType,
  $assocId 
)

Set an specific object id that is part of the OAI set of this tombstone.

Parameters
$assocTypeint
$assocIdint

Definition at line 126 of file DataObjectTombstone.inc.php.

References getOAISetObjectsIds(), and setOAISetObjectsIds().

◆ setOAISetObjectsIds()

DataObjectTombstone::setOAISetObjectsIds (   $OAISetObjectsIds)

Set all objects ids that are part of the OAI set of this tombstone.

Parameters
$OAISetObjectsIdsarray assocType => assocId

Definition at line 147 of file DataObjectTombstone.inc.php.

References DataObject\setData().

Referenced by setOAISetObjectId().

◆ setSetName()

DataObjectTombstone::setSetName (   $setName)

Set oai setName.

Parameters
$setNamestring

Definition at line 85 of file DataObjectTombstone.inc.php.

References DataObject\setData().

◆ setSetSpec()

DataObjectTombstone::setSetSpec (   $setSpec)

Set oai setSpec.

Parameters
$setSpecstring

Definition at line 69 of file DataObjectTombstone.inc.php.

References DataObject\setData().

◆ stampDateDeleted()

DataObjectTombstone::stampDateDeleted ( )

Stamp the date of the deletion to the current time.

Definition at line 53 of file DataObjectTombstone.inc.php.

References Core\getCurrentDate(), and setDateDeleted().


The documentation for this class was generated from the following file: