Package io.goobi.viewer.model.bookmark

Class BookmarkList

java.lang.Object
io.goobi.viewer.model.bookmark.BookmarkList
All Implemented Interfaces:
Serializable, Comparable<BookmarkList>
@Entity public class BookmarkList extends Object implements Serializable, Comparable<BookmarkList>

BookmarkList class.

See Also:

  • Field Details

  • Constructor Details

    • BookmarkList

      public BookmarkList()

  • Method Details

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • compareTo

      public int compareTo(BookmarkList o)
      Descending order by dateUpdated.
      Specified by:
      compareTo in interface Comparable<BookmarkList>

    • addItem

      public boolean addItem(Bookmark item)
      add bookshelf to list and save
      Parameters:
      item - a Bookmark object.
      Returns:
      boolean if list changed

    • removeItem

      public boolean removeItem(Bookmark item)
      remove bookshelf from list and save
      Parameters:
      item - a Bookmark object.
      Returns:
      boolean if list changed

    • addGroupShare

      public boolean addGroupShare(UserGroup group)
      add user group to list and save
      Parameters:
      group - a UserGroup object.
      Returns:
      boolean if list changed

    • removeGroupShare

      public boolean removeGroupShare(UserGroup group)
      remove user group from list and save
      Parameters:
      group - a UserGroup object.
      Returns:
      boolean if list changed

    • generateSolrQueryForItems

      public String generateSolrQueryForItems()
      Returns a Solr query that would retrieve the Solr documents representing the items listed on this bookshelf.
      Returns:
      a String object.

    • isMayView

      public boolean isMayView(User user)

      isMayView.

      Parameters:
      user - a User object.
      Returns:
      a boolean.
      Throws:
      DAOException - if any.

    • isMayEdit

      public boolean isMayEdit(User user) throws DAOException

      isMayEdit.

      Parameters:
      user - a User object.
      Returns:
      a boolean.
      Throws:
      DAOException - if any.

    • getId

      public Long getId()

      Getter for the field id.

      Returns:
      the id

    • setId

      public void setId(Long id)

      Setter for the field id.

      Parameters:
      id - the id to set

    • getName

      public String getName()

      Getter for the field name.

      Returns:
      the name

    • setName

      public void setName(String name)

      Setter for the field name.

      Parameters:
      name - the name to set

    • getDescription

      public String getDescription()

      Getter for the field description.

      Returns:
      the description

    • setDescription

      public void setDescription(String description)

      Setter for the field description.

      Parameters:
      description - the description to set

    • hasDescription

      public boolean hasDescription()

      hasDescription.

      Returns:
      a boolean.

    • getOwner

      public User getOwner()

      Getter for the field owner.

      Returns:
      the owner

    • setOwner

      public void setOwner(User owner)

      Setter for the field owner.

      Parameters:
      owner - the owner to set

    • isIsPublic

      public boolean isIsPublic()

      isIsPublic.

      Returns:
      the isPublic

    • getPublicString

      public String getPublicString()

      getPublicString.

      Returns:
      the isPublic Value as a String
      surrounded with ()

    • setIsPublic

      public void setIsPublic(boolean isPublic)

      Setter for the field isPublic.

      Parameters:
      isPublic - the isPublic to set

    • getShareKey

      public String getShareKey()

      Getter for the field shareKey.

      Returns:
      the shareKey

    • setShareKey

      public void setShareKey(String shareKey)

      Setter for the field shareKey.

      Parameters:
      shareKey - the shareKey to set

    • hasShareKey

      public boolean hasShareKey()

    • generateShareKey

      public void generateShareKey()
      Generates a persistent share key for public sharing via link.

    • removeShareKey

      public void removeShareKey()
      Removes the share key.

    • getDateUpdated

      public LocalDateTime getDateUpdated()
      Returns:
      the dateUpdated

    • setDateUpdated

      public void setDateUpdated(LocalDateTime dateUpdated)
      Parameters:
      dateUpdated - the dateUpdated to set

    • getNumItems

      public int getNumItems()

      getNumItems.

      Returns:
      Number of items

    • getItems

      public List<Bookmark> getItems()

      Getter for the field items.

      Returns:
      the items

    • setItems

      public void setItems(List<Bookmark> items)

      Setter for the field items.

      Parameters:
      items - the items to set

    • getGroupShares

      public List<UserGroup> getGroupShares()

      Getter for the field groupShares.

      Returns:
      the groupShares

    • setGroupShares

      public void setGroupShares(List<UserGroup> groupShares)

      Setter for the field groupShares.

      Parameters:
      groupShares - the groupShares to set

    • getOwnerName

      public String getOwnerName()

      getOwnerName.

      Returns:
      a String object.

    • getMiradorJsonObject

      public String getMiradorJsonObject(String applicationRoot, String restApiUrl) throws ViewerConfigurationException, IndexUnreachableException, PresentationException

      getMiradorJsonObject.

      Parameters:
      applicationRoot - a String object.
      restApiUrl -
      Returns:
      a String object.
      Throws:
      ViewerConfigurationException - if any.
      IndexUnreachableException - if any.
      PresentationException - if any.

    • getLegacyManifestUrl

      public String getLegacyManifestUrl(String pi)
      Parameters:
      pi -
      Returns:
      Generated URL

    • getFilterQuery

      public String getFilterQuery()

      getFilterQuery.

      Returns:
      a String object.

    • getIIIFCollectionURI

      public String getIIIFCollectionURI()

      getIIIFCollectionURI.

      Returns:
      a String object.

    • getEscapedName

      public String getEscapedName()
      Returns:
      the URL encoded name

    • isOwnedBy

      public boolean isOwnedBy(User user)

    • numItemsWithoutImages

      public long numItemsWithoutImages()

    • sortBookmarkLists

      public static void sortBookmarkLists(List<BookmarkList> bookmarkLists)
      Parameters:
      bookmarkLists -