Class ActiveDocumentBean
- java.lang.Object
-
- io.goobi.viewer.managedbeans.ActiveDocumentBean
-
- All Implemented Interfaces:
Serializable
@Named @SessionScoped public class ActiveDocumentBean extends Object implements Serializable
This bean opens the requested record and provides all data relevant to this record.- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description protected long
topDocumentIddoc
-
Constructor Summary
Constructors Constructor Description ActiveDocumentBean()
Empty constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
calculateSidebarToc()
Recalculates the visibility of TOC elements and jumps to the active element after a +/- button has been pressed.String
clearCacheAction()
String
deleteRecordAction(boolean keepTraceDocument)
deleteRecordAction.void
downloadTOCAction()
downloadTOCAction.GeoMap
generateGeoMap(String pi)
String
getAction()
Getter for the fieldaction
.long
getActiveDocumentIddoc()
Getter and Setter **************************************String
getClearCacheMode()
StructElement
getCurrentElement()
getCurrentElement.int
getCurrentThumbnailPage()
getCurrentThumbnailPage.Boolean
getDeleteRecordKeepTrace()
Getter for the fielddeleteRecordKeepTrace
.String
getFirstPageUrl()
getFirstPageUrl.String
getFullscreenImageUrl()
getFullscreenImageUrl.String
getFulltextUrl()
getFulltextUrl.GeoMap
getGeoMap()
Get a CMSSidebarElement with a map containing all GeoMarkers for the current PI.int
getImageContainerWidth()
Getter for the fieldimageContainerWidth
.String
getImageToShow()
Getter for the fieldimageToShow
.String
getImageUrl()
getImageUrl.String
getLabelForJS()
Title bar label value escaped for JavaScript.String
getLastPageUrl()
getLastPageUrl.String
getLogid()
Getter for the fieldlogid
.String
getLogPart()
getLogPart.String
getMetadataUrl()
getMetadataUrl.String
getNextDocstructUrl()
BrowseElement
getNextHit()
Getter for the fieldnextHit
.String
getNextPageUrl()
getNextPageUrl.String
getNextPageUrl(int step)
getNextPageUrl.int
getNumberOfImages()
getNumberOfImages.String
getPageUrl()
getPageUrl.String
getPageUrl(int order)
String
getPageUrl(String pageOrderRange)
getPageUrl.String
getPageUrl(String pageType, String pageOrderRange)
Returns the navigation URL for the given page type and number.String
getPageUrlByType(String pageType)
getPageUrl.String
getPageUrlRelativeToCurrentPage(int step)
getNextPageUrl.String
getPersistentIdentifier()
Returns the PI of the currently loaded record.BrowseElement
getPrevHit()
Getter for the fieldprevHit
.String
getPreviousDocstructUrl()
String
getPreviousPageUrl()
getPreviousPageUrl.String
getPreviousPageUrl(int step)
getPreviousPageUrl.String
getReadingModeUrl()
Deprecated.renamed to fullscreenList<String>
getRecordLanguages()
Getter for the fieldrecordLanguages
.List<SearchHit>
getRelatedItems(String identifierField)
getRelatedItems.String
getRelatedItemsQueryString(String identifierField)
Returns a query string containing all values of the given identifier field.String
getRelativeUrlTags()
Returns a string that contains previous and/or next url elementsDownloadOption
getSelectedDownloadOption()
String
getSelectedDownloadOptionLabel()
String
getSelectedRecordLanguage()
Getter for the fieldselectedRecordLanguage
.String
getThumbPart()
getThumbPart.String
getTitleBarLabel()
getTitleBarLabel.String
getTitleBarLabel(String language)
getTitleBarLabel.String
getTitleBarLabel(Locale locale)
getTitleBarLabel.TOC
getToc()
Getter for the fieldtoc
.String
getTocCurrentPage()
Getter for the fieldtocCurrentPage
.StructElement
getTopDocument()
getTopDocument.long
getTopDocumentIddoc()
Getter for the fieldtopDocumentIddoc
.ViewManager
getViewManager()
Do not call from ActiveDocumentBean.update()!boolean
hasAnchor()
Checks if there is an anchor in this docStruct's hierarchyboolean
isAccessPermissionEpub()
isAccessPermissionEpub.boolean
isAccessPermissionPdf()
isAccessPermissionPdf.boolean
isAllowUserComments()
Indicates whether user comments are allowed for the current record based on several criteria.boolean
isAnchor()
isAnchor.boolean
isDownloadImageModalVisible()
boolean
isGroup()
isGroup.boolean
isHasLanguages()
isHasLanguages.boolean
isRecordLoaded()
Indicates whether a record is currently properly loaded in this bean.boolean
isRequiresWebSocket()
Check if the current page should initialize a WebSocketboolean
isVolume()
isVolume.String
open()
Pretty-URL entry point.String
openFulltext()
openFulltext.String
reIndexRecordAction()
Exports the currently loaded for re-indexing.String
reload(String pi)
void
reset()
TODO This can cause NPEs if called while update() is running.void
resetAccess()
resets the access rights for user comments and pdf download stored inViewManager
.void
setAction(String action)
Setter for the fieldaction
.void
setAnchor(boolean anchor)
Setter for the fieldanchor
.void
setBookshelfBean(BookmarkBean bookshelfBean)
Required setter for ManagedProperty injectionvoid
setBreadcrumbBean(BreadcrumbBean breadcrumbBean)
Required setter for ManagedProperty injectionvoid
setChildrenInvisible(TOCElement element)
setChildrenInvisible.void
setChildrenVisible(TOCElement element)
setChildrenVisible.void
setClearCacheMode(String clearCacheMode)
void
setCmsBean(CmsBean cmsBean)
Required setter for ManagedProperty injectionvoid
setCurrentThumbnailPage(int currentThumbnailPage)
setCurrentThumbnailPage.void
setDeleteRecordKeepTrace(Boolean deleteRecordKeepTrace)
Setter for the fielddeleteRecordKeepTrace
.String
setDoublePageModeAction(boolean doublePageMode)
This method augments the setterViewManager.setDoublePageMode(boolean)
with URL modifications to reflect the mode.void
setDownloadOptionLabelFromRequestParameter()
void
setImageToShow(String imageToShow)
Setter for the fieldimageToShow
.void
setLogid(String logid)
Setter for the fieldlogid
.void
setNavigationHelper(NavigationHelper navigationHelper)
Required setter for ManagedProperty injectionvoid
setPersistentIdentifier(String persistentIdentifier)
setPersistentIdentifier.void
setRecordLanguages(List<String> recordLanguages)
Setter for the fieldrecordLanguages
.void
setSearchBean(SearchBean searchBean)
Required setter for ManagedProperty injectionvoid
setSelectedDownloadOptionLabel(String selectedDownloadOptionLabel)
void
setSelectedRecordLanguage(String selectedRecordLanguage)
Setter for the fieldselectedRecordLanguage
.void
setTocCurrentPage(String tocCurrentPage)
Setter for the fieldtocCurrentPage
.void
toggleDownloadImageModal()
void
update()
Loads the record with the IDDOC set incurrentElementIddoc
.
-
-
-
Method Detail
-
setNavigationHelper
public void setNavigationHelper(NavigationHelper navigationHelper)
Required setter for ManagedProperty injection- Parameters:
navigationHelper
- the navigationHelper to set
-
setCmsBean
public void setCmsBean(CmsBean cmsBean)
Required setter for ManagedProperty injection- Parameters:
cmsBean
- the cmsBean to set
-
setSearchBean
public void setSearchBean(SearchBean searchBean)
Required setter for ManagedProperty injection- Parameters:
searchBean
- the searchBean to set
-
setBookshelfBean
public void setBookshelfBean(BookmarkBean bookshelfBean)
Required setter for ManagedProperty injection- Parameters:
bookshelfBean
- the bookshelfBean to set
-
setBreadcrumbBean
public void setBreadcrumbBean(BreadcrumbBean breadcrumbBean)
Required setter for ManagedProperty injection- Parameters:
breadcrumbBean
- the breadcrumbBean to set
-
reset
public void reset() throws IndexUnreachableException
TODO This can cause NPEs if called while update() is running.- Throws:
IndexUnreachableException
-
getViewManager
public ViewManager getViewManager()
Do not call from ActiveDocumentBean.update()!- Returns:
- a
ViewManager
object.
-
reload
public String reload(String pi) throws PresentationException, RecordNotFoundException, RecordDeletedException, IndexUnreachableException, DAOException, ViewerConfigurationException, RecordLimitExceededException
- Parameters:
pi
-- Throws:
PresentationException
- @throws RecordNotFoundException @throws RecordDeletedException @throws IndexUnreachableException @throws DAOException @throws ViewerConfigurationException @throws RecordLimitExceededException @throwsRecordNotFoundException
RecordDeletedException
IndexUnreachableException
DAOException
ViewerConfigurationException
RecordLimitExceededException
-
update
public void update() throws PresentationException, IndexUnreachableException, RecordNotFoundException, RecordDeletedException, DAOException, ViewerConfigurationException, IDDOCNotFoundException, NumberFormatException, RecordLimitExceededException
Loads the record with the IDDOC set incurrentElementIddoc
.- Throws:
PresentationException
- if any.IndexUnreachableException
- if any.RecordNotFoundException
- if any.RecordDeletedException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.IDDOCNotFoundException
RecordLimitExceededException
NumberFormatException
-
open
public String open() throws RecordNotFoundException, RecordDeletedException, IndexUnreachableException, DAOException, ViewerConfigurationException, RecordLimitExceededException
Pretty-URL entry point.- Returns:
- a
String
object. - Throws:
RecordNotFoundException
- if any.RecordDeletedException
- if any.IndexUnreachableException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.RecordLimitExceededException
PresentationException
-
openFulltext
public String openFulltext() throws RecordNotFoundException, RecordDeletedException, IndexUnreachableException, DAOException, ViewerConfigurationException, PresentationException, NumberFormatException, RecordLimitExceededException
openFulltext.
- Returns:
- a
String
object. - Throws:
RecordNotFoundException
- if any.RecordDeletedException
- if any.IndexUnreachableException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.PresentationException
RecordLimitExceededException
NumberFormatException
-
getPrevHit
public BrowseElement getPrevHit() throws PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
Getter for the field
prevHit
.- Returns:
- a
BrowseElement
object. - Throws:
PresentationException
- if any.IndexUnreachableException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
getNextHit
public BrowseElement getNextHit() throws PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
Getter for the field
nextHit
.- Returns:
- a
BrowseElement
object. - Throws:
PresentationException
- if any.IndexUnreachableException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
getActiveDocumentIddoc
public long getActiveDocumentIddoc()
Getter and Setter **************************************- Returns:
- a long.
-
getCurrentElement
public StructElement getCurrentElement() throws IndexUnreachableException
getCurrentElement.
- Returns:
- the currentElement
- Throws:
IndexUnreachableException
- if any.
-
setImageToShow
public void setImageToShow(String imageToShow)
Setter for the field
imageToShow
.- Parameters:
imageToShow
- the imageToShow to set
-
getImageToShow
public String getImageToShow()
Getter for the field
imageToShow
.- Returns:
- the imageToShow
-
setLogid
public void setLogid(String logid)
Setter for the field
logid
.- Parameters:
logid
- the logid to set
-
getLogid
public String getLogid()
Getter for the field
logid
.- Returns:
- the logid
-
isAnchor
public boolean isAnchor()
isAnchor.
- Returns:
- the anchor
-
setAnchor
public void setAnchor(boolean anchor)
Setter for the field
anchor
.- Parameters:
anchor
- the anchor to set
-
isVolume
public boolean isVolume()
isVolume.
- Returns:
- a boolean.
-
isGroup
public boolean isGroup()
isGroup.
- Returns:
- a boolean.
-
getAction
public String getAction()
Getter for the field
action
.- Returns:
- the action
-
setAction
public void setAction(String action)
Setter for the field
action
.- Parameters:
action
- the action to set
-
setPersistentIdentifier
public void setPersistentIdentifier(String persistentIdentifier) throws PresentationException, RecordNotFoundException, IndexUnreachableException
setPersistentIdentifier.
- Parameters:
persistentIdentifier
- aString
object.- Throws:
PresentationException
- if any.RecordNotFoundException
- if any.IndexUnreachableException
- if any.
-
getPersistentIdentifier
public String getPersistentIdentifier() throws IndexUnreachableException
Returns the PI of the currently loaded record. Only call this method after the update() method has re-initialized ViewManager, otherwise the previous PI may be returned!- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getThumbPart
public String getThumbPart() throws IndexUnreachableException
getThumbPart.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getLogPart
public String getLogPart() throws IndexUnreachableException
getLogPart.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getPageUrl
public String getPageUrl(String pageType, String pageOrderRange) throws IndexUnreachableException
Returns the navigation URL for the given page type and number.- Parameters:
pageType
- aString
object.pageOrderRange
- Single page number or range- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getPageUrl
public String getPageUrl(String pageOrderRange) throws IndexUnreachableException
getPageUrl.
- Parameters:
pageOrderRange
- Single page number or range- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getPageUrl
public String getPageUrl() throws IndexUnreachableException
getPageUrl.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getPageUrlByType
public String getPageUrlByType(String pageType) throws IndexUnreachableException
getPageUrl.
- Parameters:
pageType
- aString
object.- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getFirstPageUrl
public String getFirstPageUrl() throws IndexUnreachableException
getFirstPageUrl.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getLastPageUrl
public String getLastPageUrl() throws IndexUnreachableException
getLastPageUrl.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getPageUrlRelativeToCurrentPage
public String getPageUrlRelativeToCurrentPage(int step) throws IndexUnreachableException, DAOException
getNextPageUrl.
- Parameters:
step
- a int.- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.DAOException
-
getPageUrl
public String getPageUrl(int order) throws IndexUnreachableException
- Throws:
IndexUnreachableException
-
getPreviousPageUrl
public String getPreviousPageUrl(int step) throws IndexUnreachableException, DAOException
getPreviousPageUrl.
- Parameters:
step
-- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.DAOException
-
getNextPageUrl
public String getNextPageUrl(int step) throws IndexUnreachableException, DAOException
getNextPageUrl.
- Parameters:
step
-- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.DAOException
-
getPreviousPageUrl
public String getPreviousPageUrl() throws IndexUnreachableException, DAOException
getPreviousPageUrl.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.DAOException
-
getNextPageUrl
public String getNextPageUrl() throws IndexUnreachableException, DAOException
getNextPageUrl.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.DAOException
-
getPreviousDocstructUrl
public String getPreviousDocstructUrl() throws IndexUnreachableException, PresentationException, DAOException, ViewerConfigurationException
-
getNextDocstructUrl
public String getNextDocstructUrl() throws IndexUnreachableException, PresentationException, DAOException, ViewerConfigurationException
-
getImageUrl
public String getImageUrl() throws IndexUnreachableException
getImageUrl.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getFullscreenImageUrl
public String getFullscreenImageUrl() throws IndexUnreachableException, DAOException
getFullscreenImageUrl.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.DAOException
-
getReadingModeUrl
public String getReadingModeUrl() throws IndexUnreachableException, DAOException
Deprecated.renamed to fullscreengetReadingModeUrl.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.DAOException
-
getFulltextUrl
public String getFulltextUrl() throws IndexUnreachableException
getFulltextUrl.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getMetadataUrl
public String getMetadataUrl() throws IndexUnreachableException
getMetadataUrl.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.
-
getTopDocument
public StructElement getTopDocument()
getTopDocument.
- Returns:
- a
StructElement
object.
-
setChildrenVisible
public void setChildrenVisible(TOCElement element) throws PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
setChildrenVisible.
- Parameters:
element
- aTOCElement
object.- Throws:
PresentationException
- if any.IndexUnreachableException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
setChildrenInvisible
public void setChildrenInvisible(TOCElement element) throws PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
setChildrenInvisible.
- Parameters:
element
- aTOCElement
object.- Throws:
PresentationException
- if any.IndexUnreachableException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
calculateSidebarToc
public String calculateSidebarToc() throws IOException, PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
Recalculates the visibility of TOC elements and jumps to the active element after a +/- button has been pressed.- Returns:
- a
String
object. - Throws:
IOException
- if any.PresentationException
- if any.IndexUnreachableException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
getToc
public TOC getToc() throws PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
Getter for the field
toc
.- Returns:
- the toc
- Throws:
PresentationException
- if any.IndexUnreachableException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
getTocCurrentPage
public String getTocCurrentPage()
Getter for the field
tocCurrentPage
.- Returns:
- a int.
-
setTocCurrentPage
public void setTocCurrentPage(String tocCurrentPage) throws PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
Setter for the field
tocCurrentPage
.- Parameters:
tocCurrentPage
- a int.- Throws:
PresentationException
- if any.IndexUnreachableException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
getTitleBarLabel
public String getTitleBarLabel(Locale locale) throws IndexUnreachableException, PresentationException, DAOException, ViewerConfigurationException
getTitleBarLabel.
- Parameters:
locale
- aLocale
object.- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.PresentationException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
getTitleBarLabel
public String getTitleBarLabel() throws IndexUnreachableException, PresentationException, DAOException, ViewerConfigurationException
getTitleBarLabel.
- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.PresentationException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
getTitleBarLabel
public String getTitleBarLabel(String language) throws IndexUnreachableException, PresentationException, DAOException, ViewerConfigurationException
getTitleBarLabel.
- Parameters:
language
- aString
object.- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.PresentationException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
getLabelForJS
public String getLabelForJS() throws IndexUnreachableException, PresentationException, DAOException, ViewerConfigurationException
Title bar label value escaped for JavaScript.- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.PresentationException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
getImageContainerWidth
public int getImageContainerWidth()
Getter for the field
imageContainerWidth
.- Returns:
- a int.
-
getNumberOfImages
public int getNumberOfImages() throws IndexUnreachableException
getNumberOfImages.
- Returns:
- a int.
- Throws:
IndexUnreachableException
- if any.
-
getTopDocumentIddoc
public long getTopDocumentIddoc()
Getter for the field
topDocumentIddoc
.- Returns:
- Not this.topDocumentIddoc but ViewManager.topDocumentIddoc
-
isRecordLoaded
public boolean isRecordLoaded()
Indicates whether a record is currently properly loaded in this bean. Use to determine whether to display components.- Returns:
- a boolean.
-
hasAnchor
public boolean hasAnchor() throws IndexUnreachableException
Checks if there is an anchor in this docStruct's hierarchy- Returns:
- a boolean.
- Throws:
IndexUnreachableException
- if any.
-
reIndexRecordAction
public String reIndexRecordAction() throws IndexUnreachableException, DAOException, RecordNotFoundException
Exports the currently loaded for re-indexing.- Returns:
- a
String
object. - Throws:
IndexUnreachableException
- if any.DAOException
- if any.RecordNotFoundException
- if any.
-
deleteRecordAction
public String deleteRecordAction(boolean keepTraceDocument) throws IOException, IndexUnreachableException
deleteRecordAction.
- Parameters:
keepTraceDocument
- If true, a .delete file will be created; otherwise a .purge file- Returns:
- outcome
- Throws:
IOException
- if any.IndexUnreachableException
- if any.
-
clearCacheAction
public String clearCacheAction() throws org.apache.http.client.ClientProtocolException, IOException, IndexUnreachableException
- Returns:
- Throws:
org.apache.http.client.ClientProtocolException
IOException
IndexUnreachableException
-
getCurrentThumbnailPage
public int getCurrentThumbnailPage()
getCurrentThumbnailPage.
- Returns:
- a int.
-
setCurrentThumbnailPage
public void setCurrentThumbnailPage(int currentThumbnailPage)
setCurrentThumbnailPage.
- Parameters:
currentThumbnailPage
- a int.
-
isHasLanguages
public boolean isHasLanguages()
isHasLanguages.
- Returns:
- a boolean.
-
getRecordLanguages
public List<String> getRecordLanguages()
Getter for the field
recordLanguages
.- Returns:
- the recordLanguages
-
setRecordLanguages
public void setRecordLanguages(List<String> recordLanguages)
Setter for the field
recordLanguages
.- Parameters:
recordLanguages
- the recordLanguages to set
-
getSelectedRecordLanguage
public String getSelectedRecordLanguage()
Getter for the field
selectedRecordLanguage
.- Returns:
- the selectedRecordLanguage
-
setSelectedRecordLanguage
public void setSelectedRecordLanguage(String selectedRecordLanguage)
Setter for the field
selectedRecordLanguage
.- Parameters:
selectedRecordLanguage
- the selectedRecordLanguage to set
-
isAccessPermissionEpub
public boolean isAccessPermissionEpub()
isAccessPermissionEpub.
- Returns:
- a boolean.
-
isAccessPermissionPdf
public boolean isAccessPermissionPdf()
isAccessPermissionPdf.
- Returns:
- a boolean.
-
downloadTOCAction
public void downloadTOCAction() throws IOException, PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
downloadTOCAction.
- Throws:
IOException
- if any.PresentationException
- if any.IndexUnreachableException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
getRelatedItems
public List<SearchHit> getRelatedItems(String identifierField) throws PresentationException, IndexUnreachableException, DAOException, ViewerConfigurationException
getRelatedItems.
- Parameters:
identifierField
- Index field containing related item identifiers- Returns:
- List of related items as SearchHit objects.
- Throws:
PresentationException
- if any.IndexUnreachableException
- if any.DAOException
- if any.ViewerConfigurationException
- if any.
-
getRelatedItemsQueryString
public String getRelatedItemsQueryString(String identifierField)
Returns a query string containing all values of the given identifier field.- Parameters:
identifierField
- Index field containing related item identifiers- Returns:
- Query string of the pattern "PI:(a OR b OR c)"
-
getRelativeUrlTags
public String getRelativeUrlTags() throws IndexUnreachableException, DAOException, PresentationException
Returns a string that contains previous and/or next url elements- Returns:
- string containing previous and/or next url elements
- Throws:
IndexUnreachableException
- if any.DAOException
- if any.PresentationException
- if any.
-
resetAccess
public void resetAccess()
resets the access rights for user comments and pdf download stored inViewManager
. After reset, the access rights will be evaluated again on being called
-
getDeleteRecordKeepTrace
public Boolean getDeleteRecordKeepTrace()
Getter for the field
deleteRecordKeepTrace
.- Returns:
- the deleteRecordKeepTrace
-
setDeleteRecordKeepTrace
public void setDeleteRecordKeepTrace(Boolean deleteRecordKeepTrace)
Setter for the field
deleteRecordKeepTrace
.- Parameters:
deleteRecordKeepTrace
- the deleteRecordKeepTrace to set
-
getClearCacheMode
public String getClearCacheMode()
- Returns:
- the clearCacheMode
-
setClearCacheMode
public void setClearCacheMode(String clearCacheMode)
- Parameters:
clearCacheMode
- the clearCacheMode to set
-
getGeoMap
public GeoMap getGeoMap() throws PresentationException, DAOException, IndexUnreachableException
Get a CMSSidebarElement with a map containing all GeoMarkers for the current PI. The widget is stored in the bean, but refreshed each time the PI changes- Returns:
- Throws:
PresentationException
DAOException
IndexUnreachableException
-
generateGeoMap
public GeoMap generateGeoMap(String pi) throws PresentationException, DAOException
- Parameters:
pi
-- Returns:
- Throws:
PresentationException
DAOException
-
toggleDownloadImageModal
public void toggleDownloadImageModal()
-
isDownloadImageModalVisible
public boolean isDownloadImageModalVisible()
- Returns:
- the downloadImageModalVisible
-
getSelectedDownloadOption
public DownloadOption getSelectedDownloadOption()
-
getSelectedDownloadOptionLabel
public String getSelectedDownloadOptionLabel()
- Returns:
- the selectedDownloadOptionLabel
-
setSelectedDownloadOptionLabel
public void setSelectedDownloadOptionLabel(String selectedDownloadOptionLabel)
- Parameters:
selectedDownloadOptionLabel
- the selectedDownloadOptionLabel to set
-
setDownloadOptionLabelFromRequestParameter
public void setDownloadOptionLabelFromRequestParameter()
-
setDoublePageModeAction
public String setDoublePageModeAction(boolean doublePageMode) throws IndexUnreachableException, DAOException
This method augments the setterViewManager.setDoublePageMode(boolean)
with URL modifications to reflect the mode.- Parameters:
doublePageMode
- The doublePageMode to set- Throws:
IndexUnreachableException
DAOException
-
isAllowUserComments
public boolean isAllowUserComments() throws DAOException
Indicates whether user comments are allowed for the current record based on several criteria.- Returns:
- a boolean.
- Throws:
DAOException
-
isRequiresWebSocket
public boolean isRequiresWebSocket()
Check if the current page should initialize a WebSocket- Returns:
- true if a document is loaded and it contains the field
SolrConstants.ACCESSCONDITION_CONCURRENTUSE
-
-