public abstract class Suggestion extends Object implements Serializable
Modifier and Type | Field and Description |
---|---|
static String |
DATE_FORMAT_PATTERN |
protected String |
description |
protected boolean |
disabled |
protected Map<String,List<String>> |
highlights |
protected String |
iconURL |
protected String |
id |
protected String |
label |
protected String |
thumbnailURL |
protected String |
type |
Constructor and Description |
---|
Suggestion(String id,
String type,
String label,
String iconURL) |
Suggestion(String id,
String type,
String label,
String iconURL,
String thumbnailURL) |
Suggestion(String id,
String type,
String label,
String iconURL,
String thumbnailURL,
Map<String,List<String>> highlights) |
Modifier and Type | Method and Description |
---|---|
Suggestion |
disable() |
String |
getDescription() |
Map<String,List<String>> |
getHighlights()
Get the map of highlights associated to the suggested result.
|
String |
getIconURL()
Relative URL path to download an icon (can represent the type of suggestion or the specific instance such as the
mimetype icon of a document suggestion or the avatar icon of a user profile suggestion).
|
String |
getId()
The id of the object associated to the suggestion.
|
boolean |
getIsDisabled()
Disabled suggestions can be useful to display suggestions that might have been relevant if the context was
slightly different (e.g.
|
String |
getLabel()
The i18n label to display to the user for this suggestion.
|
abstract String |
getObjectUrl() |
String |
getThumbnailURL() |
String |
getType()
A string marker to give the type (i.e.
|
String |
toString() |
Suggestion |
withDescription(String description) |
Suggestion |
withHighlights(Map<String,List<String>> highlights) |
Suggestion |
withThumbnailURL(String thumbnailURL) |
public static final String DATE_FORMAT_PATTERN
protected String thumbnailURL
protected String description
protected Map<String,List<String>> highlights
protected boolean disabled
public Suggestion(String id, String type, String label, String iconURL)
public Suggestion(String id, String type, String label, String iconURL, String thumbnailURL)
public String getType()
public String getIconURL()
public String getDescription()
public Suggestion withDescription(String description)
public boolean getIsDisabled()
public String getThumbnailURL()
public Suggestion withHighlights(Map<String,List<String>> highlights)
public Suggestion withThumbnailURL(String thumbnailURL)
public Suggestion disable()
public abstract String getObjectUrl()
public Map<String,List<String>> getHighlights()
Copyright © 2018 Nuxeo. All rights reserved.