Package de.elo.ix.client

Class FindWorkflowInfo

java.lang.Object
byps.BValueClass
de.elo.ix.client.ValueClass
de.elo.ix.client.FindWorkflowInfo
All Implemented Interfaces:
Serializable
public class FindWorkflowInfo extends ValueClass implements Serializable
This class contains the search criteria for selecting workflows.

Copyright: Copyright (c) 2008, 2010

Organisation: ELO Digital Office GmbH

See Also:

  • Field Details

    • userIds

      protected String[] userIds
      Collect workflows for this users. For every given user or group in this list, those workflows are returned where the user or her or his groups or her or his substituted users has any node assigned. If this value is null or empty and the current user is a workflow administrator, the returned list of workflows is not constrained to any user ID. If this value is null or empty and the current user is not a workflow administrator, workflows for the current user inclusive her or his groups and inclusive her or his substituted users are returned. A Workflow administrator (privilege AccessC.FLAG_EDITWF) can specify any user or group ID here. Another user can only specify her or his user ID or her or his groups or her or his substituted users.

    • name

      protected String name
      Workflow name. If not null and not empty, it the search is restricted to workflows named like this value. It may contain wildcards, e. g. *bill*.
      Since:
      6.00.098

    • type

      protected WFTypeZ type
      Workflow type. This parameter controls the search for nodes of either active or finished workflows. If this parameter is null, the search is performed on active workflows.
      Since:
      6.00.098

    • overTimeLimit

      protected boolean overTimeLimit
      Collect only WFs that exceeded the time limit. The entire WF or one of its nodes must be over time.
      Since:
      6.00.098

    • objId

      protected String objId
      Object ID. Active and finished workflows only. If not null and not empty, only workflows assigned to this object are returned.
      Since:
      6.00.098

    • startDateIso

      protected String startDateIso
      Start date. If not null and not empty, workflows started at this date or in this date range are returned. It can be a single date value or a time span of two ISO dates separated by "...". To return workflows with a start date up to a given time, set startDateIso="..."+time (the first time value can be omitted).
      Since:
      6.00.098

    • completionDateIso

      protected String completionDateIso
      Completion date. If not null and not empty, workflows completed at this date or in this date range are returned. Only valid if wfType=FINISHED. A time span can be specified by using "...".
      Since:
      6.00.098
      See Also:

    • templateId

      protected String templateId
      Workflow template ID or name. If not null and not empty, the result is constrained to workflows based on this workflow template.
      Since:
      6.00.098
      See Also:

    • inclDeleted

      protected boolean inclDeleted
      Only template workflows: include deleted templates.
      Since:
      6.00.098

    • ownerIds

      protected String[] ownerIds
      List with ownerIds. If not null and not empty only the workflows with these owners will be returned.
      Since:
      7.00.020.007

    • activeUserIds

      protected String[] activeUserIds
      List with userIds. If not null and not empty only the workflows with this active users will be returned. ActiveUsers are the users of the active workflow node.
      Since:
      7.00.020.007

    • inclHidden

      protected boolean inclHidden
      If true, include hidden/technical workflows with the result.
      Since:
      9.00.018.006

    • sordZ

      protected SordZ sordZ
      Return the associated Sord objects to the selected workflows. If this member is not null, the Sord objects to the selected workflows are read from the database. The Sord objects can be found in FindResult.sords in a random order. A Sord object is returned only once, even if there are more workflows assigned to the Sord. The Sord objects contain the elements defined in this element selector as valid members.
      Since:
      9.99.009.007

    • findResultAccessMode

      protected FindResultAccessMode findResultAccessMode
      Describes how the client application will access the results.
      Since:
      11.00.000.033

  • Constructor Details

    • FindWorkflowInfo

      public FindWorkflowInfo()
      Construktor

    • FindWorkflowInfo

      public FindWorkflowInfo(FindWorkflowInfo rhs)
      Copy constructor.
      Parameters:
      rhs - FindWorkflowInfo

  • Method Details

    • getUserIds

      public String[] getUserIds()

    • setUserIds

      public void setUserIds(String[] userIds)

    • getOwnerIds

      public String[] getOwnerIds()

    • setOwnerIds

      public void setOwnerIds(String[] ownerIds)

    • getActiveUserIds

      public String[] getActiveUserIds()

    • setActiveUserIds

      public void setActiveUserIds(String[] activeUserIds)

    • getName

      public String getName()

    • setName

      public void setName(String flowName)

    • getType

      public WFTypeZ getType()

    • setType

      public void setType(WFTypeZ wfType)

    • isOverTimeLimit

      public boolean isOverTimeLimit()

    • setOverTimeLimit

      public void setOverTimeLimit(boolean v)

    • getObjId

      public String getObjId()

    • setObjId

      public void setObjId(String objId)

    • getStartDateIso

      public String getStartDateIso()

    • setStartDateIso

      public void setStartDateIso(String startDateIso)

    • getCompletionDateIso

      public String getCompletionDateIso()

    • setCompletionDateIso

      public void setCompletionDateIso(String completionDateIso)

    • getTemplateId

      public String getTemplateId()

    • setTemplateId

      public void setTemplateId(String templateId)

    • isInclDeleted

      public boolean isInclDeleted()

    • setInclDeleted

      public void setInclDeleted(boolean inclDeleted)

    • isInclHidden

      public boolean isInclHidden()

    • setInclHidden

      public void setInclHidden(boolean inclHidden)

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • getSordZ

      public SordZ getSordZ()

    • setSordZ

      public void setSordZ(SordZ sordZ)

    • isExcludeUserGroups

      public boolean isExcludeUserGroups()

    • setExcludeUserGroups

      public void setExcludeUserGroups(boolean excludeUserGroups)

    • getFindResultAccessMode

      public FindResultAccessMode getFindResultAccessMode()

    • setFindResultAccessMode

      public void setFindResultAccessMode(FindResultAccessMode findResultAccessMode)