Class DashboardSearchResult

java.lang.Object
com.xebialabs.xlrelease.api.v1.views.DashboardSearchResult

public class DashboardSearchResult extends Object
Lightweight description of a dashboard returned by a dashboard search: no tiles, but with the folder location so that dashboards with the same title can be told apart, and whether the current user can edit the dashboard or only view it.
  • Constructor Details

    • DashboardSearchResult

      public DashboardSearchResult()
    • DashboardSearchResult

      public DashboardSearchResult(String id, String title, String folderId, String folderPath, boolean canEdit)
  • Method Details

    • getId

      public String getId()
    • setId

      public void setId(String id)
    • getTitle

      public String getTitle()
    • setTitle

      public void setTitle(String title)
    • getFolderId

      public String getFolderId()
      Returns:
      the ID of the parent folder, or null for a global dashboard
    • setFolderId

      public void setFolderId(String folderId)
    • getFolderPath

      public String getFolderPath()
      Returns:
      the readable folder path built from folder titles (e.g. Finance/Folder2), or null for a global dashboard
    • setFolderPath

      public void setFolderPath(String folderPath)
    • isCanEdit

      public boolean isCanEdit()
      Returns:
      true when the current user can modify the dashboard (e.g. save a tile to it), false when the user can only view it
    • setCanEdit

      public void setCanEdit(boolean canEdit)
    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object