Package io.goobi.viewer.dao

Interface IDAO

All Known Implementing Classes:

JPADAO

public interface IDAO

IDAO interface.

Method Summary

Modifier and Type	Method	Description
boolean	addAnnotation(CrowdsourcingAnnotation annotation)	addAnnotation.
boolean	addBookmarkList(BookmarkList bookmarkList)	addBookmarkList.
boolean	addCampaign(Campaign campaign)	addCampaign.
boolean	addCategory(CMSCategory category)	addCategory.
boolean	addCMSCollection(CMSCollection collection)	addCMSCollection.
boolean	addCMSComponent(PersistentCMSComponent persistentCMSComponent)
boolean	addCMSMediaItem(CMSMediaItem item)	addCMSMediaItem.
boolean	addCMSNavigationItem(CMSNavigationItem item)	addCMSNavigationItem.
boolean	addCMSPage(CMSPage page)	addCMSPage.
boolean	addCMSPageTemplate(CMSPageTemplate template)
boolean	addComment(Comment comment)	addComment.
boolean	addCommentGroup(CommentGroup commentGroup)	addCommentGroup.
boolean	addCustomWidget(CustomSidebarWidget widget)
boolean	addDownloadJob(DownloadJob downloadJob)	addDownloadJob.
boolean	addDownloadTicket(DownloadTicket downloadTicket)	addDownloadTicket.
boolean	addGeoMap(GeoMap map)	Add the given map to the database if no map of the same id already exists
boolean	addHighlight(HighlightData object)
boolean	addIpRange(IpRange ipRange)	addIpRange.
boolean	addLicenseType(LicenseType licenseType)	addLicenseType.
boolean	addRecordNote(CMSRecordNote note)	Persist a new CMSRecordNote.
boolean	addRecurringTaskTrigger(RecurringTaskTrigger trigger)
boolean	addRole(Role role)	addRole.
boolean	addSearch(Search search)	addSearch.
boolean	addSlider(CMSSlider slider)
boolean	addStaticPage(CMSStaticPage page)	addStaticPage.
boolean	addTheme(ThemeConfiguration theme)
boolean	addTranskribusJob(TranskribusJob job)	addTranskribusJob.
boolean	addUploadJob(UploadJob uploadJob)	addDownloadJob.
boolean	addUsageStatistics(DailySessionUsageStatistics statistics)
boolean	addUser(User user)	addUser.
boolean	addUserGroup(UserGroup userGroup)	addUserGroup.
boolean	addUserRole(UserRole userRole)	addUserRole.
boolean	addViewerMessage(ViewerMessage message)
int	changeCampaignStatisticContributors(User fromUser, User toUser)	Replaced fromUser with toUser in the lists of annotators and reviewers an all campaign statistics.
int	changeCommentsOwner(User fromUser, User toUser)	Changes ownership of all comments from fromUser to toUser.
boolean	checkAvailability()
void	close(jakarta.persistence.EntityManager em)	Either close the given EntityManager or do some other post query/transaction handling for the given EntityManager.
boolean	columnsExists(String tableName, String columnName)	columnsExists.
void	commitTransaction(jakarta.persistence.EntityManager em)	Call EntityTransaction.commit() on the current transaction of the given EntityManager
void	commitTransaction(jakarta.persistence.EntityTransaction et)	Call EntityTransaction.commit() on the given transaction
boolean	deleteAnnotation(CrowdsourcingAnnotation annotation)	deleteAnnotation.
boolean	deleteBookmarkList(BookmarkList bookmarkList)	deleteBookmarkList.
boolean	deleteCampaign(Campaign campaign)	deleteCampaign.
int	deleteCampaignStatisticsForUser(User user)	Deletes given user from the lists of annotators and reviewers an all campaign statistics.
boolean	deleteCategory(CMSCategory category)	deleteCategory.
boolean	deleteClientApplication(long id)
boolean	deleteCMSCollection(CMSCollection collection)	deleteCMSCollection.
boolean	deleteCMSComponent(PersistentCMSComponent persistentCMSComponent)
boolean	deleteCMSContent(CMSContent content)
boolean	deleteCMSMediaItem(CMSMediaItem item)	deleteCMSMediaItem.
boolean	deleteCMSNavigationItem(CMSNavigationItem item)	deleteCMSNavigationItem.
boolean	deleteCMSPage(CMSPage page)	deleteCMSPage.
boolean	deleteComment(Comment comment)	deleteComment.
boolean	deleteCommentGroup(CommentGroup commentGroup)	deleteCommentGroup.
int	deleteComments(String pi, User owner)
boolean	deleteCustomWidget(Long id)
boolean	deleteDownloadJob(DownloadJob downloadJob)	deleteDownloadJob.
boolean	deleteDownloadTicket(DownloadTicket downloadTicket)	deleteDownloadTicket.
boolean	deleteGeoMap(GeoMap map)	Delete the given GeoMap from the database
boolean	deleteHighlight(Long id)
boolean	deleteIpRange(IpRange ipRange)	deleteIpRange.
boolean	deleteLicenseType(LicenseType licenseType)	deleteLicenseType.
boolean	deleteRecordNote(CMSRecordNote note)	Deletes an existing CMSRecordNote
boolean	deleteRecurringTaskTrigger(Long id)
boolean	deleteRole(Role role)	deleteRole.
boolean	deleteSearch(Search search)	deleteSearch.
boolean	deleteSlider(CMSSlider slider)
boolean	deleteStaticPage(CMSStaticPage page)	deleteStaticPage.
boolean	deleteTheme(ThemeConfiguration theme)
boolean	deleteTranskribusJob(TranskribusJob job)	deleteTranskribusJob.
boolean	deleteUploadJob(UploadJob uploadJob)	deleteDownloadJob.
boolean	deleteUsageStatistics(long id)
boolean	deleteUser(User user)	deleteUser.
boolean	deleteUserGroup(UserGroup userGroup)	deleteUserGroup.
boolean	deleteUserRole(UserRole userRole)	deleteUserRole.
boolean	deleteViewerMessage(ViewerMessage message)
int	deleteViewerMessagesBefore(LocalDateTime date)
int	executeUpdate(String string)
long	getActiveDownloadTicketCount(Map<String,String> filters)	getActiveDownloadTicketCount.
List<DownloadTicket>	getActiveDownloadTickets(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getActiveDownloadTickets.
List<CrowdsourcingAnnotation>	getAllAnnotations(String sortField, boolean sortDescending)
List<CrowdsourcingAnnotation>	getAllAnnotationsByMotivation(String commenting)
List<BookmarkList>	getAllBookmarkLists()	getAllBookmarkLists.
List<Campaign>	getAllCampaigns()	getAllCampaigns.
List<CMSCategory>	getAllCategories()	getAllCategories.
List<ClientApplication>	getAllClientApplications()
List<CMSMediaItem>	getAllCMSCollectionItems()	getAllCMSCollectionItems.
List<CMSMediaItem>	getAllCMSMediaItems()	getAllCMSMediaItems.
List<CMSPage>	getAllCMSPages()	getAllCMSPages.
List<CMSPageTemplate>	getAllCMSPageTemplates()
List<CommentGroup>	getAllCommentGroups()
List<Comment>	getAllComments()	getAllComments.
List<CustomSidebarWidget>	getAllCustomWidgets()
List<DownloadJob>	getAllDownloadJobs()	getAllDownloadJobs.
List<GeoMap>	getAllGeoMaps()	Get all GeoMaps in database
List<HighlightData>	getAllHighlights()
List<IpRange>	getAllIpRanges()	getAllIpRanges.
List<License>	getAllLicenses()	getAllLicenses.
List<LicenseType>	getAllLicenseTypes()	getAllLicenseTypes.
List<CMSMultiRecordNote>	getAllMultiRecordNotes(boolean displayedNotesOnly)	Get all CMSMultiRecordNotes.
List<CMSRecordNote>	getAllRecordNotes()	Get all persisted CMSRecordNotes
List<Role>	getAllRoles()	getAllRoles.
List<Search>	getAllSearches()	getAllSearches.
List<CMSSlider>	getAllSliders()
List<CMSStaticPage>	getAllStaticPages()	getAllStaticPages.
List<CMSNavigationItem>	getAllTopCMSNavigationItems()	getAllTopCMSNavigationItems.
List<TranskribusJob>	getAllTranskribusJobs()	getAllTranskribusJobs.
List<DailySessionUsageStatistics>	getAllUsageStatistics()
List<UserGroup>	getAllUserGroups()	getAllUserGroups.
List<UserRole>	getAllUserRoles()	getAllUserRoles.
List<User>	getAllUsers(boolean refresh)	getAllUsers.
CrowdsourcingAnnotation	getAnnotation(Long id)	Annotations *
long	getAnnotationCount(Map<String,String> filters)	getAnnotationCount.
long	getAnnotationCountForTarget(String pi, Integer page)	getAnnotationCountForTarget.
long	getAnnotationCountForWork(String pi)
List<CrowdsourcingAnnotation>	getAnnotations(int first, int pageSize, String sortField, boolean descending, String filterString, Map<String,Object> filterParams)
List<CrowdsourcingAnnotation>	getAnnotations(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getAnnotations.
List<CrowdsourcingAnnotation>	getAnnotationsForCampaign(Campaign campaign)	getAnnotationsForCampaign.
List<CrowdsourcingAnnotation>	getAnnotationsForCampaignAndTarget(Campaign campaign, String pi, Integer page)	getAnnotationsForCampaignAndTarget.
List<CrowdsourcingAnnotation>	getAnnotationsForCampaignAndWork(Campaign campaign, String pi)	getAnnotationsForCampaignAndWork.
List<CrowdsourcingAnnotation>	getAnnotationsForTarget(String pi, Integer page)	getAnnotationsForTarget.
List<CrowdsourcingAnnotation>	getAnnotationsForTarget(String pi, Integer page, String motivation)
List<CrowdsourcingAnnotation>	getAnnotationsForUserId(Long userId, Integer maxResults, String sortField, boolean descending)
List<CrowdsourcingAnnotation>	getAnnotationsForWork(String pi)	getAnnotationsForWork.
BookmarkList	getBookmarkList(long id)	getBookmarkList.
BookmarkList	getBookmarkList(String name, User user)	getBookmarkList.
BookmarkList	getBookmarkListByShareKey(String shareKey)	getBookmarkListByShareKey.
long	getBookmarkListCount(User user)	Get number of bookmark lists owned by the given user
List<BookmarkList>	getBookmarkLists(User user)	getBookmarkLists.
Campaign	getCampaign(Long id)	getCampaign.
long	getCampaignCount(Map<String,String> filters)	getCampaignCount.
List<CampaignRecordPageStatistic>	getCampaignPageStatisticsForRecord(String pi, CrowdsourcingStatus status)	getCampaignPageStatisticsForRecord.
List<Campaign>	getCampaigns(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getCampaigns.
List<CampaignRecordStatistic>	getCampaignStatisticsForRecord(String pi, CrowdsourcingStatus status)	getCampaignStatisticsForRecord.
CMSCategory	getCategory(Long id)	getCategory.
CMSCategory	getCategoryByName(String name)	getCategoryByName.
ClientApplication	getClientApplication(long id)
ClientApplication	getClientApplicationByClientId(String clientId)
CMSCollection	getCMSCollection(String solrField, String solrFieldValue)	getCMSCollection.
List<CMSCollection>	getCMSCollections(String solrField)	getCMSCollections.
PersistentCMSComponent	getCMSComponent(Long id)
CMSMediaItem	getCMSMediaItem(long id)	getCMSMediaItem.
CMSMediaItem	getCMSMediaItemByFilename(String string)	getCMSMediaItemByFilename.
List<CMSMediaItem>	getCMSMediaItemsByCategory(CMSCategory category)	Get a list of all CMSMediaItems which contain the given category
CMSNavigationItem	getCMSNavigationItem(long id)	getCMSNavigationItem.
CMSPage	getCMSPage(long id)	getCMSPage.
long	getCMSPageCount(Map<String,String> filters, List<Long> allowedTemplates, List<String> allowedSubthemes, List<String> allowedCategories)	getCMSPageCount.
CMSPage	getCMSPageDefaultViewForRecord(String pi)
CMSPage	getCmsPageForStaticPage(String pageName)	getCmsPageForStaticPage.
List<CMSPage>	getCMSPages(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters, List<Long> allowedTemplates, List<String> allowedSubthemes, List<String> allowedCategories)	getCMSPages.
List<CMSPage>	getCMSPagesByCategory(CMSCategory category)	getCMSPagesByCategory.
List<CMSPage>	getCMSPagesForRecord(String pi, CMSCategory category)	getCMSPagesForRecord.
List<CMSPage>	getCMSPagesForSubtheme(String subtheme)
List<CMSPage>	getCMSPagesWithRelatedPi(int first, int pageSize, LocalDateTime fromDate, LocalDateTime toDate)	getCMSPagesWithRelatedPi.
CMSPageTemplate	getCMSPageTemplate(Long id)
long	getCMSPageWithRelatedPiCount(LocalDateTime fromDate, LocalDateTime toDate)	getCMSPageWithRelatedPiCount.
Comment	getComment(long id)	getComment.
long	getCommentCount(Map<String,String> filters, User owner, Set<String> targetPIs)	getCommentCount.
CommentGroup	getCommentGroup(long id)	getCommentGroup.
CommentGroup	getCommentGroupUnfiltered()
List<Comment>	getComments(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters, Set<String> targetPIs)	getComments.
List<Comment>	getCommentsForPage(String pi, int page)	getCommentsForPage.
List<Comment>	getCommentsForWork(String pi)	getCommentsForWork.
List<Comment>	getCommentsOfUser(User user, int maxResults, String sortField, boolean descending)	Get Comments created by a specific user
List<ThemeConfiguration>	getConfiguredThemes()
CookieBanner	getCookieBanner()
long	getCoreLicenseTypeCount(Map<String,String> filters)	getCoreLicenseTypeCount.
List<LicenseType>	getCoreLicenseTypes(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getCoreLicenseTypes.
long	getCountMediaItemsUsingCategory(CMSCategory category)
long	getCountPagesUsingCategory(CMSCategory category)
CustomSidebarWidget	getCustomWidget(Long id)
Disclaimer	getDisclaimer()	Get the single stored Disclaimer.
DownloadJob	getDownloadJob(long id)	getDownloadJob.
DownloadJob	getDownloadJobByIdentifier(String identifier)	getDownloadJobByIdentifier.
DownloadJob	getDownloadJobByMetadata(String type, String pi, String logId)	getDownloadJobByMetadata.
List<DownloadJob>	getDownloadJobsForPi(String pi)	getDownloadJobsForPi.
DownloadTicket	getDownloadTicket(Long id)
DownloadTicket	getDownloadTicketByPasswordHash(String passwordHash)
List<DownloadTicket>	getDownloadTicketRequests()
jakarta.persistence.EntityManager	getEntityManager()	Get an EntityManager for a query or transaction.
jakarta.persistence.EntityManagerFactory	getFactory()	Get the EntityManagerFactory created when initializing the class.
List<HighlightData>	getFutureHighlightsForDate(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters, LocalDateTime date)
GeoMap	getGeoMap(Long mapId)	Get the GeoMap of the given mapId
HighlightData	getHighlight(Long id)
List<HighlightData>	getHighlights(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)
List<HighlightData>	getHighlightsForDate(LocalDateTime date)
IpRange	getIpRange(long id)	getIpRange.
IpRange	getIpRange(String name)	getIpRange.
long	getIpRangeCount(Map<String,String> filters)	getIpRangeCount.
List<IpRange>	getIpRanges(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getIpRanges.
License	getLicense(Long id)	getLicense.
long	getLicenseCount(LicenseType licenseType)	Returns the number of licenses that use the given license type.
List<License>	getLicenses(LicenseType licenseType)
LicenseType	getLicenseType(long id)	getLicenseType.
LicenseType	getLicenseType(String name)	getLicenseType.
long	getLicenseTypeCount(Map<String,String> filters)	getLicenseTypeCount.
List<LicenseType>	getLicenseTypes(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getLicenseTypes.
List<LicenseType>	getLicenseTypes(List<String> names)	Returns all license types that match the given name list.
List	getNativeQueryResults(String query)
Long	getNumRecordsWithComments(User user)
List<LicenseType>	getOverridingLicenseType(LicenseType licenseType)
List<CMSPage>	getPagesUsingMap(GeoMap map)	Return a list of CMS-pages embedding the given map
List<CMSPage>	getPagesUsingMapInSidebar(GeoMap map)	Return a list of CMS-pages embedding the given map in a sidebar widget
List<CMSPage>	getPagesUsingSlider(CMSSlider slider)
List<CMSPage>	getPagesUsingWidget(CustomSidebarWidget widget)
List<Integer>	getPagesWithComments(String pi)	getPagesWithComments.
List<HighlightData>	getPastHighlightsForDate(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters, LocalDateTime date)
List<BookmarkList>	getPublicBookmarkLists()	getPublicBookmarkLists.
Question	getQuestion(Long id)	getQuestion.
List<LicenseType>	getRecordLicenseTypes()	getRecordLicenseTypes.
CMSRecordNote	getRecordNote(Long id)	Get a CMSRecordNote by its id property
List<CMSRecordNote>	getRecordNotes(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	Get a paginated list of CMSRecordNotes
List<CMSSingleRecordNote>	getRecordNotesForPi(String pi, boolean displayedNotesOnly)	Get all CMSRecordNotes for the given pi
RecurringTaskTrigger	getRecurringTaskTrigger(Long id)
RecurringTaskTrigger	getRecurringTaskTriggerForTask(TaskType task)
List<RecurringTaskTrigger>	getRecurringTaskTriggers()
List<CMSNavigationItem>	getRelatedNavItem(CMSPage page)	getRelatedNavItem.
Role	getRole(long id)	getRole.
Role	getRole(String name)	getRole.
long	getRoleCount(Map<String,String> filters)	getRoleCount.
List<Role>	getRoles(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getRoles.
Search	getSearch(long id)	getSearch.
long	getSearchCount(User owner, Map<String,String> filters)	getSearchCount.
List<Search>	getSearches(User owner)	getSearches.
List<Search>	getSearches(User owner, int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getSearches.
CMSSlider	getSlider(Long id)
List<CMSStaticPage>	getStaticPageForCMSPage(CMSPage page)	getStaticPageForCMSPage.
Optional<CMSStaticPage>	getStaticPageForTypeType(PageType pageType)	getStaticPageForTypeType.
TermsOfUse	getTermsOfUse()
ThemeConfiguration	getTheme(String name)
long	getTotalAnnotationCount()
List<TranskribusJob>	getTranskribusJobs(String pi, String transkribusUserId, JobStatus status)	getTranskribusJobs.
List<UploadJob>	getUploadJobsForCreatorId(Long creatorId)
List<UploadJob>	getUploadJobsWithStatus(JobStatus status)
DailySessionUsageStatistics	getUsageStatistics(LocalDate date)
List<DailySessionUsageStatistics>	getUsageStatistics(LocalDate start, LocalDate end)
User	getUser(long id)	getUser.
User	getUserByEmail(String email)	getUserByEmail.
User	getUserByNickname(String nickname)	getUserByNickname.
User	getUserByOpenId(String identifier)	getUserByOpenId.
long	getUserCount(Map<String,String> filters)	getUserCount.
UserGroup	getUserGroup(long id)	getUserGroup.
UserGroup	getUserGroup(String name)	getUserGroup.
long	getUserGroupCount(Map<String,String> filters)	getUserGroupCount.
List<UserGroup>	getUserGroups(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getUserGroups.
List<UserGroup>	getUserGroups(User owner)	getUserGroups.
long	getUserRoleCount(UserGroup userGroup, User user, Role role)	getUserRoleCount.
List<UserRole>	getUserRoles(UserGroup userGroup, User user, Role role)	getUserRoles.
List<User>	getUsers(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getUsers.
List<User>	getUsersByPropertyValue(String propertyName, String propertyValue)
ViewerMessage	getViewerMessage(Long id)
ViewerMessage	getViewerMessageByMessageID(String id)
long	getViewerMessageCount(Map<String,String> filters)	getViewerMessageCount.
List<ViewerMessage>	getViewerMessages(int first, int pageSize, String sortField, boolean descending, Map<String,String> filters)	getViewerMessages.
void	handleException(jakarta.persistence.EntityManager em)	Handling of exceptions occurred during commitTransaction(EntityManager) Usually calls EntityTransaction.rollback() on the current transaction of the given EntityManager
void	handleException(jakarta.persistence.EntityTransaction et)	Handling of exceptions occurred during commitTransaction(EntityTransaction).
boolean	isCMSPagesForRecordHaveUpdates(String pi, CMSCategory category, LocalDateTime fromDate, LocalDateTime toDate)	isCMSPagesForRecordHaveUpdates.
boolean	removeCMSPageTemplate(CMSPageTemplate template)
boolean	resetUserAgreementsToTermsOfUse()
boolean	saveClientApplication(ClientApplication client)
boolean	saveCookieBanner(CookieBanner banner)
boolean	saveDisclaimer(Disclaimer disclaimer)
boolean	saveTermsOfUse(TermsOfUse tou)
void	shutdown()	shutdown.
jakarta.persistence.EntityTransaction	startTransaction(jakarta.persistence.EntityManager em)	Call getTransaction() on the given EntityManager and then begin() on the transaction
boolean	tableExists(String tableName)	tableExists.
boolean	updateAnnotation(CrowdsourcingAnnotation annotation)	updateAnnotation.
boolean	updateBookmarkList(BookmarkList bookmarkList)	updateBookmarkList.
boolean	updateCampaign(Campaign campaign)	updateCampaign.
boolean	updateCategory(CMSCategory category)	updateCategory.
boolean	updateCMSCollection(CMSCollection collection)	updateCMSCollection.
boolean	updateCMSMediaItem(CMSMediaItem item)	updateCMSMediaItem.
boolean	updateCMSNavigationItem(CMSNavigationItem item)	updateCMSNavigationItem.
boolean	updateCMSPage(CMSPage page)	updateCMSPage.
boolean	updateCMSPageTemplate(CMSPageTemplate template)
boolean	updateComment(Comment comment)	updateComment.
boolean	updateCommentGroup(CommentGroup commentGroup)	updateCommentGroup.
boolean	updateCustomWidget(CustomSidebarWidget widget)
boolean	updatedCMSComponent(PersistentCMSComponent persistentCMSComponent)
boolean	updateDownloadJob(DownloadJob downloadJob)	updateDownloadJob.
boolean	updateDownloadTicket(DownloadTicket downloadTicket)	updateDownloadTicket.
boolean	updateGeoMap(GeoMap map)	Update the given GeoMap in the database
boolean	updateHighlight(HighlightData object)
boolean	updateIpRange(IpRange ipRange)	updateIpRange.
boolean	updateLicenseType(LicenseType licenseType)	updateLicenseType.
boolean	updateRecordNote(CMSRecordNote note)	Updates an existing CMSRecordNote
boolean	updateRecurringTaskTrigger(RecurringTaskTrigger trigger)
boolean	updateRole(Role role)	updateRole.
boolean	updateSearch(Search search)	updateSearch.
boolean	updateSlider(CMSSlider slider)
boolean	updateStaticPage(CMSStaticPage page)	updateStaticPage.
boolean	updateTheme(ThemeConfiguration theme)
boolean	updateTranskribusJob(TranskribusJob job)	updateTranskribusJob.
boolean	updateUploadJob(UploadJob uploadJob)	updateDownloadJob.
boolean	updateUsageStatistics(DailySessionUsageStatistics statistics)
boolean	updateUser(User user)	updateUser.
boolean	updateUserGroup(UserGroup userGroup)	updateUserGroup.
boolean	updateUserRole(UserRole userRole)	updateUserRole.
boolean	updateViewerMessage(ViewerMessage message)

Method Details

tableExists

boolean tableExists(String tableName)
             throws DAOException,
SQLException

tableExists.

Parameters:

tableName - a String object.

Returns:

a boolean.

Throws:

SQLException - if any.

DAOException

columnsExists

boolean columnsExists(String tableName,
 String columnName)
               throws DAOException,
SQLException

columnsExists.

Parameters:

tableName - a String object.

columnName - a String object.

Returns:

a boolean.

Throws:

SQLException - if any.

DAOException

getAllUsers

List<User> getAllUsers(boolean refresh)
                throws DAOException

getAllUsers.

Parameters:

refresh - a boolean.

Returns:

a List object.

Throws:

DAOException - if any.

getUserCount

long getUserCount(Map<String,String> filters)
           throws DAOException

getUserCount.

Parameters:

filters - a Map object.

Returns:

a long.

Throws:

DAOException - if any.

getUsers

List<User> getUsers(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
             throws DAOException

getUsers.

Parameters:

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

Returns:

a List object.

Throws:

DAOException - if any.

getUsersByPropertyValue

List<User> getUsersByPropertyValue(String propertyName,
 String propertyValue)
                            throws DAOException

Parameters:

propertyName -

propertyValue -

Returns:

List if users with matching property name/value pair

Throws:

DAOException

getUser

User getUser(long id)
      throws DAOException

getUser.

Parameters:

id - a long.

Returns:

a User object.

Throws:

DAOException - if any.

getUserByEmail

User getUserByEmail(String email)
             throws DAOException

getUserByEmail.

Parameters:

email - a String object.

Returns:

a User object.

Throws:

DAOException - if any.

getUserByOpenId

User getUserByOpenId(String identifier)
              throws DAOException

getUserByOpenId.

Parameters:

identifier - a String object.

Returns:

a User object.

Throws:

DAOException - if any.

getUserByNickname

User getUserByNickname(String nickname)
                throws DAOException

getUserByNickname.

Parameters:

nickname - a String object.

Returns:

a User object.

Throws:

DAOException - if any.

addUser

boolean addUser(User user)
         throws DAOException

addUser.

Parameters:

user - a User object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateUser

boolean updateUser(User user)
            throws DAOException

updateUser.

Parameters:

user - a User object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteUser

boolean deleteUser(User user)
            throws DAOException

deleteUser.

Parameters:

user - a User object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllUserGroups

List<UserGroup> getAllUserGroups()
                          throws DAOException

getAllUserGroups.

Returns:

a List object.

Throws:

DAOException - if any.

getUserGroupCount

long getUserGroupCount(Map<String,String> filters)
                throws DAOException

getUserGroupCount.

Parameters:

filters - a Map object.

Returns:

a long.

Throws:

DAOException - if any.

getUserGroups

List<UserGroup> getUserGroups(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                       throws DAOException

getUserGroups.

Parameters:

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

Returns:

a List object.

Throws:

DAOException - if any.

getUserGroups

List<UserGroup> getUserGroups(User owner)
                       throws DAOException

getUserGroups.

Parameters:

owner - a User object.

Returns:

a List object.

Throws:

DAOException - if any.

getUserGroup

UserGroup getUserGroup(long id)
                throws DAOException

getUserGroup.

Parameters:

id - a long.

Returns:

a UserGroup object.

Throws:

DAOException - if any.

getUserGroup

UserGroup getUserGroup(String name)
                throws DAOException

getUserGroup.

Parameters:

name - a String object.

Returns:

a UserGroup object.

Throws:

DAOException - if any.

addUserGroup

boolean addUserGroup(UserGroup userGroup)
              throws DAOException

addUserGroup.

Parameters:

userGroup - a UserGroup object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateUserGroup

boolean updateUserGroup(UserGroup userGroup)
                 throws DAOException

updateUserGroup.

Parameters:

userGroup - a UserGroup object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteUserGroup

boolean deleteUserGroup(UserGroup userGroup)
                 throws DAOException

deleteUserGroup.

Parameters:

userGroup - a UserGroup object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllBookmarkLists

List<BookmarkList> getAllBookmarkLists()
                                throws DAOException

getAllBookmarkLists.

Returns:

a List object.

Throws:

DAOException - if any.

getPublicBookmarkLists

List<BookmarkList> getPublicBookmarkLists()
                                   throws DAOException

getPublicBookmarkLists.

Returns:

a List object.

Throws:

DAOException - if any.

getBookmarkLists

List<BookmarkList> getBookmarkLists(User user)
                             throws DAOException

getBookmarkLists.

Parameters:

user - a User object.

Returns:

a List object.

Throws:

DAOException - if any.

getBookmarkListCount

long getBookmarkListCount(User user)
                   throws DAOException

Get number of bookmark lists owned by the given user

Parameters:

user -

Returns:

number of owned bookmark lists

Throws:

DAOException

getBookmarkList

BookmarkList getBookmarkList(long id)
                      throws DAOException

getBookmarkList.

Parameters:

id - a long.

Returns:

a BookmarkList object.

Throws:

DAOException - if any.

getBookmarkList

BookmarkList getBookmarkList(String name,
 User user)
                      throws DAOException

getBookmarkList.

Parameters:

name - a String object.

user - a User object.

Returns:

a BookmarkList object.

Throws:

DAOException - if any.

getBookmarkListByShareKey

BookmarkList getBookmarkListByShareKey(String shareKey)
                                throws DAOException

getBookmarkListByShareKey.

Parameters:

shareKey - a String object.

Returns:

a BookmarkList object.

Throws:

DAOException - if any.

addBookmarkList

boolean addBookmarkList(BookmarkList bookmarkList)
                 throws DAOException

addBookmarkList.

Parameters:

bookmarkList - a BookmarkList object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateBookmarkList

boolean updateBookmarkList(BookmarkList bookmarkList)
                    throws DAOException

updateBookmarkList.

Parameters:

bookmarkList - a BookmarkList object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteBookmarkList

boolean deleteBookmarkList(BookmarkList bookmarkList)
                    throws DAOException

deleteBookmarkList.

Parameters:

bookmarkList - a BookmarkList object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllRoles

List<Role> getAllRoles()
                throws DAOException

getAllRoles.

Returns:

a List object.

Throws:

DAOException - if any.

getRoleCount

long getRoleCount(Map<String,String> filters)
           throws DAOException

getRoleCount.

Parameters:

filters - a Map object.

Returns:

a long.

Throws:

DAOException - if any.

getRoles

List<Role> getRoles(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
             throws DAOException

getRoles.

Parameters:

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

Returns:

a List object.

Throws:

DAOException - if any.

getRole

Role getRole(long id)
      throws DAOException

getRole.

Parameters:

id - a long.

Returns:

a Role object.

Throws:

DAOException - if any.

getRole

Role getRole(String name)
      throws DAOException

getRole.

Parameters:

name - a String object.

Returns:

a Role object.

Throws:

DAOException - if any.

addRole

boolean addRole(Role role)
         throws DAOException

addRole.

Parameters:

role - a Role object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateRole

boolean updateRole(Role role)
            throws DAOException

updateRole.

Parameters:

role - a Role object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteRole

boolean deleteRole(Role role)
            throws DAOException

deleteRole.

Parameters:

role - a Role object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllUserRoles

List<UserRole> getAllUserRoles()
                        throws DAOException

getAllUserRoles.

Returns:

a List object.

Throws:

DAOException - if any.

getUserRoleCount

long getUserRoleCount(UserGroup userGroup,
 User user,
 Role role)
               throws DAOException

getUserRoleCount.

Parameters:

userGroup - a UserGroup object.

user - a User object.

role - a Role object.

Returns:

Row count

Throws:

DAOException - if any.

getUserRoles

List<UserRole> getUserRoles(UserGroup userGroup,
 User user,
 Role role)
                     throws DAOException

getUserRoles.

Parameters:

userGroup - a UserGroup object.

user - a User object.

role - a Role object.

Returns:

a List object.

Throws:

DAOException - if any.

addUserRole

boolean addUserRole(UserRole userRole)
             throws DAOException

addUserRole.

Parameters:

userRole - a UserRole object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateUserRole

boolean updateUserRole(UserRole userRole)
                throws DAOException

updateUserRole.

Parameters:

userRole - a UserRole object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteUserRole

boolean deleteUserRole(UserRole userRole)
                throws DAOException

deleteUserRole.

Parameters:

userRole - a UserRole object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllLicenseTypes

List<LicenseType> getAllLicenseTypes()
                              throws DAOException

getAllLicenseTypes.

Returns:

a List object.

Throws:

DAOException - if any.

getLicenseTypeCount

long getLicenseTypeCount(Map<String,String> filters)
                  throws DAOException

getLicenseTypeCount.

Parameters:

filters - a Map object.

Returns:

a long.

Throws:

DAOException - if any.

getCoreLicenseTypeCount

long getCoreLicenseTypeCount(Map<String,String> filters)
                      throws DAOException

getCoreLicenseTypeCount.

Parameters:

filters - a Map object.

Returns:

a long.

Throws:

DAOException - if any.

getRecordLicenseTypes

List<LicenseType> getRecordLicenseTypes()
                                 throws DAOException

getRecordLicenseTypes.

Returns:

a List object.

Throws:

DAOException - if any.

getLicenseTypes

List<LicenseType> getLicenseTypes(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                           throws DAOException

getLicenseTypes.

Parameters:

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

Returns:

a List object.

Throws:

DAOException - if any.

getCoreLicenseTypes

List<LicenseType> getCoreLicenseTypes(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                               throws DAOException

getCoreLicenseTypes.

Parameters:

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

Returns:

a List object.

Throws:

DAOException - if any.

getLicenseType

LicenseType getLicenseType(long id)
                    throws DAOException

getLicenseType.

Parameters:

id - a long.

Returns:

a LicenseType object.

Throws:

DAOException - if any.

getLicenseType

LicenseType getLicenseType(String name)
                    throws DAOException

getLicenseType.

Parameters:

name - a String object.

Returns:

a LicenseType object.

Throws:

DAOException - if any.

getLicenseTypes

List<LicenseType> getLicenseTypes(List<String> names)
                           throws DAOException

Returns all license types that match the given name list.

Parameters:

names -

Returns:

a LicenseType object.

Throws:

DAOException - in case of errors

getOverridingLicenseType

List<LicenseType> getOverridingLicenseType(LicenseType licenseType)
                                    throws DAOException

Parameters:

licenseType -

Returns:

List of license types overriding given licenseType

Throws:

DAOException

addLicenseType

boolean addLicenseType(LicenseType licenseType)
                throws DAOException

addLicenseType.

Parameters:

licenseType - a LicenseType object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateLicenseType

boolean updateLicenseType(LicenseType licenseType)
                   throws DAOException

updateLicenseType.

Parameters:

licenseType - a LicenseType object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteLicenseType

boolean deleteLicenseType(LicenseType licenseType)
                   throws DAOException

deleteLicenseType.

Parameters:

licenseType - a LicenseType object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllLicenses

List<License> getAllLicenses()
                      throws DAOException

getAllLicenses.

Returns:

a List object.

Throws:

DAOException - if any.

getLicense

License getLicense(Long id)
            throws DAOException

getLicense.

Parameters:

id - a long.

Returns:

a io.goobi.viewer.model.security.getLicense object.

Throws:

DAOException - if any.

getLicenses

List<License> getLicenses(LicenseType licenseType)
                   throws DAOException

Parameters:

licenseType -

Returns:

List of LicenseExceptions of the given licenseType

Throws:

DAOException

getLicenseCount

long getLicenseCount(LicenseType licenseType)
              throws DAOException

Returns the number of licenses that use the given license type.

Parameters:

licenseType -

Returns:

Number of existing Licenses of the given licenseType

Throws:

DAOException

getDownloadTicket

DownloadTicket getDownloadTicket(Long id)
                          throws DAOException

Parameters:

id -

Returns:

DownloadTicket with the given id

Throws:

DAOException

getDownloadTicketByPasswordHash

DownloadTicket getDownloadTicketByPasswordHash(String passwordHash)
                                        throws DAOException

Parameters:

passwordHash -

Returns:

DownloadTicket with the given passwordHash

Throws:

DAOException

getActiveDownloadTicketCount

long getActiveDownloadTicketCount(Map<String,String> filters)
                           throws DAOException

getActiveDownloadTicketCount.

Parameters:

filters - Selected filters

Returns:

Number of found rows

Throws:

DAOException - if any.

getActiveDownloadTickets

List<DownloadTicket> getActiveDownloadTickets(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                                       throws DAOException

getActiveDownloadTickets.

Parameters:

first - First row index

pageSize - Number of rows

sortField - a String object.

descending - true if descending order requested; false otherwise

filters - Selected filters

Returns:

a List object.

Throws:

DAOException - if any.

getDownloadTicketRequests

List<DownloadTicket> getDownloadTicketRequests()
                                        throws DAOException

Returns:

DownloadTickets with the requested status

Throws:

DAOException

addDownloadTicket

boolean addDownloadTicket(DownloadTicket downloadTicket)
                   throws DAOException

addDownloadTicket.

Parameters:

downloadTicket - a DownloadTicket object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateDownloadTicket

boolean updateDownloadTicket(DownloadTicket downloadTicket)
                      throws DAOException

updateDownloadTicket.

Parameters:

downloadTicket - a DownloadTicket object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteDownloadTicket

boolean deleteDownloadTicket(DownloadTicket downloadTicket)
                      throws DAOException

deleteDownloadTicket.

Parameters:

downloadTicket - a DownloadTicket object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllIpRanges

List<IpRange> getAllIpRanges()
                      throws DAOException

getAllIpRanges.

Returns:

a List object.

Throws:

DAOException - if any.

getIpRangeCount

long getIpRangeCount(Map<String,String> filters)
              throws DAOException

getIpRangeCount.

Parameters:

filters - a Map object.

Returns:

a long.

Throws:

DAOException - if any.

getIpRanges

List<IpRange> getIpRanges(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                   throws DAOException

getIpRanges.

Parameters:

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

Returns:

a List object.

Throws:

DAOException - if any.

getIpRange

IpRange getIpRange(long id)
            throws DAOException

getIpRange.

Parameters:

id - a long.

Returns:

a IpRange object.

Throws:

DAOException - if any.

getIpRange

IpRange getIpRange(String name)
            throws DAOException

getIpRange.

Parameters:

name - a String object.

Returns:

a IpRange object.

Throws:

DAOException - if any.

addIpRange

boolean addIpRange(IpRange ipRange)
            throws DAOException

addIpRange.

Parameters:

ipRange - a IpRange object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateIpRange

boolean updateIpRange(IpRange ipRange)
               throws DAOException

updateIpRange.

Parameters:

ipRange - a IpRange object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteIpRange

boolean deleteIpRange(IpRange ipRange)
               throws DAOException

deleteIpRange.

Parameters:

ipRange - a IpRange object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllCommentGroups

List<CommentGroup> getAllCommentGroups()
                                throws DAOException

Returns:

All existing CommentGroups

Throws:

DAOException

getCommentGroupUnfiltered

CommentGroup getCommentGroupUnfiltered()
                                throws DAOException

Returns:

CommentGroup

Throws:

DAOException

getCommentGroup

CommentGroup getCommentGroup(long id)
                      throws DAOException

getCommentGroup.

Parameters:

id - a long.

Returns:

a CommentGroup object.

Throws:

DAOException - if any.

addCommentGroup

boolean addCommentGroup(CommentGroup commentGroup)
                 throws DAOException

addCommentGroup.

Parameters:

commentGroup - a CommentGroup object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateCommentGroup

boolean updateCommentGroup(CommentGroup commentGroup)
                    throws DAOException

updateCommentGroup.

Parameters:

commentGroup - a CommentGroup object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteCommentGroup

boolean deleteCommentGroup(CommentGroup commentGroup)
                    throws DAOException

deleteCommentGroup.

Parameters:

commentGroup - a CommentGroup object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllComments

List<Comment> getAllComments()
                      throws DAOException

getAllComments.

Returns:

a List object.

Throws:

DAOException - if any.

getCommentCount

long getCommentCount(Map<String,String> filters,
 User owner,
 Set<String> targetPIs)
              throws DAOException

getCommentCount.

Parameters:

filters - a Map object.

owner -

targetPIs -

Returns:

Number of rows that match the criteria

Throws:

DAOException - if any.

getComments

List<Comment> getComments(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters,
 Set<String> targetPIs)
                   throws DAOException

getComments.

Parameters:

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

targetPIs -

Returns:

a List object.

Throws:

DAOException - if any.

getCommentsOfUser

List<Comment> getCommentsOfUser(User user,
 int maxResults,
 String sortField,
 boolean descending)
                         throws DAOException

Get Comments created by a specific user

Parameters:

user - the creator/owner of the comment

maxResults - maximum number of results to return

sortField - class field to sort results by

descending - set to "true" to sort descending

Returns:

A list of at most maxResults comments.

Throws:

DAOException

getCommentsForPage

List<Comment> getCommentsForPage(String pi,
 int page)
                          throws DAOException

getCommentsForPage.

Parameters:

pi - a String object.

page - a int.

Returns:

a List object.

Throws:

DAOException - if any.

getCommentsForWork

List<Comment> getCommentsForWork(String pi)
                          throws DAOException

getCommentsForWork.

Parameters:

pi - a String object.

Returns:

a List object.

Throws:

DAOException - if any.

getComment

Comment getComment(long id)
            throws DAOException

getComment.

Parameters:

id - a long.

Returns:

a Comment object.

Throws:

DAOException - if any.

addComment

boolean addComment(Comment comment)
            throws DAOException

addComment.

Parameters:

comment - a Comment object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateComment

boolean updateComment(Comment comment)
               throws DAOException

updateComment.

Parameters:

comment - a Comment object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteComment

boolean deleteComment(Comment comment)
               throws DAOException

deleteComment.

Parameters:

comment - a Comment object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteComments

int deleteComments(String pi,
 User owner)
            throws DAOException

Parameters:

pi - Record identifier

owner - Comment creator

Returns:

Number of affected rows

Throws:

DAOException - if any.

changeCommentsOwner

int changeCommentsOwner(User fromUser,
 User toUser)
                 throws DAOException

Changes ownership of all comments from fromUser to toUser.

Parameters:

fromUser -

toUser -

Returns:

Number of updated Comments

Throws:

DAOException - if any.

getAllSearches

List<Search> getAllSearches()
                     throws DAOException

getAllSearches.

Returns:

a List object.

Throws:

DAOException - if any.

getSearchCount

long getSearchCount(User owner,
 Map<String,String> filters)
             throws DAOException

getSearchCount.

Parameters:

owner - a User object.

filters - a Map object.

Returns:

a long.

Throws:

DAOException - if any.

getSearches

List<Search> getSearches(User owner,
 int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                  throws DAOException

getSearches.

Parameters:

owner - a User object.

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

Returns:

a List object.

Throws:

DAOException - if any.

getSearches

List<Search> getSearches(User owner)
                  throws DAOException

getSearches.

Parameters:

owner - a User object.

Returns:

a List object.

Throws:

DAOException - if any.

getSearch

Search getSearch(long id)
          throws DAOException

getSearch.

Parameters:

id - a long.

Returns:

a Search object.

Throws:

DAOException - if any.

addSearch

boolean addSearch(Search search)
           throws DAOException

addSearch.

Parameters:

search - a Search object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateSearch

boolean updateSearch(Search search)
              throws DAOException

updateSearch.

Parameters:

search - a Search object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteSearch

boolean deleteSearch(Search search)
              throws DAOException

deleteSearch.

Parameters:

search - a Search object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllDownloadJobs

List<DownloadJob> getAllDownloadJobs()
                              throws DAOException

getAllDownloadJobs.

Returns:

a List object.

Throws:

DAOException - if any.

getDownloadJobsForPi

List<DownloadJob> getDownloadJobsForPi(String pi)
                                throws DAOException

getDownloadJobsForPi.

Parameters:

pi - Record identifier

Returns:

List of DownloadJobs for given record identfier

Throws:

DAOException

getDownloadJob

DownloadJob getDownloadJob(long id)
                    throws DAOException

getDownloadJob.

Parameters:

id - a long.

Returns:

a DownloadJob object.

Throws:

DAOException - if any.

getDownloadJobByIdentifier

DownloadJob getDownloadJobByIdentifier(String identifier)
                                throws DAOException

getDownloadJobByIdentifier.

Parameters:

identifier - a String object.

Returns:

a DownloadJob object.

Throws:

DAOException - if any.

getDownloadJobByMetadata

DownloadJob getDownloadJobByMetadata(String type,
 String pi,
 String logId)
                              throws DAOException

getDownloadJobByMetadata.

Parameters:

type - a String object.

pi - a String object.

logId - a String object.

Returns:

a DownloadJob object.

Throws:

DAOException - if any.

addDownloadJob

boolean addDownloadJob(DownloadJob downloadJob)
                throws DAOException

addDownloadJob.

Parameters:

downloadJob - a DownloadJob object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateDownloadJob

boolean updateDownloadJob(DownloadJob downloadJob)
                   throws DAOException

updateDownloadJob.

Parameters:

downloadJob - a DownloadJob object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteDownloadJob

boolean deleteDownloadJob(DownloadJob downloadJob)
                   throws DAOException

deleteDownloadJob.

Parameters:

downloadJob - a DownloadJob object.

Returns:

a boolean.

Throws:

DAOException - if any.

getUploadJobsWithStatus

List<UploadJob> getUploadJobsWithStatus(JobStatus status)
                                 throws DAOException

Parameters:

status - JobStatus

Returns:

List of UploadJobs with given status

Throws:

DAOException

getUploadJobsForCreatorId

List<UploadJob> getUploadJobsForCreatorId(Long creatorId)
                                   throws DAOException

Parameters:

creatorId - User id of the creator

Returns:

UploadJobs belonging to user with given ID

Throws:

DAOException - if any.

addUploadJob

boolean addUploadJob(UploadJob uploadJob)
              throws DAOException

addDownloadJob.

Parameters:

uploadJob - a DownloadJob object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateUploadJob

boolean updateUploadJob(UploadJob uploadJob)
                 throws DAOException

updateDownloadJob.

Parameters:

uploadJob - a DownloadJob object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteUploadJob

boolean deleteUploadJob(UploadJob uploadJob)
                 throws DAOException

deleteDownloadJob.

Parameters:

uploadJob - a DownloadJob object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllCMSPages

List<CMSPage> getAllCMSPages()
                      throws DAOException

getAllCMSPages.

Returns:

a List object.

Throws:

DAOException - if any.

getCmsPageForStaticPage

CMSPage getCmsPageForStaticPage(String pageName)
                         throws DAOException

getCmsPageForStaticPage.

Parameters:

pageName - a String object.

Returns:

a CMSPage object.

Throws:

DAOException - if any.

getCMSPageCount

long getCMSPageCount(Map<String,String> filters,
 List<Long> allowedTemplates,
 List<String> allowedSubthemes,
 List<String> allowedCategories)
              throws DAOException

getCMSPageCount.

Parameters:

filters - a Map object.

allowedTemplates - a List object.

allowedSubthemes - a List object.

allowedCategories - a List object.

Returns:

a long.

Throws:

DAOException - if any.

getCMSPages

List<CMSPage> getCMSPages(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters,
 List<Long> allowedTemplates,
 List<String> allowedSubthemes,
 List<String> allowedCategories)
                   throws DAOException

getCMSPages.

Parameters:

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

allowedTemplates - a List object.

allowedSubthemes - a List object.

allowedCategories - a List object.

Returns:

a List object.

Throws:

DAOException - if any.

getCMSPagesByCategory

List<CMSPage> getCMSPagesByCategory(CMSCategory category)
                             throws DAOException

getCMSPagesByCategory.

Parameters:

category - a CMSCategory object.

Returns:

a List object.

Throws:

DAOException - if any.

getCMSPagesForRecord

List<CMSPage> getCMSPagesForRecord(String pi,
 CMSCategory category)
                            throws DAOException

getCMSPagesForRecord.

Parameters:

pi - a String object.

category - a CMSCategory object.

Returns:

a List object.

Throws:

DAOException - if any.

getCMSPagesWithRelatedPi

List<CMSPage> getCMSPagesWithRelatedPi(int first,
 int pageSize,
 LocalDateTime fromDate,
 LocalDateTime toDate)
                                throws DAOException

getCMSPagesWithRelatedPi.

Parameters:

first - a int.

pageSize - a int.

fromDate - a LocalDateTime object.

toDate - a LocalDateTime object.

Returns:

a List object.

Throws:

DAOException - if any.

isCMSPagesForRecordHaveUpdates

boolean isCMSPagesForRecordHaveUpdates(String pi,
 CMSCategory category,
 LocalDateTime fromDate,
 LocalDateTime toDate)
                                throws DAOException

isCMSPagesForRecordHaveUpdates.

Parameters:

pi - a String object.

category - a CMSCategory object.

fromDate - a LocalDateTime object.

toDate - a LocalDateTime object.

Returns:

a boolean.

Throws:

DAOException - if any.

getCMSPageWithRelatedPiCount

long getCMSPageWithRelatedPiCount(LocalDateTime fromDate,
 LocalDateTime toDate)
                           throws DAOException

getCMSPageWithRelatedPiCount.

Parameters:

fromDate - a LocalDateTime object.

toDate - a LocalDateTime object.

Returns:

a long.

Throws:

DAOException - if any.

getCMSPageDefaultViewForRecord

CMSPage getCMSPageDefaultViewForRecord(String pi)
                                throws DAOException

Parameters:

pi - Record identifier

Returns:

CMSPage

Throws:

DAOException

getCMSPage

CMSPage getCMSPage(long id)
            throws DAOException

getCMSPage.

Parameters:

id - a long.

Returns:

a CMSPage object.

Throws:

DAOException - if any.

addCMSPage

boolean addCMSPage(CMSPage page)
            throws DAOException

addCMSPage.

Parameters:

page - a CMSPage object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateCMSPage

boolean updateCMSPage(CMSPage page)
               throws DAOException

updateCMSPage.

Parameters:

page - a CMSPage object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteCMSPage

boolean deleteCMSPage(CMSPage page)
               throws DAOException

deleteCMSPage.

Parameters:

page - a CMSPage object.

Returns:

a boolean.

Throws:

DAOException - if any.

getAllCMSPageTemplates

List<CMSPageTemplate> getAllCMSPageTemplates()
                                      throws DAOException

Throws:

DAOException

getCMSPageTemplate

CMSPageTemplate getCMSPageTemplate(Long id)
                            throws DAOException

Throws:

DAOException

addCMSPageTemplate

boolean addCMSPageTemplate(CMSPageTemplate template)
                    throws DAOException

Throws:

DAOException

updateCMSPageTemplate

boolean updateCMSPageTemplate(CMSPageTemplate template)
                       throws DAOException

Throws:

DAOException

removeCMSPageTemplate

boolean removeCMSPageTemplate(CMSPageTemplate template)
                       throws DAOException

Throws:

DAOException

getAllCMSMediaItems

List<CMSMediaItem> getAllCMSMediaItems()
                                throws DAOException

getAllCMSMediaItems.

Returns:

a List object.

Throws:

DAOException - if any.

getAllCMSCollectionItems

List<CMSMediaItem> getAllCMSCollectionItems()
                                     throws DAOException

getAllCMSCollectionItems.

Returns:

a List object.

Throws:

DAOException - if any.

getCMSMediaItem

CMSMediaItem getCMSMediaItem(long id)
                      throws DAOException

getCMSMediaItem.

Parameters:

id - a long.

Returns:

a CMSMediaItem object.

Throws:

DAOException - if any.

getCMSMediaItemByFilename

CMSMediaItem getCMSMediaItemByFilename(String string)
                                throws DAOException

getCMSMediaItemByFilename.

Parameters:

string - a String object.

Returns:

a CMSMediaItem object.

Throws:

DAOException - if any.

addCMSMediaItem

boolean addCMSMediaItem(CMSMediaItem item)
                 throws DAOException

addCMSMediaItem.

Parameters:

item - a CMSMediaItem object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateCMSMediaItem

boolean updateCMSMediaItem(CMSMediaItem item)
                    throws DAOException

updateCMSMediaItem.

Parameters:

item - a CMSMediaItem object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteCMSMediaItem

boolean deleteCMSMediaItem(CMSMediaItem item)
                    throws DAOException

deleteCMSMediaItem.

Parameters:

item - a CMSMediaItem object.

Returns:

a boolean.

Throws:

DAOException - if any.

getCMSMediaItemsByCategory

List<CMSMediaItem> getCMSMediaItemsByCategory(CMSCategory category)
                                       throws DAOException

Get a list of all CMSMediaItems which contain the given category

Parameters:

category -

Returns:

all containing cmsPages

Throws:

DAOException

getAllTopCMSNavigationItems

List<CMSNavigationItem> getAllTopCMSNavigationItems()
                                             throws DAOException

getAllTopCMSNavigationItems.

Returns:

a List object.

Throws:

DAOException - if any.

getCMSNavigationItem

CMSNavigationItem getCMSNavigationItem(long id)
                                throws DAOException

getCMSNavigationItem.

Parameters:

id - a long.

Returns:

a io.goobi.viewer.model.cms.navigation.CMSNavigationItem object.

Throws:

DAOException - if any.

addCMSNavigationItem

boolean addCMSNavigationItem(CMSNavigationItem item)
                      throws DAOException

addCMSNavigationItem.

Parameters:

item - a io.goobi.viewer.model.cms.navigation.CMSNavigationItem object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateCMSNavigationItem

boolean updateCMSNavigationItem(CMSNavigationItem item)
                         throws DAOException

updateCMSNavigationItem.

Parameters:

item - a io.goobi.viewer.model.cms.navigation.CMSNavigationItem object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteCMSNavigationItem

boolean deleteCMSNavigationItem(CMSNavigationItem item)
                         throws DAOException

deleteCMSNavigationItem.

Parameters:

item - a io.goobi.viewer.model.cms.navigation.CMSNavigationItem object.

Returns:

a boolean.

Throws:

DAOException - if any.

getRelatedNavItem

List<CMSNavigationItem> getRelatedNavItem(CMSPage page)
                                   throws DAOException

getRelatedNavItem.

Parameters:

page - a CMSPage object.

Returns:

a List object.

Throws:

DAOException - if any.

getAllStaticPages

List<CMSStaticPage> getAllStaticPages()
                               throws DAOException

getAllStaticPages.

Returns:

a List object.

Throws:

DAOException - if any.

addStaticPage

boolean addStaticPage(CMSStaticPage page)
               throws DAOException

addStaticPage.

Parameters:

page - a CMSStaticPage object.

Returns:

true if page added successfully; false otherwise

Throws:

DAOException - if any.

updateStaticPage

boolean updateStaticPage(CMSStaticPage page)
                  throws DAOException

updateStaticPage.

Parameters:

page - a CMSStaticPage object.

Returns:

true if page updated successfully; false otherwise

Throws:

DAOException - if any.

deleteStaticPage

boolean deleteStaticPage(CMSStaticPage page)
                  throws DAOException

deleteStaticPage.

Parameters:

page - a CMSStaticPage object.

Returns:

true if page deleted successfully; false otherwise

Throws:

DAOException - if any.

getStaticPageForCMSPage

List<CMSStaticPage> getStaticPageForCMSPage(CMSPage page)
                                     throws DAOException

getStaticPageForCMSPage.

Parameters:

page - a CMSPage object.

Returns:

a List object.

Throws:

DAOException - if any.

getStaticPageForTypeType

Optional<CMSStaticPage> getStaticPageForTypeType(PageType pageType)
                                          throws DAOException

getStaticPageForTypeType.

Parameters:

pageType - a PageType object.

Returns:

a Optional object.

Throws:

DAOException - if any.

getAllCategories

List<CMSCategory> getAllCategories()
                            throws DAOException

getAllCategories.

Returns:

a List object.

Throws:

DAOException - if any.

getCountPagesUsingCategory

long getCountPagesUsingCategory(CMSCategory category)
                         throws DAOException

Parameters:

category -

Returns:

Number of existing CMS pages having the given category

Throws:

DAOException

getCountMediaItemsUsingCategory

long getCountMediaItemsUsingCategory(CMSCategory category)
                              throws DAOException

Parameters:

category -

Returns:

Number of existing CMS media items having the given category

Throws:

DAOException

addCategory

boolean addCategory(CMSCategory category)
             throws DAOException

addCategory.

Parameters:

category - a CMSCategory object.

Returns:

true if category added successfully; false otherwise

Throws:

DAOException - if any.

updateCategory

boolean updateCategory(CMSCategory category)
                throws DAOException

updateCategory.

Parameters:

category - a CMSCategory object.

Returns:

true if category updated successfully; false otherwise

Throws:

DAOException - if any.

deleteCategory

boolean deleteCategory(CMSCategory category)
                throws DAOException

deleteCategory.

Parameters:

category - a CMSCategory object.

Returns:

true if category deleted successfully; false otherwise

Throws:

DAOException - if any.

getCategoryByName

CMSCategory getCategoryByName(String name)
                       throws DAOException

getCategoryByName.

Parameters:

name - a String object.

Returns:

a CMSCategory object.

Throws:

DAOException - if any.

getCategory

CMSCategory getCategory(Long id)
                 throws DAOException

getCategory.

Parameters:

id - a Long object.

Returns:

a CMSCategory object.

Throws:

DAOException - if any.

getAllTranskribusJobs

List<TranskribusJob> getAllTranskribusJobs()
                                    throws DAOException

getAllTranskribusJobs.

Returns:

a List object.

Throws:

DAOException - if any.

getTranskribusJobs

List<TranskribusJob> getTranskribusJobs(String pi,
 String transkribusUserId,
 JobStatus status)
                                 throws DAOException

getTranskribusJobs.

Parameters:

pi - a String object.

transkribusUserId - a String object.

status - a io.goobi.viewer.model.transkribus.TranskribusJob.JobStatus object.

Returns:

a List object.

Throws:

DAOException - if any.

addTranskribusJob

boolean addTranskribusJob(TranskribusJob job)
                   throws DAOException

addTranskribusJob.

Parameters:

job - a TranskribusJob object.

Returns:

true if job added successfully; false otherwise

Throws:

DAOException - if any.

updateTranskribusJob

boolean updateTranskribusJob(TranskribusJob job)
                      throws DAOException

updateTranskribusJob.

Parameters:

job - a TranskribusJob object.

Returns:

true if job updated successfully; false otherwise

Throws:

DAOException - if any.

deleteTranskribusJob

boolean deleteTranskribusJob(TranskribusJob job)
                      throws DAOException

deleteTranskribusJob.

Parameters:

job - a TranskribusJob object.

Returns:

true if job deleted successfully; false otherwise

Throws:

DAOException - if any.

getAllCampaigns

List<Campaign> getAllCampaigns()
                        throws DAOException

getAllCampaigns.

Returns:

a List object.

Throws:

DAOException - if any.

getCampaignCount

long getCampaignCount(Map<String,String> filters)
               throws DAOException

getCampaignCount.

Parameters:

filters - a Map object.

Returns:

a long.

Throws:

DAOException - if any.

getCampaign

Campaign getCampaign(Long id)
              throws DAOException

getCampaign.

Parameters:

id - a Long object.

Returns:

a Campaign object.

Throws:

DAOException - if any.

getQuestion

Question getQuestion(Long id)
              throws DAOException

getQuestion.

Parameters:

id - a Long object.

Returns:

a Question object.

Throws:

DAOException - if any.

getCampaigns

List<Campaign> getCampaigns(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                     throws DAOException

getCampaigns.

Parameters:

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

Returns:

a List object.

Throws:

DAOException - if any.

getCampaignStatisticsForRecord

List<CampaignRecordStatistic> getCampaignStatisticsForRecord(String pi,
 CrowdsourcingStatus status)
                                                      throws DAOException

getCampaignStatisticsForRecord.

Parameters:

pi - a String object.

status - a io.goobi.viewer.model.crowdsourcing.campaigns.CampaignRecordStatistic.CrowdsourcingStatus object.

Returns:

a List object.

Throws:

DAOException - if any.

getCampaignPageStatisticsForRecord

List<CampaignRecordPageStatistic> getCampaignPageStatisticsForRecord(String pi,
 CrowdsourcingStatus status)
                                                              throws DAOException

getCampaignPageStatisticsForRecord.

Parameters:

pi - a String object.

status - a io.goobi.viewer.model.crowdsourcing.campaigns.CampaignRecordStatistic.CrowdsourcingStatus object.

Returns:

a List object.

Throws:

DAOException - if any.

addCampaign

boolean addCampaign(Campaign campaign)
             throws DAOException

addCampaign.

Parameters:

campaign - a Campaign object.

Returns:

true if campaign added successfully; false otherwise

Throws:

DAOException - if any.

updateCampaign

boolean updateCampaign(Campaign campaign)
                throws DAOException

updateCampaign.

Parameters:

campaign - a Campaign object.

Returns:

true if campaign updated successfully; false otherwise

Throws:

DAOException - if any.

deleteCampaign

boolean deleteCampaign(Campaign campaign)
                throws DAOException

deleteCampaign.

Parameters:

campaign - a Campaign object.

Returns:

true if campaign deleted successfully; false otherwise

Throws:

DAOException - if any.

deleteCampaignStatisticsForUser

int deleteCampaignStatisticsForUser(User user)
                             throws DAOException

Deletes given user from the lists of annotators and reviewers an all campaign statistics.

Parameters:

user -

Returns:

Number of affected campaigns

Throws:

DAOException

changeCampaignStatisticContributors

int changeCampaignStatisticContributors(User fromUser,
 User toUser)
                                 throws DAOException

Replaced fromUser with toUser in the lists of annotators and reviewers an all campaign statistics.

Parameters:

fromUser -

toUser -

Returns:

Number of updated rows

Throws:

DAOException

checkAvailability

boolean checkAvailability()

Returns:

true if accessible; false otherwise

shutdown

void shutdown()

shutdown.

getPagesWithComments

List<Integer> getPagesWithComments(String pi)
                            throws DAOException

getPagesWithComments.

Parameters:

pi - a String object.

Returns:

a List object.

Throws:

DAOException - if any.

getCMSCollections

List<CMSCollection> getCMSCollections(String solrField)
                               throws DAOException

getCMSCollections.

Parameters:

solrField - a String object.

Returns:

a List object.

Throws:

DAOException - if any.

addCMSCollection

boolean addCMSCollection(CMSCollection collection)
                  throws DAOException

addCMSCollection.

Parameters:

collection - a CMSCollection object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateCMSCollection

boolean updateCMSCollection(CMSCollection collection)
                     throws DAOException

updateCMSCollection.

Parameters:

collection - a CMSCollection object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteCMSCollection

boolean deleteCMSCollection(CMSCollection collection)
                     throws DAOException

deleteCMSCollection.

Parameters:

collection - a CMSCollection object.

Returns:

a boolean.

Throws:

DAOException - if any.

getCMSCollection

CMSCollection getCMSCollection(String solrField,
 String solrFieldValue)
                        throws DAOException

getCMSCollection.

Parameters:

solrField - a String object.

solrFieldValue - a String object.

Returns:

a CMSCollection object.

Throws:

DAOException - if any.

getAnnotation

CrowdsourcingAnnotation getAnnotation(Long id)
                               throws DAOException

Annotations *

Parameters:

id - a Long object.

Returns:

a CrowdsourcingAnnotation object.

Throws:

DAOException - if any.

getAnnotationsForCampaign

List<CrowdsourcingAnnotation> getAnnotationsForCampaign(Campaign campaign)
                                                 throws DAOException

getAnnotationsForCampaign.

Parameters:

campaign - a Campaign object.

Returns:

a List object.

Throws:

DAOException - if any.

getAnnotationsForWork

List<CrowdsourcingAnnotation> getAnnotationsForWork(String pi)
                                             throws DAOException

getAnnotationsForWork.

Parameters:

pi - a String object.

Returns:

a List object.

Throws:

DAOException - if any.

getAnnotationCountForWork

long getAnnotationCountForWork(String pi)
                        throws DAOException

Parameters:

pi -

Returns:

Number of existing annotations for the given pi

Throws:

DAOException

getAnnotationsForCampaignAndWork

List<CrowdsourcingAnnotation> getAnnotationsForCampaignAndWork(Campaign campaign,
 String pi)
                                                        throws DAOException

getAnnotationsForCampaignAndWork.

Parameters:

campaign - a Campaign object.

pi - a String object.

Returns:

a List object.

Throws:

DAOException - if any.

getAnnotationsForTarget

List<CrowdsourcingAnnotation> getAnnotationsForTarget(String pi,
 Integer page)
                                               throws DAOException

getAnnotationsForTarget.

Parameters:

pi - a String object.

page - a Integer object.

Returns:

a List object.

Throws:

DAOException - if any.

getAnnotationsForTarget

List<CrowdsourcingAnnotation> getAnnotationsForTarget(String pi,
 Integer page,
 String motivation)
                                               throws DAOException

Throws:

DAOException

getAnnotationsForUserId

List<CrowdsourcingAnnotation> getAnnotationsForUserId(Long userId,
 Integer maxResults,
 String sortField,
 boolean descending)
                                               throws DAOException

Parameters:

userId -

maxResults -

sortField -

descending -

Returns:

List of CrowdsourcingAnnotations for the given userId

Throws:

DAOException

getAnnotations

List<CrowdsourcingAnnotation> getAnnotations(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                                      throws DAOException

getAnnotations.

Parameters:

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

Returns:

a List object.

Throws:

DAOException - if any.

getAnnotationCount

long getAnnotationCount(Map<String,String> filters)
                 throws DAOException

getAnnotationCount.

Parameters:

filters - a Map object.

Returns:

a long.

Throws:

DAOException - if any.

getAnnotationCountForTarget

long getAnnotationCountForTarget(String pi,
 Integer page)
                          throws DAOException

getAnnotationCountForTarget.

Parameters:

pi - a String object.

page - a Integer object.

Returns:

a long.

Throws:

DAOException - if any.

getAnnotationsForCampaignAndTarget

List<CrowdsourcingAnnotation> getAnnotationsForCampaignAndTarget(Campaign campaign,
 String pi,
 Integer page)
                                                          throws DAOException

getAnnotationsForCampaignAndTarget.

Parameters:

campaign - a Campaign object.

pi - a String object.

page - a Integer object.

Returns:

a List object.

Throws:

DAOException - if any.

addAnnotation

boolean addAnnotation(CrowdsourcingAnnotation annotation)
               throws DAOException

addAnnotation.

Parameters:

annotation - a CrowdsourcingAnnotation object.

Returns:

a boolean.

Throws:

DAOException - if any.

updateAnnotation

boolean updateAnnotation(CrowdsourcingAnnotation annotation)
                  throws DAOException

updateAnnotation.

Parameters:

annotation - a CrowdsourcingAnnotation object.

Returns:

a boolean.

Throws:

DAOException - if any.

deleteAnnotation

boolean deleteAnnotation(CrowdsourcingAnnotation annotation)
                  throws DAOException

deleteAnnotation.

Parameters:

annotation - a CrowdsourcingAnnotation object.

Returns:

a boolean.

Throws:

DAOException - if any.

getGeoMap

GeoMap getGeoMap(Long mapId)
          throws DAOException

Get the GeoMap of the given mapId

Parameters:

mapId -

Returns:

The GeoMap of the given id or else null

Throws:

DAOException

getAllGeoMaps

List<GeoMap> getAllGeoMaps()
                    throws DAOException

Get all GeoMaps in database

Returns:

A list of all stored GeoMaps

Throws:

DAOException

addGeoMap

boolean addGeoMap(GeoMap map)
           throws DAOException

Add the given map to the database if no map of the same id already exists

Parameters:

map -

Returns:

true if successful

Throws:

DAOException

updateGeoMap

boolean updateGeoMap(GeoMap map)
              throws DAOException

Update the given GeoMap in the database

Parameters:

map -

Returns:

true if successful

Throws:

DAOException

deleteGeoMap

boolean deleteGeoMap(GeoMap map)
              throws DAOException

Delete the given GeoMap from the database

Parameters:

map -

Returns:

true if successful

Throws:

DAOException

getPagesUsingMap

List<CMSPage> getPagesUsingMap(GeoMap map)
                        throws DAOException

Return a list of CMS-pages embedding the given map

Parameters:

map -

Returns:

List of CMSPages that use given map

Throws:

DAOException

getPagesUsingMapInSidebar

List<CMSPage> getPagesUsingMapInSidebar(GeoMap map)
                                 throws DAOException

Return a list of CMS-pages embedding the given map in a sidebar widget

Parameters:

map -

Returns:

List of CMSPages that use given map in sidebar

Throws:

DAOException

getCMSPagesForSubtheme

List<CMSPage> getCMSPagesForSubtheme(String subtheme)
                              throws DAOException

Parameters:

subtheme -

Returns:

List of CMSPages that use given subtheme

Throws:

DAOException

getRecordNotes

List<CMSRecordNote> getRecordNotes(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                            throws DAOException

Get a paginated list of CMSRecordNotes

Parameters:

first -

pageSize -

sortField -

descending -

filters -

Returns:

List of CMSPages that match the given filters

Throws:

DAOException

getRecordNotesForPi

List<CMSSingleRecordNote> getRecordNotesForPi(String pi,
 boolean displayedNotesOnly)
                                       throws DAOException

Get all CMSRecordNotes for the given pi

Parameters:

pi - The pi of the record.

displayedNotesOnly - set to true to only return notes with CMSRecordNote#isDisplayŃote() set to true

Returns:

List of CMSSingleRecordNotes for the given pi

Throws:

DAOException

getAllMultiRecordNotes

List<CMSMultiRecordNote> getAllMultiRecordNotes(boolean displayedNotesOnly)
                                         throws DAOException

Get all CMSMultiRecordNotes. To find notes relating to record, all notes must be check for matching query

Parameters:

displayedNotesOnly -

Returns:

List of all existing CMSSingleRecordNotes, optionaly filtered by displayed only

Throws:

DAOException

getAllRecordNotes

List<CMSRecordNote> getAllRecordNotes()
                               throws DAOException

Get all persisted CMSRecordNotes

Returns:

List of all existing CMSSingleRecordNotes

Throws:

DAOException

getRecordNote

CMSRecordNote getRecordNote(Long id)
                     throws DAOException

Get a CMSRecordNote by its id property

Parameters:

id -

Returns:

CMSSingleRecordNote with the given id

Throws:

DAOException

addRecordNote

boolean addRecordNote(CMSRecordNote note)
               throws DAOException

Persist a new CMSRecordNote.

Parameters:

note -

Returns:

true if note added successfully; false otherwise

Throws:

DAOException

updateRecordNote

boolean updateRecordNote(CMSRecordNote note)
                  throws DAOException

Updates an existing CMSRecordNote

Parameters:

note -

Returns:

true if note updated successfully; false otherwise

Throws:

DAOException

deleteRecordNote

boolean deleteRecordNote(CMSRecordNote note)
                  throws DAOException

Deletes an existing CMSRecordNote

Parameters:

note -

Returns:

true if note deleted successfully; false otherwise

Throws:

DAOException

saveTermsOfUse

boolean saveTermsOfUse(TermsOfUse tou)
                throws DAOException

Throws:

DAOException

getTermsOfUse

TermsOfUse getTermsOfUse()
                  throws DAOException

Throws:

DAOException

resetUserAgreementsToTermsOfUse

boolean resetUserAgreementsToTermsOfUse()
                                 throws DAOException

Throws:

DAOException

getAllSliders

List<CMSSlider> getAllSliders()
                       throws DAOException

Throws:

DAOException

getSlider

CMSSlider getSlider(Long id)
             throws DAOException

Throws:

DAOException

addSlider

boolean addSlider(CMSSlider slider)
           throws DAOException

Throws:

DAOException

updateSlider

boolean updateSlider(CMSSlider slider)
              throws DAOException

Throws:

DAOException

deleteSlider

boolean deleteSlider(CMSSlider slider)
              throws DAOException

Throws:

DAOException

getPagesUsingSlider

List<CMSPage> getPagesUsingSlider(CMSSlider slider)
                           throws DAOException

Throws:

DAOException

getConfiguredThemes

List<ThemeConfiguration> getConfiguredThemes()
                                      throws DAOException

Throws:

DAOException

getTheme

ThemeConfiguration getTheme(String name)
                     throws DAOException

Throws:

DAOException

addTheme

boolean addTheme(ThemeConfiguration theme)
          throws DAOException

Throws:

DAOException

updateTheme

boolean updateTheme(ThemeConfiguration theme)
             throws DAOException

Throws:

DAOException

deleteTheme

boolean deleteTheme(ThemeConfiguration theme)
             throws DAOException

Throws:

DAOException

getAnnotations

List<CrowdsourcingAnnotation> getAnnotations(int first,
 int pageSize,
 String sortField,
 boolean descending,
 String filterString,
 Map<String,Object> filterParams)
                                      throws DAOException

Parameters:

first -

pageSize -

sortField -

descending -

filterString -

filterParams -

Returns:

List of CrowdsourcingAnnotations matching given filters

Throws:

DAOException

getAllAnnotationsByMotivation

List<CrowdsourcingAnnotation> getAllAnnotationsByMotivation(String commenting)
                                                     throws DAOException

Parameters:

commenting -

Returns:

List of CrowdsourcingAnnotations matching given commenting

Throws:

DAOException

getAllAnnotations

List<CrowdsourcingAnnotation> getAllAnnotations(String sortField,
 boolean sortDescending)
                                         throws DAOException

Parameters:

sortField -

sortDescending -

Returns:

List of all existing CrowdsourcingAnnotations, optionally sorted by given sortField

Throws:

DAOException

getTotalAnnotationCount

long getTotalAnnotationCount()
                      throws DAOException

Returns:

Number of all existing CrowdsourcingAnnotations

Throws:

DAOException

getAllCustomWidgets

List<CustomSidebarWidget> getAllCustomWidgets()
                                       throws DAOException

Throws:

DAOException

getCustomWidget

CustomSidebarWidget getCustomWidget(Long id)
                             throws DAOException

Throws:

DAOException

addCustomWidget

boolean addCustomWidget(CustomSidebarWidget widget)
                 throws DAOException

Throws:

DAOException

updateCustomWidget

boolean updateCustomWidget(CustomSidebarWidget widget)
                    throws DAOException

Throws:

DAOException

deleteCustomWidget

boolean deleteCustomWidget(Long id)
                    throws DAOException

Throws:

DAOException

getPagesUsingWidget

List<CMSPage> getPagesUsingWidget(CustomSidebarWidget widget)
                           throws DAOException

Throws:

DAOException

getCookieBanner

CookieBanner getCookieBanner()
                      throws DAOException

Throws:

DAOException

saveCookieBanner

boolean saveCookieBanner(CookieBanner banner)
                  throws DAOException

Throws:

DAOException

getDisclaimer

Disclaimer getDisclaimer()
                  throws DAOException

Get the single stored Disclaimer. May return null if no disclaimer has been persisted yet

Returns:

the disclaimer or null

Throws:

DAOException

saveDisclaimer

boolean saveDisclaimer(Disclaimer disclaimer)
                throws DAOException

Throws:

DAOException

getNumRecordsWithComments

Long getNumRecordsWithComments(User user)
                        throws DAOException

Throws:

DAOException

getNativeQueryResults

List getNativeQueryResults(String query)
                    throws DAOException

Throws:

DAOException

executeUpdate

int executeUpdate(String string)
           throws DAOException

Throws:

DAOException

getAllClientApplications

List<ClientApplication> getAllClientApplications()
                                          throws DAOException

Throws:

DAOException

getClientApplication

ClientApplication getClientApplication(long id)
                                throws DAOException

Throws:

DAOException

saveClientApplication

boolean saveClientApplication(ClientApplication client)
                       throws DAOException

Throws:

DAOException

deleteClientApplication

boolean deleteClientApplication(long id)
                         throws DAOException

Throws:

DAOException

getClientApplicationByClientId

ClientApplication getClientApplicationByClientId(String clientId)
                                          throws DAOException

Throws:

DAOException

getAllUsageStatistics

List<DailySessionUsageStatistics> getAllUsageStatistics()
                                                 throws DAOException

Throws:

DAOException

getUsageStatistics

DailySessionUsageStatistics getUsageStatistics(LocalDate date)
                                        throws DAOException

Throws:

DAOException

getUsageStatistics

List<DailySessionUsageStatistics> getUsageStatistics(LocalDate start,
 LocalDate end)
                                              throws DAOException

Throws:

DAOException

addUsageStatistics

boolean addUsageStatistics(DailySessionUsageStatistics statistics)
                    throws DAOException

Throws:

DAOException

updateUsageStatistics

boolean updateUsageStatistics(DailySessionUsageStatistics statistics)
                       throws DAOException

Throws:

DAOException

deleteUsageStatistics

boolean deleteUsageStatistics(long id)
                       throws DAOException

Throws:

DAOException

deleteCMSComponent

boolean deleteCMSComponent(PersistentCMSComponent persistentCMSComponent)
                    throws DAOException

Throws:

DAOException

deleteCMSContent

boolean deleteCMSContent(CMSContent content)
                  throws DAOException

Throws:

DAOException

addCMSComponent

boolean addCMSComponent(PersistentCMSComponent persistentCMSComponent)
                 throws DAOException

Throws:

DAOException

updatedCMSComponent

boolean updatedCMSComponent(PersistentCMSComponent persistentCMSComponent)
                     throws DAOException

Throws:

DAOException

getCMSComponent

PersistentCMSComponent getCMSComponent(Long id)
                                throws DAOException

Throws:

DAOException

deleteViewerMessage

boolean deleteViewerMessage(ViewerMessage message)
                     throws DAOException

Throws:

DAOException

addViewerMessage

boolean addViewerMessage(ViewerMessage message)
                  throws DAOException

Throws:

DAOException

updateViewerMessage

boolean updateViewerMessage(ViewerMessage message)
                     throws DAOException

Throws:

DAOException

getViewerMessage

ViewerMessage getViewerMessage(Long id)
                        throws DAOException

Throws:

DAOException

getViewerMessageByMessageID

ViewerMessage getViewerMessageByMessageID(String id)
                                   throws DAOException

Throws:

DAOException

getViewerMessages

List<ViewerMessage> getViewerMessages(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                               throws DAOException

getViewerMessages.

Parameters:

first - a int.

pageSize - a int.

sortField - a String object.

descending - a boolean.

filters - a Map object.

Returns:

a List object.

Throws:

DAOException - if any.

getViewerMessageCount

long getViewerMessageCount(Map<String,String> filters)
                    throws DAOException

getViewerMessageCount.

Parameters:

filters - a Map object.

Returns:

a long.

Throws:

DAOException - if any.

getRecurringTaskTriggers

List<RecurringTaskTrigger> getRecurringTaskTriggers()
                                             throws DAOException

Throws:

DAOException

getRecurringTaskTrigger

RecurringTaskTrigger getRecurringTaskTrigger(Long id)
                                      throws DAOException

Throws:

DAOException

getRecurringTaskTriggerForTask

RecurringTaskTrigger getRecurringTaskTriggerForTask(TaskType task)
                                             throws DAOException

Throws:

DAOException

addRecurringTaskTrigger

boolean addRecurringTaskTrigger(RecurringTaskTrigger trigger)
                         throws DAOException

Throws:

DAOException

updateRecurringTaskTrigger

boolean updateRecurringTaskTrigger(RecurringTaskTrigger trigger)
                            throws DAOException

Throws:

DAOException

deleteRecurringTaskTrigger

boolean deleteRecurringTaskTrigger(Long id)
                            throws DAOException

Throws:

DAOException

deleteViewerMessagesBefore

int deleteViewerMessagesBefore(LocalDateTime date)
                        throws DAOException

Throws:

DAOException

addHighlight

boolean addHighlight(HighlightData object)
              throws DAOException

Throws:

DAOException

updateHighlight

boolean updateHighlight(HighlightData object)
                 throws DAOException

Throws:

DAOException

deleteHighlight

boolean deleteHighlight(Long id)
                 throws DAOException

Throws:

DAOException

getHighlight

HighlightData getHighlight(Long id)
                    throws DAOException

Throws:

DAOException

getAllHighlights

List<HighlightData> getAllHighlights()
                              throws DAOException

Throws:

DAOException

getHighlights

List<HighlightData> getHighlights(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters)
                           throws DAOException

Throws:

DAOException

getHighlightsForDate

List<HighlightData> getHighlightsForDate(LocalDateTime date)
                                  throws DAOException

Throws:

DAOException

getPastHighlightsForDate

List<HighlightData> getPastHighlightsForDate(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters,
 LocalDateTime date)
                                      throws DAOException

Throws:

DAOException

getFutureHighlightsForDate

List<HighlightData> getFutureHighlightsForDate(int first,
 int pageSize,
 String sortField,
 boolean descending,
 Map<String,String> filters,
 LocalDateTime date)
                                        throws DAOException

Throws:

DAOException

getFactory

jakarta.persistence.EntityManagerFactory getFactory()

Get the EntityManagerFactory created when initializing the class. Can be used to explicitly create new EntityManagers.

Returns:

the EntityManagerFactory

getEntityManager

jakarta.persistence.EntityManager getEntityManager()

Get an EntityManager for a query or transaction. Must always be followed by close(EntityManager) Method after the query/transaction

Returns:

a new EntityManager

close

void close(jakarta.persistence.EntityManager em)
    throws DAOException

Either close the given EntityManager or do some other post query/transaction handling for the given EntityManager. Must be called after each query/transaction.

Parameters:

em - EntityManager

Throws:

DAOException

startTransaction

jakarta.persistence.EntityTransaction startTransaction(jakarta.persistence.EntityManager em)

Call getTransaction() on the given EntityManager and then begin() on the transaction

Parameters:

em - EntityManager

Returns:

the transaction gotten from the entity manager

commitTransaction

void commitTransaction(jakarta.persistence.EntityTransaction et)
                throws jakarta.persistence.PersistenceException

Call EntityTransaction.commit() on the given transaction

Parameters:

et - EntityTransaction

Throws:

jakarta.persistence.PersistenceException

commitTransaction

void commitTransaction(jakarta.persistence.EntityManager em)
                throws jakarta.persistence.PersistenceException

Call EntityTransaction.commit() on the current transaction of the given EntityManager

Parameters:

em - EntityManager

Throws:

jakarta.persistence.PersistenceException

handleException

void handleException(jakarta.persistence.EntityTransaction et)
              throws jakarta.persistence.PersistenceException

Handling of exceptions occurred during commitTransaction(EntityTransaction). Usually calls EntityTransaction.rollback()

Parameters:

et - EntityTransaction

Throws:

jakarta.persistence.PersistenceException

handleException

void handleException(jakarta.persistence.EntityManager em)

Handling of exceptions occurred during commitTransaction(EntityManager) Usually calls EntityTransaction.rollback() on the current transaction of the given EntityManager

Parameters:

em - EntityManager

Throws:

jakarta.persistence.PersistenceException