Package com.groiss.wf

Interface UserFolder

public interface UserFolder
UserFolders are containers for ActivityInstances. Users can organize personally assigned ActivityInstances either manually or via expressions. This interface mainly provides some getters for the UserFolder data. Methods to efficiently enquire about membership of Lists of ActivityInstances in UserFolders are provided in the WfEngine interface.

  • Method Details

    • getExpression

      String getExpression()
      Returns the filter expression used to move ActivityInstances into this UserFolder.
      Returns:
      the filter expression

    • isAutomove

      boolean isAutomove()
      Determine if new ActivityInstances are automatically moved to this UserFolder.
      Returns:
      true, if automove is enabled for this UserFolder

    • getId

      String getId()
      Returns the id of this UserFolder.
      Returns:
      the folders id.

    • getName

      String getName()
      Returns the name of this UserFolder.
      Returns:
      the folders name

    • getApplication

      Application getApplication()
      Returns the application of this folder.
      Returns:
      the folders Application

    • getOwner

      Persistent getOwner()
      Returns the owner of this folder.
      Returns:
      the folders Owner (usually a User)

    • getCreatedAt

      Date getCreatedAt()
      Returns the date when the folder was created.
      Returns:
      the folders creation date

    • getOrderAttr

      int getOrderAttr()
      Return the value of the folders order attribute.
      Returns:
      the folders order attribute value

    • contains

      boolean contains(ActivityInstance ai)
      Checks for membership of the provided ActivityInstance in this UserFolder
      Parameters:
      ai - the ActivityInstance to check for
      Returns:
      true, if the ActivityInstance is contained in the receiver

    • getContent

      List<ActivityInstance> getContent()
      Returns the elements of this folder.
      Returns:
      the folders content

    • size

      int size()
      Returns the number of elements in this folder.
      Returns:
      the number of elements in this folder

    • isEmpty

      boolean isEmpty()
      Returns true if this folder contains no elements.
      Returns:
      true if this folder contains no elements

    • add

      ActivityInstance add(ActivityInstance o)
      Adds the passed activity instance to the folder contents.
      Parameters:
      o - the object to be added
      Returns:
      the added object

    • remove

      boolean remove(ActivityInstance o)
      Removes the passed object from this folder.
      Returns:
      true if this collection changed as a result of the call