Package org.dspace.scripts

Class Process

java.lang.Object

org.dspace.scripts.Process

All Implemented Interfaces:

ReloadableEntity<Integer>

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

This class is the DB Entity representation of the Process object to be stored in the Database

Field Summary

Fields

Modifier and Type	Field	Description
static String	BITSTREAM_TYPE_METADATAFIELD
static String	OUTPUT_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Process()

Method Summary

Modifier and Type	Method	Description
void	addBitstream(Bitstream bitstream)
boolean	equals(Object other)	Return true if other is the same Process as this object, false otherwise
List<Bitstream>	getBitstreams()	This method returns a list of Bitstreams that will be used or created by the Process.
Date	getCreationTime()	This method will return the time when the Process was created.
EPerson	getEPerson()	This method returns an EPerson object.
Date	getFinishedTime()	This method returns the time that Process was finished
Integer	getID()	This method returns the ID that the Process holds within the Database
String	getName()	This method returns the name of the Process.
protected String	getParameters()	To get the parameters, use ProcessService.getParameters() to get a parsed list of DSpaceCommandLineParameters This String representation is the parameter in an unparsed fashion.For example "-c test"
ProcessStatus	getProcessStatus()	This method returns a ProcessStatus value that represents the current state of the Process.
Date	getStartTime()	This method returns the Start time for the Process.
int	hashCode()
void	removeBitstream(Bitstream bitstream)
void	setBitstreams(List<Bitstream> bitstreams)
void	setCreationTime(Date creationTime)
void	setEPerson(EPerson ePerson)
void	setFinishedTime(Date finishedTime)
void	setName(String name)
void	setParameters(String parameters)
void	setProcessId(Integer processId)
void	setProcessStatus(ProcessStatus processStatus)
void	setStartTime(Date startTime)

Methods inherited from class java.lang.Object

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

Field Detail

BITSTREAM_TYPE_METADATAFIELD

public static final String BITSTREAM_TYPE_METADATAFIELD

See Also:

Constant Field Values

OUTPUT_TYPE

public static final String OUTPUT_TYPE

See Also:

Constant Field Values

Constructor Detail

Process

protected Process()

Method Detail

getID

public Integer getID()

This method returns the ID that the Process holds within the Database

Specified by:

getID in interface ReloadableEntity<Integer>

Returns:

The ID that the process holds within the database

setProcessId

public void setProcessId(Integer processId)

getEPerson

public EPerson getEPerson()

This method returns an EPerson object. This EPerson object is the EPerson that initially created the process

Returns:

The EPerson that created the process

setEPerson

public void setEPerson(EPerson ePerson)

getStartTime

public Date getStartTime()

This method returns the Start time for the Process. This reflects the time when the Process was actually started

Returns:

The start time for the Process

setStartTime

public void setStartTime(Date startTime)

getFinishedTime

public Date getFinishedTime()

This method returns the time that Process was finished

Returns:

The finished time for the Process

setFinishedTime

public void setFinishedTime(Date finishedTime)

getName

public String getName()

This method returns the name of the Process. For example filter-media

Returns:

The name of the Process

setName

public void setName(String name)

getProcessStatus

public ProcessStatus getProcessStatus()

This method returns a ProcessStatus value that represents the current state of the Process. These values can be found within the ProcessStatus enum

Returns:

The status of the Process

setProcessStatus

public void setProcessStatus(ProcessStatus processStatus)

getParameters

protected String getParameters()

To get the parameters, use ProcessService.getParameters() to get a parsed list of DSpaceCommandLineParameters This String representation is the parameter in an unparsed fashion.For example "-c test"

Returns:

the raw parameter string.

setParameters

public void setParameters(String parameters)

getBitstreams

public List<Bitstream> getBitstreams()

This method returns a list of Bitstreams that will be used or created by the Process. This list contains both input and output bitstreams.

Returns:

The Bitstreams that are used or created by the process

setBitstreams

public void setBitstreams(List<Bitstream> bitstreams)

removeBitstream

public void removeBitstream(Bitstream bitstream)

addBitstream

public void addBitstream(Bitstream bitstream)

setCreationTime

public void setCreationTime(Date creationTime)

getCreationTime

public Date getCreationTime()

This method will return the time when the Process was created. Note that this is potentially different from the StartTime (for example if the Process was queued)

Returns:

The creation time of the Process

equals

public boolean equals(Object other)

Return true if other is the same Process as this object, false otherwise

Overrides:

equals in class Object

Parameters:

other - object to compare to

Returns:

true if object passed in represents the same collection as this object

hashCode

public int hashCode()

Overrides:

hashCode in class Object