Package org.dspace.usage

Class UsageSearchEvent

java.lang.Object

org.dspace.services.model.Event

org.dspace.usage.UsageEvent

org.dspace.usage.UsageSearchEvent

All Implemented Interfaces:

Serializable

public class UsageSearchEvent
extends UsageEvent

Extends the standard usage event to contain search information search information includes the query/queries used and the scope

Author:

Kevin Van de Velde (kevin at atmire dot com), Ben Bosman (ben at atmire dot com), Mark Diggory (markd at atmire dot com)

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	UsageSearchEvent.AppliedFilter
static class	UsageSearchEvent.Page
static class	UsageSearchEvent.Sort

Nested classes/interfaces inherited from class org.dspace.usage.UsageEvent

UsageEvent.Action

Nested classes/interfaces inherited from class org.dspace.services.model.Event

Event.Scope

Constructor Summary

Constructors

Constructor	Description
UsageSearchEvent(UsageEvent.Action action, jakarta.servlet.http.HttpServletRequest request, Context context, DSpaceObject object)

Method Summary

Modifier and Type	Method	Description
List<UsageSearchEvent.AppliedFilter>	getAppliedFilters()
String	getConfiguration()
String	getDsoType()
UsageSearchEvent.Page	getPage()
String	getQuery()
DSpaceObject	getScope()
UsageSearchEvent.Sort	getSort()
void	setAppliedFilters(List<UsageSearchEvent.AppliedFilter> appliedFilters)
void	setConfiguration(String configuration)
void	setDsoType(String dsoType)
void	setPage(UsageSearchEvent.Page page)
void	setQuery(String query)
void	setScope(DSpaceObject scope)
void	setSort(UsageSearchEvent.Sort sort)

Methods inherited from class org.dspace.usage.UsageEvent

getAction, getContext, getIp, getObject, getReferrer, getRequest, getUserAgent, getXforwardedfor, setContext, setIp, setObject, setReferrer, setRequest, setUserAgent, setXforwardedfor

Methods inherited from class org.dspace.services.model.Event

getId, getName, getProperties, getResourceReference, getScopes, getUserId, isModify, setId, setModify, setName, setProperties, setResourceReference, setScopes, setUserId, toString

Methods inherited from class java.lang.Object

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

Constructor Details

UsageSearchEvent

public UsageSearchEvent(UsageEvent.Action action,
 jakarta.servlet.http.HttpServletRequest request,
 Context context,
 DSpaceObject object)

Method Details

setDsoType

public void setDsoType(String dsoType)

getDsoType

public String getDsoType()

setScope

public void setScope(DSpaceObject scope)

getScope

public DSpaceObject getScope()

setConfiguration

public void setConfiguration(String configuration)

getConfiguration

public String getConfiguration()

getAppliedFilters

public List<UsageSearchEvent.AppliedFilter> getAppliedFilters()

setAppliedFilters

public void setAppliedFilters(List<UsageSearchEvent.AppliedFilter> appliedFilters)

getSort

public UsageSearchEvent.Sort getSort()

setSort

public void setSort(UsageSearchEvent.Sort sort)

getPage

public UsageSearchEvent.Page getPage()

setPage

public void setPage(UsageSearchEvent.Page page)

getQuery

public String getQuery()

setQuery

public void setQuery(String query)