Package org.dspace.app.rest.model

Class SearchConfigurationRest

java.lang.Object

org.dspace.app.rest.model.RestAddressableModel

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

org.dspace.app.rest.model.SearchConfigurationRest

All Implemented Interfaces:

Serializable, RestModel

public class SearchConfigurationRest
extends BaseObjectRest<String>

This class' purpose is to store the information that'll be shown on the /search endpoint.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SearchConfigurationRest.Filter
static class	SearchConfigurationRest.SortOption

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CATEGORY
static final String	NAME
static final String	PLURAL_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, CONTENT_REPORT, CORE, DISCOVER, DUPLICATES, EPERSON, INTEGRATION, LDN, PID, ROOT, STATISTICS, SUBMISSION, SYSTEM, TOOLS, VERSIONING, WORKFLOW

Constructor Summary

Constructors

Constructor	Description
SearchConfigurationRest()

Method Summary

Modifier and Type	Method	Description
void	addFilter(SearchConfigurationRest.Filter filter)
void	addSortOption(SearchConfigurationRest.SortOption sortOption)
boolean	equals(Object object)
String	getCategory()
String	getConfiguration()
Class	getController()
SearchConfigurationRest.SortOption	getDefaultSortOption()
List<SearchConfigurationRest.Filter>	getFilters()
String	getScope()
List<SearchConfigurationRest.SortOption>	getSortOptions()
String	getType()
String	getTypePlural()	The plural name is the same as the singular name
int	hashCode()
void	setConfiguration(String configurationName)
void	setDefaultSortOption(SearchConfigurationRest.SortOption defaultSortOption)
void	setScope(String scope)

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, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

PLURAL_NAME

public static final String PLURAL_NAME

See Also:

• Constant Field Values

CATEGORY

public static final String CATEGORY

See Also:

• Constant Field Values

Constructor Details

SearchConfigurationRest

public SearchConfigurationRest()

Method Details

getCategory

public String getCategory()

Specified by:

getCategory in class RestAddressableModel

getType

public String getType()

getTypePlural

public String getTypePlural()

The plural name is the same as the singular name

getController

public Class getController()

Specified by:

getController in class RestAddressableModel

getScope

public String getScope()

setScope

public void setScope(String scope)

getConfiguration

public String getConfiguration()

setConfiguration

public void setConfiguration(String configurationName)

addFilter

public void addFilter(SearchConfigurationRest.Filter filter)

getFilters

public List<SearchConfigurationRest.Filter> getFilters()

addSortOption

public void addSortOption(SearchConfigurationRest.SortOption sortOption)

getSortOptions

public List<SearchConfigurationRest.SortOption> getSortOptions()

getDefaultSortOption

public SearchConfigurationRest.SortOption getDefaultSortOption()

setDefaultSortOption

public void setDefaultSortOption(SearchConfigurationRest.SortOption defaultSortOption)

equals

public boolean equals(Object object)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object