Package com.saperion.ngc.resultset

Interface ResultListItem

All Superinterfaces:
Serializable
All Known Implementing Classes:
DraggableListItem
public interface ResultListItem extends Serializable
Represents an item in the ResultList of a ResultSetView.

  • Method Summary

    Modifier and Type
    Method
    Description
    DocumentId
    getAttachmentId()
    If this is a workflow-item, this method returns the ID of the attached document.
    ResultSetView
    getCorrespondingView()
    Returns the ResultSetView that contains this item.
    String
    getDdcName()
    Returns the name of the DDC this item belongs to.
    DocumentId
    getDocumentId()
    Returns the ID that identifies the document represented by this ResultListItem.
    int
    getIndex()
    Returns the index of this item.
    int
    getOriginalIndex()
    Returns the index of this item in the list like it was returned from the query.
    boolean
    isFolderItem()
    Returns true if this item represents any kind of folder.
    boolean
    isSelected()
    Returns true if this item is selected in the list.
    boolean
    isUnread()
    Returns true if this item was not yet read.
    boolean
    isWorkflowItem()
    Returns true if this item is contained in a workflow-inbox.
    void
    setFocus(boolean focus)
    Sets or removes the focus on this item.
    void
    setRead()
    Marks this item as read.
    void
    setSelected(boolean selected)
    Selects or deselects this item.
    void
    setUnread()
    Marks this item as unread.

  • Method Details

    • getAttachmentId

      DocumentId getAttachmentId()
      If this is a workflow-item, this method returns the ID of the attached document. If this is not a workflow-item, this method returns null.
      Returns:
      ID of the attachment or null if this is not a workflow-item

    • getDocumentId

      DocumentId getDocumentId()
      Returns the ID that identifies the document represented by this ResultListItem.
      Returns:
      the ID of the document represented by this ResultListItem

    • getOriginalIndex

      int getOriginalIndex()
      Returns the index of this item in the list like it was returned from the query. This index does not change when the list gets sorted.
      Returns:
      original index of this item

    • getIndex

      int getIndex()
      Returns the index of this item. This index changes when the list gets sorted.
      Returns:
      current index of this item

    • getCorrespondingView

      ResultSetView getCorrespondingView()
      Returns the ResultSetView that contains this item.
      Returns:
      corresponding ResultSetView. Never null.

    • getDdcName

      String getDdcName()
      Returns the name of the DDC this item belongs to.
      Returns:
      DDC name

    • isFolderItem

      boolean isFolderItem()
      Returns true if this item represents any kind of folder.
      Returns:
      true if this item represents a folder

    • isWorkflowItem

      boolean isWorkflowItem()
      Returns true if this item is contained in a workflow-inbox.
      Returns:
      true if this is a workflow-item

    • isUnread

      boolean isUnread()
      Returns true if this item was not yet read.
      Returns:
      true if unread

    • setRead

      void setRead()
      Marks this item as read.

    • setUnread

      void setUnread()
      Marks this item as unread.

    • setFocus

      void setFocus(boolean focus)
      Sets or removes the focus on this item.
      Parameters:
      focus - true to focus

    • isSelected

      boolean isSelected()
      Returns true if this item is selected in the list.
      Returns:
      true if selected

    • setSelected

      void setSelected(boolean selected)
      Selects or deselects this item.
      Parameters:
      selected - true to select this item