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 Details

  • Constructor Details

    • Process

      protected Process()

  • Method Details

    • 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 Instant 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(Instant startTime)

    • getFinishedTime

      public Instant getFinishedTime()
      This method returns the time that Process was finished
      Returns:
      The finished time for the Process

    • setFinishedTime

      public void setFinishedTime(Instant 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(Instant creationTime)

    • getCreationTime

      public Instant 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

    • getGroups

      public List<Group> getGroups()
      This method will return the special groups associated with the Process.

    • setGroups

      public void setGroups(List<Group> groups)
      This method sets the special groups associated with the Process.
      Parameters:
      groups - The special groups of this 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