Interface GroupAttributeAggregator


  • public interface GroupAttributeAggregator
    This interface provides attribute values for a grouping worklist item. Implementations decide on the values depending on the worklist items of the group.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      long getAssignmentDate()
      Gets the assignment date for the grouping worklist item aggregated from the group items.
      String getDescription()
      Gets the description for the grouping worklist item aggregated from the group items.
      Map<Locale,​String> getDescriptionLocalisations()
      Gets the localisations of the description for the grouping worklist item aggregated from the corresponding localisations of the group items.
      long getDueDate()
      Gets the due date for the grouping worklist item aggregated from the group items.
      long getEscalationDate()
      Gets the escalation date for the grouping worklist item aggregated from the group items.
      String getEscalationHandlingId()
      Gets the escalation handling procedure ID title for the grouping worklist item aggregated from the group items.
      int getPriority()
      Gets the priority for the grouping worklist item aggregated from the group items.
      String getProcessInstanceName()
      Gets the process instance name for the grouping worklist item aggregated from the group items.
      Map<Locale,​String> getProcessInstanceNameLocalisations()
      Gets the localisations of the process instance name for the grouping worklist item aggregated from the corresponding localisations of the group items.
      WorklistConstants.WorklistItemState getState()
      Gets the worklist item state for the grouping worklist item aggregated from the group items.
      String getTitle()
      Gets the title for the grouping worklist item aggregated from the group items.
      Map<Locale,​String> getTitleLocalisations()
      Gets the localisations of the title for the grouping worklist item aggregated from the corresponding localisations of the group items.
      boolean needsSuppression()
      Gets whether the grouping worklist item needs to be suppressed, e. g. since all group items are suppressed.
    • Method Detail

      • getTitle

        String getTitle()
        Gets the title for the grouping worklist item aggregated from the group items.
        Returns:
        The title for the grouping worklist item aggregated from the group items.
      • getTitleLocalisations

        Map<Locale,​String> getTitleLocalisations()
        Gets the localisations of the title for the grouping worklist item aggregated from the corresponding localisations of the group items.
        Returns:
        The localisations of the title for the grouping worklist item aggregated from the corresponding localisations of the group items. null indicates to not change the localisations of the title of the grouping item.
      • getDescription

        String getDescription()
        Gets the description for the grouping worklist item aggregated from the group items.
        Returns:
        The description for the grouping worklist item aggregated from the group items.
      • getDescriptionLocalisations

        Map<Locale,​String> getDescriptionLocalisations()
        Gets the localisations of the description for the grouping worklist item aggregated from the corresponding localisations of the group items.
        Returns:
        The localisations of the description for the grouping worklist item aggregated from the corresponding localisations of the group items. null indicates to not change the localisations of the description of the grouping item.
      • getProcessInstanceName

        String getProcessInstanceName()
        Gets the process instance name for the grouping worklist item aggregated from the group items.
        Returns:
        The process instance name for the grouping worklist item aggregated from the group items.
      • getProcessInstanceNameLocalisations

        Map<Locale,​String> getProcessInstanceNameLocalisations()
        Gets the localisations of the process instance name for the grouping worklist item aggregated from the corresponding localisations of the group items.
        Returns:
        The localisations of the process instance name for the grouping worklist item aggregated from the corresponding localisations of the group items. null indicates to not change the localisations of the title of the grouping item.
      • getState

        WorklistConstants.WorklistItemState getState()
        Gets the worklist item state for the grouping worklist item aggregated from the group items.
        Returns:
        The worklist item state for the grouping worklist item aggregated from the group items.
      • getPriority

        int getPriority()
        Gets the priority for the grouping worklist item aggregated from the group items.
        Returns:
        The priority for the grouping worklist item aggregated from the group items.
      • getAssignmentDate

        long getAssignmentDate()
        Gets the assignment date for the grouping worklist item aggregated from the group items.
        Returns:
        The assignment date for the grouping worklist item aggregated from the group items.
      • getEscalationDate

        long getEscalationDate()
        Gets the escalation date for the grouping worklist item aggregated from the group items.
        Returns:
        The escalation date for the grouping worklist item aggregated from the group items.
      • getEscalationHandlingId

        String getEscalationHandlingId()
        Gets the escalation handling procedure ID title for the grouping worklist item aggregated from the group items.
        Returns:
        The escalation handling procedure ID for the grouping worklist item aggregated from the group items.
      • getDueDate

        long getDueDate()
        Gets the due date for the grouping worklist item aggregated from the group items.
        Returns:
        The due date for the grouping worklist item aggregated from the group items.
      • needsSuppression

        boolean needsSuppression()
        Gets whether the grouping worklist item needs to be suppressed, e. g. since all group items are suppressed.
        Returns:
        Whether the grouping worklist item needs to be suppressed.