Class DashboardSearchResult
java.lang.Object
com.xebialabs.xlrelease.api.v1.views.DashboardSearchResult
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 Summary
ConstructorsConstructorDescriptionDashboardSearchResult(String id, String title, String folderId, String folderPath, boolean canEdit) -
Method Summary
Modifier and TypeMethodDescriptionbooleangetId()getTitle()inthashCode()booleanvoidsetCanEdit(boolean canEdit) voidsetFolderId(String folderId) voidsetFolderPath(String folderPath) voidvoidtoString()
-
Constructor Details
-
DashboardSearchResult
public DashboardSearchResult() -
DashboardSearchResult
-
-
Method Details
-
getId
-
setId
-
getTitle
-
setTitle
-
getFolderId
- Returns:
- the ID of the parent folder, or
nullfor a global dashboard
-
setFolderId
-
getFolderPath
- Returns:
- the readable folder path built from folder titles (e.g.
Finance/Folder2), ornullfor a global dashboard
-
setFolderPath
-
isCanEdit
public boolean isCanEdit()- Returns:
truewhen the current user can modify the dashboard (e.g. save a tile to it),falsewhen the user can only view it
-
setCanEdit
public void setCanEdit(boolean canEdit) -
equals
-
hashCode
public int hashCode() -
toString
-