Package com.saperion.ngc.resultset

Interface ResultSetView

All Superinterfaces:
Cloneable, org.zkoss.zk.ui.Component, EventChild, EventChildHandler, LogEventChildHandler, org.zkoss.zk.ui.ext.Scope, Serializable
All Known Implementing Classes:
ResultSetViewImpl
public interface ResultSetView extends org.zkoss.zk.ui.Component, EventChild, EventChildHandler
Represents a result list in a form.

  • Field Details

    • RSS_BUTTONEDIT

      static final int RSS_BUTTONEDIT
      ResStyle bitmask entry for edit-button.
      See Also:

    • RSS_BUTTONPRINT

      static final int RSS_BUTTONPRINT
      ResStyle bitmask entry for print-button.
      See Also:

    • RSS_BUTTONDELETE

      static final int RSS_BUTTONDELETE
      ResStyle bitmask entry for delete-button.
      See Also:

    • RSS_BUTTONINDEX

      static final int RSS_BUTTONINDEX
      ResStyle bitmask entry for index-button.
      See Also:

    • RSS_BUTTONSAVE

      static final int RSS_BUTTONSAVE
      ResStyle bitmask entry for save-button.
      See Also:

    • RSS_BUTTONNEW

      static final int RSS_BUTTONNEW
      ResStyle bitmask entry for new-button.
      See Also:

    • RSS_RESTRICTCURSOR

      static final int RSS_RESTRICTCURSOR
      ResStyle bitmask entry for restrict-cursor-option.
      See Also:

    • RSS_BUTTONVIEW

      static final int RSS_BUTTONVIEW
      ResStyle bitmask entry for view-button.
      See Also:

    • RSS_OUTLINE

      static final int RSS_OUTLINE
      ResStyle bitmask entry for outliner-view.
      See Also:

    • RSS_CONDITION

      static final int RSS_CONDITION
      ResStyle bitmask entry for condition-option.
      See Also:

    • RSS_SINGLECLICK

      static final int RSS_SINGLECLICK
      ResStyle bitmask entry for singleclick-option.
      See Also:

    • RSS_BUTTONSECURITY

      static final int RSS_BUTTONSECURITY
      ResStyle bitmask entry for security-button.
      See Also:

    • DEFAULT_RIGHTS_MASK

      static final int DEFAULT_RIGHTS_MASK
      Bitmask with default menu entries enabled.
      See Also:

    • DEFAULT_BUTTON_EDIT_ID

      static final int DEFAULT_BUTTON_EDIT_ID
      QBE id for default button edit.
      See Also:

    • DEFAULT_BUTTON_PRINT_ID

      static final int DEFAULT_BUTTON_PRINT_ID
      QBE id for default button print.
      See Also:

    • DEFAULT_BUTTON_DELETE_ID

      static final int DEFAULT_BUTTON_DELETE_ID
      QBE id for default button delete.
      See Also:

    • DEFAULT_BUTTON_INDEX_ID

      static final int DEFAULT_BUTTON_INDEX_ID
      QBE id for default button index.
      See Also:

    • DEFAULT_BUTTON_SAVE_ID

      static final int DEFAULT_BUTTON_SAVE_ID
      QBE id for default button save.
      See Also:

    • DEFAULT_BUTTON_VIEW_ID

      static final int DEFAULT_BUTTON_VIEW_ID
      QBE id for default button view.
      See Also:

    • DEFAULT_BUTTON_SECURITY_ID

      static final int DEFAULT_BUTTON_SECURITY_ID
      QBE id for default button security.
      See Also:

    • MAX_COUNT_FOR_CLIENTSIDE_FUNCTIONS

      static final int MAX_COUNT_FOR_CLIENTSIDE_FUNCTIONS
      Maximum amount of items allowed in a result to use client side functions.
      See Also:

    • DISPLAY_NAME

      static final String DISPLAY_NAME
      Attribute name for display name.
      See Also:

    • DATABASE_NAME

      static final String DATABASE_NAME
      Attribute name for database name.
      See Also:

    • FILTER_COLS

      static final int FILTER_COLS
      Length of the filter box.
      See Also:

    • FILTER_TIMEOUT

      static final int FILTER_TIMEOUT
      Timeout for filter operation.
      See Also:

    • CONTEXT_TIMEOUT

      static final int CONTEXT_TIMEOUT
      Timeout for context menus.
      See Also:

    • WF_BOX_ID

      static final String WF_BOX_ID
      Name of box id property.
      See Also:

  • Method Details

    • clearResultSet

      void clearResultSet()
      Clears the result set.

    • initializePaging

      void initializePaging(ResultPaging paging)
      Initialize paging options.
      Parameters:
      paging - paging

    • reset

      void reset()
      Reset view.

    • releaseLocks

      void releaseLocks()
      Unlocks all previously locked documents.

    • setSelectedIndex

      void setSelectedIndex(int index)
      Moves the selected index of the result list to the specified position. If the specified position is not available, the method has no effect.
      Parameters:
      index - new index to select

    • getSelectedIndex

      int getSelectedIndex()
      Returns the currently selected index.
      Returns:
      the currently selected index

    • getOriginalItemIndex

      int getOriginalItemIndex()
      Returns the original index of the currently selected item or -1 if no item is selected.
      Returns:
      item index

    • onSelectDDC

      void onSelectDDC(org.zkoss.zk.ui.event.Event event)
      Handle DDC select event.
      Parameters:
      event - Event

    • onDownloadResultItem

      void onDownloadResultItem(org.zkoss.zk.ui.event.Event event)
      Handle download document event.
      Parameters:
      event - Event

    • onSendMailResultItem

      void onSendMailResultItem(org.zkoss.zk.ui.event.Event event)
      Handle send documents as mail event.
      Parameters:
      event - Event

    • onNavigationFolder

      void onNavigationFolder(org.zkoss.zk.ui.event.Event event)
      Handle navigation folder event.
      Parameters:
      event - Event

    • onButtonQuery

      void onButtonQuery(org.zkoss.zk.ui.event.Event event)
      Handles query button.
      Parameters:
      event - Events

    • onEditSelected

      void onEditSelected(org.zkoss.zk.ui.event.Event event)
      Locks the selected row.
      Parameters:
      event - Event

    • onNewSelected

      void onNewSelected(org.zkoss.zk.ui.event.Event event)
      Creates a new row.
      Parameters:
      event - Event

    • onEditItemSelected

      void onEditItemSelected(org.zkoss.zk.ui.event.Event event)
      Edit an existing row.
      Parameters:
      event - Event

    • onRefresh

      void onRefresh(org.zkoss.zk.ui.event.Event event)
      Refresh the view.
      Parameters:
      event - Event

    • onStartWorkflow

      void onStartWorkflow(org.zkoss.zk.ui.event.Event event)
      Start workflow.
      Parameters:
      event - Event

    • onLaunchWorkflow

      void onLaunchWorkflow(org.zkoss.zk.ui.event.Event event)
      Launch an workflow after user selection.
      Parameters:
      event - Event

    • onWorkflowAction

      void onWorkflowAction(org.zkoss.zk.ui.event.Event event)
      Performs a workflow action.
      Parameters:
      event - Event

    • onWorkflowComment

      void onWorkflowComment(org.zkoss.zk.ui.event.Event event)
      Handle workflow comment event.
      Parameters:
      event - Event

    • onWorkflowDisplayComment

      void onWorkflowDisplayComment(org.zkoss.zk.ui.event.Event event)
      Handle workflow display comment event
      Parameters:
      event -

    • onIndexChange

      void onIndexChange(org.zkoss.zk.ui.event.Event event)
      Perform a query based on a document selected by another view.
      Parameters:
      event - Event

    • onResetGui

      void onResetGui(org.zkoss.zk.ui.event.Event event)
      Handler for reset ui event.
      Parameters:
      event - ZK event

    • onEditContent

      void onEditContent(org.zkoss.zk.ui.event.Event event)
      Handler for edit content event.
      Parameters:
      event - ZK event

    • onDeleteSelected

      void onDeleteSelected(org.zkoss.zk.ui.event.Event event)
      Delete selected documents.
      Parameters:
      event - event

    • onUnDeleteSelected

      void onUnDeleteSelected(org.zkoss.zk.ui.event.Event event)
      Undelete selected documents.
      Parameters:
      event - event

    • onDocumentCheck

      void onDocumentCheck(org.zkoss.zk.ui.event.Event event)
      Checkout / checkin actual document.
      Parameters:
      event - Event

    • onShareBaseDocumentCheck

      void onShareBaseDocumentCheck(org.zkoss.zk.ui.event.Event event)
      Checkout / checkin document with ShareBase.
      Parameters:
      event - Event

    • onDocumentRelease

      void onDocumentRelease(org.zkoss.zk.ui.event.Event event)
      Release actual document.
      Parameters:
      event - Event

    • onPrintDocuments

      void onPrintDocuments(org.zkoss.zk.ui.event.Event event)
      Print selected documents.
      Parameters:
      event - Event

    • onExport

      void onExport(org.zkoss.zk.ui.event.Event event)
      Export current result.
      Parameters:
      event - Event

    • onProlongRetention

      void onProlongRetention(org.zkoss.zk.ui.event.Event event)
      prolong the retention.
      Parameters:
      event - Event

    • onReduceDisposition

      void onReduceDisposition(org.zkoss.zk.ui.event.Event event)
      reduce disposition time.
      Parameters:
      event - Event

    • onLitigtationHold

      void onLitigtationHold(org.zkoss.zk.ui.event.Event event)
      set - / unset litigation hold
      Parameters:
      event - Event

    • onEditStructure

      void onEditStructure(org.zkoss.zk.ui.event.Event event)
      Handles event to edit a document's structure.
      Parameters:
      event - event

    • onUploadSuccess

      void onUploadSuccess(org.zkoss.zk.ui.event.Event event)
      Handles upload success events.
      Parameters:
      event - event

    • setSelectQuery

      void setSelectQuery(String query)
      Setter for selectQuery attribute to be used in zul. Performs execution of the given query.
      Parameters:
      query - Query string

    • setSelectWfQuery

      void setSelectWfQuery(String query, boolean perform)
      Setter for selectQuery attribute to be used in zul. Performs execution of the given query.
      Parameters:
      query - Query string
      perform - True for perform immediately

    • performQuery

      void performQuery(com.saperion.rmi.SaQueryInfo query)
      Performs execution of the given query.
      Parameters:
      query - query info

    • getSelectQuery

      String getSelectQuery()
      Returns:
      select query

    • getPageSize

      int getPageSize()
      Returns:
      the page size

    • setPageSize

      void setPageSize(int size)
      Sets the page size of the list.
      Parameters:
      size - page size

    • isFilterViewShown

      boolean isFilterViewShown()
      Returns:
      filter view shown

    • setFilterViewShown

      void setFilterViewShown(boolean shown)
      Enables or disables the filter view.
      Parameters:
      shown - true if filter view should be shown

    • getFieldsToDisplay

      String getFieldsToDisplay()
      Returns:
      the fieldsToDisplay

    • setFieldsToDisplay

      void setFieldsToDisplay(String fields)
      Parameters:
      fields - the fieldsToDisplay to set

    • getSortingDirections

      String getSortingDirections()
      Returns:
      sorting directions

    • setSortingDirections

      void setSortingDirections(String directions)
      Sets the sorting direction for each column from left to right. Can only be set in combination with fieldsToDisplay.
      Parameters:
      directions - Comma-separated list of directions. Possible values: 'ascending', 'descending', 'natural', 'disabled'.

    • getHeaderNames

      String getHeaderNames()
      Returns:
      the preset header names

    • setHeaderNames

      void setHeaderNames(String names)
      Sets the names of the column headers from left to right. Can only be set in combination with fieldsToDisplay.
      Parameters:
      names - header names

    • getHeaderAlignments

      String getHeaderAlignments()
      Returns:
      header alignments

    • setHeaderAlignments

      void setHeaderAlignments(String alignments)
      Sets the alignments of the headers. Can only be set in combination with fieldsToDisplay.
      Parameters:
      alignments - alignments. Possible values: 'right', 'left', 'center'.

    • getHeaderWidths

      String getHeaderWidths()
      Returns:
      header widths

    • setHeaderWidths

      void setHeaderWidths(String widths)
      Sets the widths of the headers. Can only be used in combination with fieldsToDisplay.
      Parameters:
      widths - widths When an invalid value was found

    • getSelectedItems

      @Deprecated Set<DraggableListItem> getSelectedItems()
      Deprecated.
      use getSelectedListItems() instead. Will be removed in 8.1.
      Returns all selected items.
      Returns:
      selected items

    • getSelectedItem

      @Deprecated DraggableListItem getSelectedItem()
      Deprecated.
      use getSelectedListItem() instead. Will be removed in 8.1.
      Returns the selected item.
      Returns:
      selected item

    • getSelectedListItems

      Set<ResultListItem> getSelectedListItems()
      Returns all selected items.
      Returns:
      selected items

    • getSelectedListItem

      ResultListItem getSelectedListItem()
      Returns the selected item.
      Returns:
      selected item

    • getSelectedIds

      List<DocumentId> getSelectedIds()
      Returns the IDs of the selected documents.
      Returns:
      List of document ids

    • onCancelEdit

      void onCancelEdit(org.zkoss.zk.ui.event.Event event)
      Event handler for cancel edit event.
      Parameters:
      event - event

    • onSaveDoc

      void onSaveDoc(org.zkoss.zk.ui.event.Event event)
      Event handler for save document event.
      Parameters:
      event - event

    • onChangeDocumentSecurity

      void onChangeDocumentSecurity(org.zkoss.zk.ui.event.Event event)
      Event handler for change of document security.
      Parameters:
      event - event

    • setResultColumns

      void setResultColumns(Map<String,ResultSetColumn> resultColumns)
      Sets the columns for the result list.
      Parameters:
      resultColumns - columns

    • setSimpleMode

      void setSimpleMode(boolean simpleMode)
      Sets the simple mode parameter.
      Parameters:
      simpleMode - parameter value

    • isSimpleMode

      boolean isSimpleMode()
      Returns:
      simple mode parameter value

    • setFormName

      void setFormName(String name)
      Parameters:
      name - Form name

    • getFormName

      String getFormName()
      Returns:
      Form name

    • setSaveFavoriteEnabled

      void setSaveFavoriteEnabled(boolean enabled)
      Sets the saveFavoriteEnabled parameter.
      Parameters:
      enabled - value

    • isSaveFavoriteEnabled

      boolean isSaveFavoriteEnabled()
      Returns:
      saveFavoriteEnabled parameter

    • setExportEnabled

      void setExportEnabled(boolean enabled)
      Enables or disables the export button.
      Parameters:
      enabled - enabled or not

    • isExportEnabled

      boolean isExportEnabled()
      Returns:
      whether export is enabled or not

    • isAutoSearch

      boolean isAutoSearch()
      Returns:
      Auto search on.

    • setTitle

      void setTitle(String titleString)
      Sets the title. Used in iForms to display frame title.
      Parameters:
      titleString - title string

    • addCustomMenuItem

      void addCustomMenuItem(org.zkoss.zul.Menuitem item, boolean multi)
      Adds a custom menu item. If multi is true, the menu item will be added to the single and multi selection menus.
      Parameters:
      item - the item
      multi - set to true if the item should be available for multi selection

    • getCustomMenuItems

      List<org.zkoss.zul.Menuitem> getCustomMenuItems(boolean multi)
      Returns the custom menu items.
      Parameters:
      multi - if true, the menu items returned can be used with multi selection
      Returns:
      map with label/menuitem pairs

    • setRemoveMenuItemList

      void setRemoveMenuItemList(List<MenuItemKey> removeList, boolean multi)
      Set menu items for removing.
      Parameters:
      removeList - List of items.
      multi - True for multiselect

    • getRemoveMenuItemList

      List<MenuItemKey> getRemoveMenuItemList(boolean multi)
      Reads the list of remove menu items.
      Parameters:
      multi - True for multiselect
      Returns:
      list of remove menu items

    • getSelectedRows

      List<ResultProperties> getSelectedRows()
      Returns a list containing the properties of the selected rows. If no row is selected, an empty list is returned.
      Returns:
      list of properties of the selected rows

    • getAllRows

      List<ResultProperties> getAllRows()
      Returns a list containing the properties of all rows.
      Returns:
      list of properties of all rows

    • getParentForm

      IntelligentFormView getParentForm()
      Returns the parent form or null if this field is not part of a form.
      Returns:
      parent form or null

    • getResultSetList

      ResultList getResultSetList()
      Returns the ResultList used in this ResultSetView.
      Returns:
      ResultList used in this ResultSetView

    • getResultType

      com.saperion.ngc.iform.xml.ResultType getResultType()
      Returns the ResultType that contains the properties of this ResultSetView as defined in the QBE-form.
      Returns:
      the ResultType of this ResultSetView

    • getAllowed

      String getAllowed()
      Returns:
      Returns all allowed features.

    • setAllowed

      void setAllowed(String value)
      Parameters:
      value - Comma separated list of allowed features. One of: EDIT, DELETE, INDEX, SAVE, NEW, VIEW, SECURITY

    • getDefaultMenu

      boolean getDefaultMenu()
      Returns:
      True, if default menu switched on.

    • setDefaultMenu

      void setDefaultMenu(boolean value)
      Parameters:
      value - True for switched on default menu.

    • addCustomMenu

      void addCustomMenu(org.zkoss.zul.Menu menu, boolean multi)
      Adds a custom menu. If multi is true, the menu item will be added to the single and multi selection menus.
      Parameters:
      menu - the menu
      multi - set to true if the menu should be available for multi selection

    • getCustomMenus

      List<org.zkoss.zul.Menu> getCustomMenus(boolean multi)
      Returns the custom menus.
      Parameters:
      multi - if true, the menus returned can be used with multi selection
      Returns:
      list of menus

    • getContextMenuPopup

      org.zkoss.zul.Menupopup getContextMenuPopup()
      Returns the popup of the context menu. Note that the popup is replaced each time the list is rendered. To modify the menu, use addCustomMenu or addCustomMenuItem instead.
      Returns:
      the context menu popup of the result list
      See Also:

    • refresh

      void refresh(boolean newQuery)
      Refreshes the result list.
      Parameters:
      newQuery - if true, the query will be executed on the backend system again

    • updateListItem

      void updateListItem(ResultListItem item)
      Updates the specified item in the list. The other items will remain as they are. The list will not automatically scroll to updated item or activate the page that contains the specified item. This method throws an IllegalArgumentException when the specified item is not contained in the current query-result.
      Parameters:
      item - the item to be updated

    • setDefaultButtonType

      void setDefaultButtonType(ResultSetView.DefaultButtonType defaultButton)
      Sets the default type of button to be shown for each item in result list.
      Parameters:
      defaultButton - default button type to be set

    • getDefaultButtonType

      ResultSetView.DefaultButtonType getDefaultButtonType()
      Returns:
      the default type of button to be shown for each item in result list.

    • getIndexMask

      String getIndexMask()
      Returns:
      the index mask defined in the definition of this ResultSetView

    • getNumberOfIndexes

      int getNumberOfIndexes()
      Returns the number of items in this list.
      Returns:
      item count in result-list.

    • selectNext

      void selectNext()
      Selects the next row.

    • selectPrevious

      void selectPrevious()
      Selects the previous row.

    • selectFirst

      void selectFirst()
      Selects the first valid row.

    • selectLast

      void selectLast()
      Selects the last valid row.

    • setSaveLayout

      void setSaveLayout(boolean save)
      Enables or disabled saving of the layout.
      Parameters:
      save - true to enable, false to disable

    • isSaveLayout

      boolean isSaveLayout()
      Checks if save layout is enabled.
      Returns:
      true, if enabled, false if not.

    • deleteConfiguration

      void deleteConfiguration()
      Deletes the stored configuration of the columns (width and sort-direction).

    • setSearchMode

      void setSearchMode(SearchMode mode)
      Sets the search-mode. See SearchMode for possible modes.
      Parameters:
      mode - the search mode to use

    • getSearchMode

      SearchMode getSearchMode()
      Returns:
      the search mode currently in use

    • export

      void export()
      Exports the current query result. A settings-dialog is shown to let the user decide the format, filename and columns for the export.

    • export

      void export(Map<String,String> columnsToExport, ResultSetView.ExportFormat format, String filename)
      Exports the current query result. No settings-dialog will be shown.
      Parameters:
      columnsToExport - columns to be exported. The map contains the upper-case column names as in the database as keys and the desired display-names of the columns as values.
      format - the format to export to
      filename - the name of the resulting file

    • getTotalSize

      int getTotalSize()
      Returns the total size of the last query result.
      Returns:
      total size of result

    • setDocumentRead

      @Deprecated void setDocumentRead(DraggableListItem item)
      Deprecated.
      use setDocumentRead(ResultListItem) instead. Will be removed in 8.1.
      Sets the specified item's state to 'read' without creating a new revision.
      Parameters:
      item - item to change

    • setDocumentUnread

      @Deprecated void setDocumentUnread(DraggableListItem item)
      Deprecated.
      use setDocumentUnread(ResultListItem) instead. Will be removed in 8.1.
      Sets the specified item's state to 'unread' without creating a new revision.
      Parameters:
      item - item to change

    • setDocumentRead

      void setDocumentRead(ResultListItem item)
      Sets the specified item's state to 'read' without creating a new revision.
      Parameters:
      item - item to change

    • setDocumentUnread

      void setDocumentUnread(ResultListItem item)
      Sets the specified item's state to 'unread' without creating a new revision.
      Parameters:
      item - item to change

    • addCustomCondition

      void addCustomCondition(FieldResultBean condition)
      Adds a condition that will be used each time this ResultSetView performs a query.
      Parameters:
      condition - a FieldResultBean or a CustomConditionBean with the condition

    • getCustomConditions

      List<FieldResultBean> getCustomConditions()
      Returns:
      list of all custom conditions that were added by addCustomCondition(FieldResultBean). The returned list can be modified.

    • setResultListClass

      void setResultListClass(Class<? extends ResultList> clazz)
      Sets the class that will be used for the internal ResultList. The default is ResultListImpl. The class must have a constructor with no arguments.
      Parameters:
      clazz - class to be used

    • setCustomSortSequences

      void setCustomSortSequences(Map<String,SortDirection> sortSequences)
      Sets custom sort sequences for the specified column names. These sort sequences will overwrite the sort sequences selected by the user in the UI.
      Parameters:
      sortSequences - a map that maps the database-name of a column with a SortDirection

    • getCustomSortSequences

      Map<String,SortDirection> getCustomSortSequences()
      Returns:
      the custom sort sequences set by setCustomSortSequences(Map). If no custom sort sequences were set, this method returns an empty map.

    • getPropertyConverter

      PropertyToStringConverter getPropertyConverter()
      Returns the converter that is used to convert SaPropertyValue instances to strings. The converter is initialized with the current locale and the DDC used by this ResultSetView.
      Returns:
      the property converter used by this ResultSetView

    • onExternalStorageUpload

      void onExternalStorageUpload(org.zkoss.zk.ui.event.Event event)
      Handles event to upload a document to External Storage.
      Parameters:
      event - event

    • onShareBaseLogin

      void onShareBaseLogin(org.zkoss.zk.ui.event.Event event)
      Handles event for login to ShareBase.
      Parameters:
      event - event

    • onExternalStorageUploadStatus

      void onExternalStorageUploadStatus(org.zkoss.zk.ui.event.Event event)

    • onOneDriveLogin

      void onOneDriveLogin(org.zkoss.zk.ui.event.Event event)