Package org.dspace.app.rest.model

Class FilteredItemsRest

java.lang.Object

org.dspace.app.rest.model.RestAddressableModel

org.dspace.app.rest.model.BaseObjectRest<String>

org.dspace.app.rest.model.FilteredItemsRest

All Implemented Interfaces:

Serializable, RestModel

public class FilteredItemsRest
extends BaseObjectRest<String>

This class serves as a REST representation of a Filtered Items Report. The name must match that of the associated resource class (FilteredItemsResource) except for the suffix. This is why it is not named something like FilteredItemsReportRest.

Author:

Jean-François Morin (Université Laval)

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CATEGORY	Category of instances of this class, used by the DSpace REST infrastructure
static final String	NAME	Type of instances of this class, used by the DSpace REST infrastructure

Fields inherited from class org.dspace.app.rest.model.BaseObjectRest

id

Fields inherited from interface org.dspace.app.rest.model.RestModel

AUTHENTICATION, AUTHORIZATION, CONFIGURATION, CONTENT_REPORT, CORE, DISCOVER, DUPLICATES, EPERSON, INTEGRATION, LDN, PID, ROOT, STATISTICS, SUBMISSION, SYSTEM, TOOLS, VERSIONING, WORKFLOW

Constructor Summary

Constructors

Constructor	Description
FilteredItemsRest()

Method Summary

Modifier and Type	Method	Description
String	getCategory()
Class<?>	getController()	Return controller class responsible for this Rest object
long	getItemCount()
List<FilteredItemRest>	getItems()	Returns a defensive copy of the items included in this report.
String	getType()
String	getTypePlural()
static FilteredItemsRest	of(List<FilteredItemRest> items, long itemCount)	Builds a FilteredItemsRest instance from a list of items and an total item count.

Methods inherited from class org.dspace.app.rest.model.BaseObjectRest

getErrors, getId, setErrors, setId

Methods inherited from class org.dspace.app.rest.model.RestAddressableModel

getEmbedLevel, getProjection, getUniqueType, setEmbedLevel, setProjection

Methods inherited from class java.lang.Object

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

Field Details

NAME

public static final String NAME

Type of instances of this class, used by the DSpace REST infrastructure

See Also:

• Constant Field Values

CATEGORY

public static final String CATEGORY

Category of instances of this class, used by the DSpace REST infrastructure

See Also:

• Constant Field Values

Constructor Details

FilteredItemsRest

public FilteredItemsRest()

Method Details

of

public static FilteredItemsRest of(List<FilteredItemRest> items,
 long itemCount)

Builds a FilteredItemsRest instance from a list of items and an total item count. To avoid adding a dependency to any Spring-managed service here, the items provided here are already converted to FilteredItemRest instances.

Parameters:

items - the items to add to the FilteredItemsRest instance to be created

itemCount - total number of items found regardless of any pagination constraint

Returns:

a FilteredItemsRest instance built from the provided data

getCategory

public String getCategory()

Specified by:

getCategory in class RestAddressableModel

getController

public Class<?> getController()

Return controller class responsible for this Rest object

Specified by:

getController in class RestAddressableModel

Returns:

Controller class responsible for this Rest object

getType

public String getType()

getTypePlural

public String getTypePlural()

getItems

public List<FilteredItemRest> getItems()

Returns a defensive copy of the items included in this report.

Returns:

the items included in this report

getItemCount

public long getItemCount()