Package org.dspace.app.rest.model

Class UsageReportRest

java.lang.Object

org.dspace.app.rest.model.RestAddressableModel

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

org.dspace.app.rest.model.UsageReportRest

All Implemented Interfaces:

Serializable, RestModel

public class UsageReportRest
extends BaseObjectRest<String>

This class serves as a REST representation of a Usage Report from the DSpace statistics

Author:

Maria Verdonck (Atmire) on 08/06/2020

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	CATEGORY
static String	NAME

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

id

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

AUTHENTICATION, AUTHORIZATION, CONFIGURATION, CORE, DISCOVER, EPERSON, INTEGRATION, ROOT, STATISTICS, SUBMISSION, SYSTEM, VERSIONING, WORKFLOW

Constructor Summary

Constructors

Constructor	Description
UsageReportRest()

Method Summary

Modifier and Type	Method	Description
void	addPoint(UsageReportPointRest point)	Adds a UsageReportPointRest object to this UsageReportRest object
String	getCategory()	Returns the category of this Rest object, CATEGORY
Class	getController()	Return controller class responsible for this Rest object
List<UsageReportPointRest>	getPoints()	Returns the list of UsageReportPointRest objects attached to this UsageReportRest object, or empty list if none
String	getReportType()	Returns the report type of this UsageReport, options listed in UsageReportUtils, e.g.
String	getType()	Returns the type of this UsageReportRest object
void	setPoints(List<UsageReportPointRest> points)	Set all UsageReportPointRest objects on this UsageReportRest object
void	setReportType(String reportType)	Sets the report type of this UsageReport, options listed in UsageReportUtils, e.g.

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

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

getTypePlural

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

CATEGORY

public static final String CATEGORY

See Also:

Constant Field Values

Constructor Detail

UsageReportRest

public UsageReportRest()

Method Detail

getCategory

public String getCategory()

Returns the category of this Rest object, CATEGORY

Specified by:

getCategory in class RestAddressableModel

Returns:

The category of this Rest object, CATEGORY

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

Returns the type of this UsageReportRest object

Returns:

Type of this UsageReportRest object

getReportType

public String getReportType()

Returns the report type of this UsageReport, options listed in UsageReportUtils, e.g. UsageReportUtils.TOTAL_VISITS_REPORT_ID

Returns:

The report type of this UsageReport, options listed in UsageReportUtils, e.g. UsageReportUtils.TOTAL_VISITS_REPORT_ID

setReportType

public void setReportType(String reportType)

Sets the report type of this UsageReport, options listed in UsageReportUtils, e.g. UsageReportUtils.TOTAL_VISITS_REPORT_ID

Parameters:

reportType - The report type of this UsageReport, options listed in UsageReportUtils, e.g. UsageReportUtils.TOTAL_VISITS_REPORT_ID

getPoints

public List<UsageReportPointRest> getPoints()

Returns the list of UsageReportPointRest objects attached to this UsageReportRest object, or empty list if none

Returns:

The list of UsageReportPointRest objects attached to this UsageReportRest object, or empty list if none

addPoint

public void addPoint(UsageReportPointRest point)

Adds a UsageReportPointRest object to this UsageReportRest object

Parameters:

point - UsageReportPointRest to add to this UsageReportRest object

setPoints

public void setPoints(List<UsageReportPointRest> points)

Set all UsageReportPointRest objects on this UsageReportRest object

Parameters:

points - All UsageReportPointRest objects on this UsageReportRest object