Package com.appiancorp.type.system

Class ListViewItem

java.lang.Object

com.appiancorp.type.system.ListViewItem

@GwtCompatible
public class ListViewItem
extends Object

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

Nested Classes

Modifier and Type	Class	Description
static enum	ListViewItem.Field	An enumeration used as keys for the fields of a ListViewItem.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LOCAL_PART
static final QName	QNAME

Constructor Summary

Constructors

Constructor	Description
ListViewItem(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 Type	Method	Description
static com.google.common.base.Equivalence<ListViewItem>	equalDataCheck()	Returns an Equivalence object that can be used to determine if two ListViewItem objects are equal.
String	getDetails()	Returns the details of this ListViewItem.
Object	getImage()	Returns the ListViewItem image.
Timestamp	getTimestamp()	Returns the timestamp of this ListViewItem.
String	getTitle()	Returns the title of this ListViewItem.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

LOCAL_PART

public static final String LOCAL_PART

See Also:

• Constant Field Values

QNAME

public static final QName QNAME

Constructor Details

ListViewItem

public ListViewItem(Object image,
 String title,
 String details)

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 - a DocumentRef or UserRef 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 item

details - additional details about the item

ListViewItem

public ListViewItem(String title,
 String details,
 Timestamp timestamp)

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 item

details - additional details about the item

timestamp - the timestamp of when the data was created or last modified

ListViewItem

public ListViewItem(Object image,
 String title,
 String details,
 Timestamp timestamp)

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 - a DocumentRef or UserRef 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 item

details - additional details about the item

timestamp - the timestamp of when the data was created or last modified

Method Details

getImage

public Object 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

public String getTitle()

Returns the title of this ListViewItem.

Returns:

the ListViewItem title

getDetails

public String getDetails()

Returns the details of this ListViewItem.

Returns:

the ListViewItem details

getTimestamp

public Timestamp getTimestamp()

Returns the timestamp of this ListViewItem.

Returns:

the ListViewItem timestamp

toString

public String toString()

Overrides:

toString in class Object

equalDataCheck

public static com.google.common.base.Equivalence<ListViewItem> 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