Package org.dspace.app.rest.model

Class FilteredCollectionsRest

java.lang.Object

org.dspace.app.rest.model.RestAddressableModel

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

org.dspace.app.rest.model.FilteredCollectionsRest

All Implemented Interfaces:

Serializable, RestModel

public class FilteredCollectionsRest
extends BaseObjectRest<String>

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

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
FilteredCollectionsRest()

Method Summary

Modifier and Type	Method	Description
String	getCategory()
List<FilteredCollectionRest>	getCollections()
Class<?>	getController()
FilteredCollectionRest	getSummary()
String	getType()
String	getTypePlural()
static FilteredCollectionsRest	of(FilteredCollections model)	Builds a FilteredCollectionsRest instance from a FilteredCollections instance.

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

FilteredCollectionsRest

public FilteredCollectionsRest()

Method Details

of

public static FilteredCollectionsRest of(FilteredCollections model)

Builds a FilteredCollectionsRest instance from a FilteredCollections instance. Each underlying FilteredCollection is converted to a FilteredCollectionRest instance.

Parameters:

model - the FilteredCollections instance that provides values to the FilteredCollectionsRest instance to be created

Returns:

a FilteredCollectionsRest instance built from the provided model object

getCategory

public String getCategory()

Specified by:

getCategory in class RestAddressableModel

getController

public Class<?> getController()

Specified by:

getController in class RestAddressableModel

getType

public String getType()

getTypePlural

public String getTypePlural()

getCollections

public List<FilteredCollectionRest> getCollections()

getSummary

public FilteredCollectionRest getSummary()