org.dspace.content

Class WorkspaceItem

java.lang.Object

org.dspace.content.WorkspaceItem

All Implemented Interfaces:

Serializable, InProgressSubmission<Integer>, ReloadableEntity<Integer>, IndexableObject<Integer>

@Entity
public class WorkspaceItem
extends Object
implements InProgressSubmission<Integer>, Serializable, ReloadableEntity<Integer>, IndexableObject<Integer>

Class representing an item in the process of being submitted by a user

Version:

$Revision$

Author:

Robert Tansley

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	WorkspaceItem() Protected constructor, create object using: WorkspaceItemService.create(Context, Collection, boolean) or WorkspaceItemService.create(Context, WorkflowItem)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Decide if this WorkspaceItem is equal to another
Collection	getCollection() Get the collection being submitted to
Integer	getID() Get the internal ID of this workspace item
Item	getItem() Get the incomplete item object
int	getPageReached() Get the value of the page reached column (which represents the page reached within a stage/step)
int	getStageReached() Get the value of the stage reached column
EPerson	getSubmitter() Get the submitter
List<Group>	getSupervisorGroups()
int	getType()
int	hashCode()
boolean	hasMultipleFiles() Find out if the submission has (or is intended to have) more than one associated bitstream.
boolean	hasMultipleTitles() Find out if the submission has (or is intended to have) more than one title.
boolean	isPublishedBefore() Find out if the submission has been published or publicly distributed before
void	setMultipleFiles(boolean b) Indicate whether the submission is intended to have more than one file.
void	setMultipleTitles(boolean b) Indicate whether the submission is intended to have more than one title.
void	setPageReached(int v) Set the value of the page reached column (which represents the page reached within a stage/step)
void	setPublishedBefore(boolean b) Indicate whether the submission has been published or publicly distributed before
void	setStageReached(int v) Set the value of the stage reached column

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dspace.discovery.IndexableObject

getTypeText, getUniqueIndexID

Constructor Detail

WorkspaceItem

protected WorkspaceItem()

Protected constructor, create object using: WorkspaceItemService.create(Context, Collection, boolean) or WorkspaceItemService.create(Context, WorkflowItem)

Method Detail

getID

public Integer getID()

Get the internal ID of this workspace item

Specified by:

getID in interface InProgressSubmission<Integer>

Specified by:

getID in interface ReloadableEntity<Integer>

Returns:

the internal identifier

getStageReached

public int getStageReached()

Get the value of the stage reached column

Returns:

the value of the stage reached column

setStageReached

public void setStageReached(int v)

Set the value of the stage reached column

Parameters:

v - the value of the stage reached column

getPageReached

public int getPageReached()

Get the value of the page reached column (which represents the page reached within a stage/step)

Returns:

the value of the page reached column

setPageReached

public void setPageReached(int v)

Set the value of the page reached column (which represents the page reached within a stage/step)

Parameters:

v - the value of the page reached column

equals

public boolean equals(Object o)

Decide if this WorkspaceItem is equal to another

Overrides:

equals in class Object

Parameters:

o - The other workspace item to compare to

Returns:

If they are equal or not

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getItem

public Item getItem()

Description copied from interface: InProgressSubmission

Get the incomplete item object

Specified by:

getItem in interface InProgressSubmission<Integer>

Returns:

the item

getCollection

public Collection getCollection()

Description copied from interface: InProgressSubmission

Get the collection being submitted to

Specified by:

getCollection in interface InProgressSubmission<Integer>

Returns:

the collection

getSubmitter

public EPerson getSubmitter()
                     throws SQLException

Description copied from interface: InProgressSubmission

Get the submitter

Specified by:

getSubmitter in interface InProgressSubmission<Integer>

Returns:

the submitting e-person

Throws:

SQLException - if database error

hasMultipleFiles

public boolean hasMultipleFiles()

Description copied from interface: InProgressSubmission

Find out if the submission has (or is intended to have) more than one associated bitstream.

Specified by:

hasMultipleFiles in interface InProgressSubmission<Integer>

Returns:

true if there is to be more than one file.

setMultipleFiles

public void setMultipleFiles(boolean b)

Description copied from interface: InProgressSubmission

Indicate whether the submission is intended to have more than one file.

Specified by:

setMultipleFiles in interface InProgressSubmission<Integer>

Parameters:

b - if true, submission may have more than one file.

hasMultipleTitles

public boolean hasMultipleTitles()

Description copied from interface: InProgressSubmission

Find out if the submission has (or is intended to have) more than one title.

Specified by:

hasMultipleTitles in interface InProgressSubmission<Integer>

Returns:

true if there is to be more than one file.

setMultipleTitles

public void setMultipleTitles(boolean b)

Description copied from interface: InProgressSubmission

Indicate whether the submission is intended to have more than one title.

Specified by:

setMultipleTitles in interface InProgressSubmission<Integer>

Parameters:

b - if true, submission may have more than one title.

isPublishedBefore

public boolean isPublishedBefore()

Description copied from interface: InProgressSubmission

Find out if the submission has been published or publicly distributed before

Specified by:

isPublishedBefore in interface InProgressSubmission<Integer>

Returns:

true if it has been published before

setPublishedBefore

public void setPublishedBefore(boolean b)

Description copied from interface: InProgressSubmission

Indicate whether the submission has been published or publicly distributed before

Specified by:

setPublishedBefore in interface InProgressSubmission<Integer>

Parameters:

b - true if it has been published before

getSupervisorGroups

public List<Group> getSupervisorGroups()

getType

public int getType()

Specified by:

getType in interface IndexableObject<Integer>

Returns:

the integer constant representing the Entity Type, @see Constants