Package io.goobi.viewer.model.administration.legal

Class DisplayScope

java.lang.Object

io.goobi.viewer.model.administration.legal.DisplayScope

All Implemented Interfaces:

Serializable

public class DisplayScope
extends Object
implements Serializable

Describes the locations in the viewer where a notification should be displayed. This can either be all pages or all record pages which may be further restricted by a SOLR query condition

Author:

Florian Alpers

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	DisplayScope.PageScope	The type of viewer-pages that are in scope.

Constructor Summary

Constructors

Constructor	Description
DisplayScope()	Creates a scope that appplies to all viewer pages.
DisplayScope(DisplayScope.PageScope scope, String filter)	Creates a scope from a given PageScope and filterQuery.
DisplayScope(String jsonString)

Method Summary

Modifier and Type	Method	Description
boolean	appliesToPage(PageType pageType, String pi, SolrSearchIndex searchIndex)
String	getAsJson()
String	getFilterQuery()
DisplayScope.PageScope	getPageScope()
String	getQueryForSearch()	Gets the query to use in a SOLR search to determine whether a record should show the disclaimer.
void	setFilterQuery(String filterQuery)
void	setPageScope(DisplayScope.PageScope pageScope)

Methods inherited from class java.lang.Object

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

Constructor Details

DisplayScope

public DisplayScope()

Creates a scope that appplies to all viewer pages.

DisplayScope

public DisplayScope(DisplayScope.PageScope scope,
 String filter)

Creates a scope from a given PageScope and filterQuery. The filterQuery is only meaningful if the scope is PageScope.RECORD

Parameters:

scope - page scope defining where the display applies

filter - Solr filter query restricting the scope to specific records

DisplayScope

public DisplayScope(String jsonString)
             throws IllegalArgumentException

Throws:

IllegalArgumentException

Method Details

getPageScope

public DisplayScope.PageScope getPageScope()

setPageScope

public void setPageScope(DisplayScope.PageScope pageScope)

getFilterQuery

public String getFilterQuery()

setFilterQuery

public void setFilterQuery(String filterQuery)

appliesToPage

public boolean appliesToPage(PageType pageType,
 String pi,
 SolrSearchIndex searchIndex)
                      throws PresentationException,
IndexUnreachableException

Throws:

PresentationException

IndexUnreachableException

getQueryForSearch

public String getQueryForSearch()

Gets the query to use in a SOLR search to determine whether a record should show the disclaimer.

Returns:

a solr search query for the disclaimer

getAsJson

public String getAsJson()