Package org.dspace.harvest

Class HarvestedCollection

java.lang.Object

org.dspace.harvest.HarvestedCollection

All Implemented Interfaces:

ReloadableEntity<Integer>

@Entity
public class HarvestedCollection
extends Object
implements ReloadableEntity<Integer>

Author:

Alexey Maslov

Field Summary

Fields

Modifier and Type	Field	Description
static final int	STATUS_BUSY
static final int	STATUS_OAI_ERROR
static final int	STATUS_QUEUED
static final int	STATUS_READY
static final int	STATUS_UNKNOWN_ERROR
static final int	TYPE_DMD
static final int	TYPE_DMDREF
static final int	TYPE_FULL
static final int	TYPE_NONE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	HarvestedCollection()	Protected constructor, create object using: HarvestedCollectionService.create(Context, Collection)

Method Summary

Modifier and Type	Method	Description
Collection	getCollection()
Instant	getHarvestDate()
String	getHarvestMessage()
String	getHarvestMetadataConfig()
Instant	getHarvestStartTime()
int	getHarvestStatus()
int	getHarvestType()
Integer	getID()	The unique identifier of this entity instance.
String	getOaiSetId()
String	getOaiSource()
void	setHarvestMessage(String message)
void	setHarvestMetadataConfig(String mdConfigId)
void	setHarvestParams(int type, String oaiSource, String oaiSetId, String mdConfigId)	A function to set all harvesting-related parameters at once
void	setHarvestStartTime(Instant date)
void	setHarvestStatus(int status)	Sets the current status of the collection.
void	setHarvestType(int type)
void	setLastHarvested(Instant lastHarvested)
void	setOaiSetId(String oaiSetId)	Sets the OAI set to harvest.
void	setOaiSource(String oaiSource)	Sets the base URL of the OAI-PMH server.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

TYPE_NONE

public static final int TYPE_NONE

See Also:

• Constant Field Values

TYPE_DMD

public static final int TYPE_DMD

See Also:

• Constant Field Values

TYPE_DMDREF

public static final int TYPE_DMDREF

See Also:

• Constant Field Values

TYPE_FULL

public static final int TYPE_FULL

See Also:

• Constant Field Values

STATUS_READY

public static final int STATUS_READY

See Also:

• Constant Field Values

STATUS_BUSY

public static final int STATUS_BUSY

See Also:

• Constant Field Values

STATUS_QUEUED

public static final int STATUS_QUEUED

See Also:

• Constant Field Values

STATUS_OAI_ERROR

public static final int STATUS_OAI_ERROR

See Also:

• Constant Field Values

STATUS_UNKNOWN_ERROR

public static final int STATUS_UNKNOWN_ERROR

See Also:

• Constant Field Values

Constructor Details

HarvestedCollection

protected HarvestedCollection()

Protected constructor, create object using: HarvestedCollectionService.create(Context, Collection)

Method Details

getID

public Integer getID()

Description copied from interface: ReloadableEntity

The unique identifier of this entity instance.

Specified by:

getID in interface ReloadableEntity<Integer>

Returns:

the value of the primary key for this instance.

setHarvestParams

public void setHarvestParams(int type,
 String oaiSource,
 String oaiSetId,
 String mdConfigId)

A function to set all harvesting-related parameters at once

Parameters:

type - harvest type (TYPE_NONE, TYPE_DMD, TYPE_DMDREF, TYPE_FULL)

oaiSource - base URL of the OAI-PMH server

oaiSetId - OAI set identifier

mdConfigId - harvest metadata config ID

setHarvestType

public void setHarvestType(int type)

setHarvestStatus

public void setHarvestStatus(int status)

Sets the current status of the collection.

Parameters:

status - a HarvestInstance.STATUS_... constant (STATUS_READY, STATUS_BUSY, STATUS_QUEUED, STATUS_OAI_ERROR, STATUS_UNKNOWN_ERROR)

setOaiSource

public void setOaiSource(String oaiSource)

Sets the base URL of the OAI-PMH server.

Parameters:

oaiSource - base URL of the OAI-PMH server

setOaiSetId

public void setOaiSetId(String oaiSetId)

Sets the OAI set to harvest.

Parameters:

oaiSetId - OAI set to harvest

setHarvestMetadataConfig

public void setHarvestMetadataConfig(String mdConfigId)

setLastHarvested

public void setLastHarvested(Instant lastHarvested)

setHarvestMessage

public void setHarvestMessage(String message)

setHarvestStartTime

public void setHarvestStartTime(Instant date)

getCollection

public Collection getCollection()

getHarvestType

public int getHarvestType()

getHarvestStatus

public int getHarvestStatus()

getOaiSource

public String getOaiSource()

getOaiSetId

public String getOaiSetId()

getHarvestMetadataConfig

public String getHarvestMetadataConfig()

getHarvestMessage

public String getHarvestMessage()

getHarvestDate

public Instant getHarvestDate()

getHarvestStartTime

public Instant getHarvestStartTime()