Package org.dspace.app.rest.model

Class BrowseIndexRest

java.lang.Object

org.dspace.app.rest.model.RestAddressableModel

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

org.dspace.app.rest.model.BrowseIndexRest

All Implemented Interfaces:

Serializable, RestModel

@LinkRest(name="items",method="listBrowseItems") @LinkRest(name="entries",method="listBrowseEntries")
public class BrowseIndexRest
extends BaseObjectRest<String>

The Browse Index REST Resource

Author:

Andrea Bollini (andrea.bollini at 4science.it)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BrowseIndexRest.SortOption

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BROWSE_TYPE_FLAT
static final String	BROWSE_TYPE_HIERARCHICAL
static final String	BROWSE_TYPE_VALUE_LIST
static final String	CATEGORY
static final String	LINK_ENTRIES
static final String	LINK_ITEMS
static final String	LINK_VOCABULARY
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
BrowseIndexRest()

Method Summary

Modifier and Type	Method	Description
String	getBrowseType()
String	getCategory()
Class	getController()
String	getDataType()
String	getFacetType()
List<String>	getMetadataList()
String	getOrder()
List<BrowseIndexRest.SortOption>	getSortOptions()
String	getType()
String	getTypePlural()
String	getVocabulary()
void	setBrowseType(String browseType)	- valueList => if the browse index has two levels, the 1st level shows the list of entries like author names, subjects, types, etc. the second level is the actual list of items linked to a specific entry - flatBrowse if the browse index has one level: the full list of items - hierarchicalBrowse if the browse index should display the vocabulary tree.
void	setDataType(String dataType)
void	setFacetType(String facetType)
void	setMetadataList(List<String> metadataList)
void	setOrder(String order)
void	setSortOptions(List<BrowseIndexRest.SortOption> sortOptions)
void	setVocabulary(String vocabulary)

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

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

LINK_ITEMS

public static final String LINK_ITEMS

See Also:

• Constant Field Values

LINK_ENTRIES

public static final String LINK_ENTRIES

See Also:

• Constant Field Values

LINK_VOCABULARY

public static final String LINK_VOCABULARY

See Also:

• Constant Field Values

BROWSE_TYPE_VALUE_LIST

public static final String BROWSE_TYPE_VALUE_LIST

See Also:

• Constant Field Values

BROWSE_TYPE_FLAT

public static final String BROWSE_TYPE_FLAT

See Also:

• Constant Field Values

BROWSE_TYPE_HIERARCHICAL

public static final String BROWSE_TYPE_HIERARCHICAL

See Also:

• Constant Field Values

Constructor Details

BrowseIndexRest

public BrowseIndexRest()

Method Details

getCategory

public String getCategory()

Specified by:

getCategory in class RestAddressableModel

getType

public String getType()

getTypePlural

public String getTypePlural()

getMetadataList

public List<String> getMetadataList()

setMetadataList

public void setMetadataList(List<String> metadataList)

getDataType

public String getDataType()

setDataType

public void setDataType(String dataType)

getOrder

public String getOrder()

setOrder

public void setOrder(String order)

getSortOptions

public List<BrowseIndexRest.SortOption> getSortOptions()

setSortOptions

public void setSortOptions(List<BrowseIndexRest.SortOption> sortOptions)

setBrowseType

public void setBrowseType(String browseType)

- valueList => if the browse index has two levels, the 1st level shows the list of entries like author names, subjects, types, etc. the second level is the actual list of items linked to a specific entry - flatBrowse if the browse index has one level: the full list of items - hierarchicalBrowse if the browse index should display the vocabulary tree. The 1st level shows the tree. The second level is the actual list of items linked to a specific entry

getBrowseType

public String getBrowseType()

setFacetType

public void setFacetType(String facetType)

getFacetType

public String getFacetType()

setVocabulary

public void setVocabulary(String vocabulary)

getVocabulary

public String getVocabulary()

getController

public Class getController()

Specified by:

getController in class RestAddressableModel