Package com.appiancorp.type.system
Class ListViewItem
java.lang.Object
com.appiancorp.type.system.ListViewItem
This class is available as a preview of functionality that will be added to the supported public API in a future release. While it is in the preview phase, it is subject to change or removal without deprecation or notice. Although notice of change is not guaranteed, we will try to let developers know of major changes through announcements in release notes.
A ListViewItem contains an image, a title, a timestamp, and details.
The image object can either be of type UserRef
or of type DocumentRef
.
The timestamp object is used to convey information about when the data that is represented by the ListViewItem was created or modified.
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic enum
An enumeration used as keys for the fields of aListViewItem
. -
Field Summary
-
Constructor Summary
ConstructorDescriptionListViewItem
(Object image, String title, String details) Constructs a new ListViewItem using the given image, title, and details.ListViewItem
(Object image, String title, String details, Timestamp timestamp) Constructs a new ListViewItem with the given image, title, details, and timestamp.ListViewItem
(String title, String details, Timestamp timestamp) Constructs a new ListViewItem with the given title, details, and timestamp of when this ListViewItem was created. -
Method Summary
Modifier and TypeMethodDescriptionstatic com.google.common.base.Equivalence<ListViewItem>
Returns an Equivalence object that can be used to determine if two ListViewItem objects are equal.Returns the details of this ListViewItem.getImage()
Returns the ListViewItem image.Returns the timestamp of this ListViewItem.getTitle()
Returns the title of this ListViewItem.toString()
-
Field Details
-
LOCAL_PART
- See Also:
-
QNAME
-
-
Constructor Details
-
ListViewItem
Constructs a new ListViewItem using the given image, title, and details. The timestamp of this ListViewItem will be null. The Image object for a ListViewItem can be either a com.appiancorp.type.refs.DocumentRef, or a com.appiancorp.type.refs.UserRef.- Parameters:
image
- aDocumentRef
orUserRef
that represents the underlying data. The document must be an image and will be cropped to on display. The user's avatar will be used.title
- a short name for the itemdetails
- additional details about the item
-
ListViewItem
Constructs a new ListViewItem with the given title, details, and timestamp of when this ListViewItem was created. The image of this ListViewItem will be null.- Parameters:
title
- a short name for the itemdetails
- additional details about the itemtimestamp
- the timestamp of when the data was created or last modified
-
ListViewItem
Constructs a new ListViewItem with the given image, title, details, and timestamp. The Image object for a ListViewItem can be either a com.appiancorp.type.refs.DocumentRef, or a com.appiancorp.type.refs.UserRef.- Parameters:
image
- aDocumentRef
orUserRef
that represents the underlying data. The document must be an image and will be cropped to on display. The user's avatar will be used.title
- a short name for the itemdetails
- additional details about the itemtimestamp
- the timestamp of when the data was created or last modified
-
-
Method Details
-
getImage
Returns the ListViewItem image. This image can be either a com.appiancorp.type.refs.DocumentRef, or a com.appiancorp.type.refs.UserRef.- Returns:
- the ListViewItem image
-
getTitle
Returns the title of this ListViewItem.- Returns:
- the ListViewItem title
-
getDetails
Returns the details of this ListViewItem.- Returns:
- the ListViewItem details
-
getTimestamp
Returns the timestamp of this ListViewItem.- Returns:
- the ListViewItem timestamp
-
toString
-
equalDataCheck
Returns an Equivalence object that can be used to determine if two ListViewItem objects are equal. This Equivalence objects equivalent(ListViewItem lvi1, ListViewItem lvi2) should be used instead of equals().- Returns:
- an Equivalent object that can be used to determine if ListViewItems are equivalent
-