Package org.opencms.workflow

Class CmsWorkflowResources

  • public class CmsWorkflowResources
extends java.lang.Object
    Set of workflow resources, and an optional workflow.

    • Constructor Summary

      Constructors 
      Constructor Description
      CmsWorkflowResources​(java.util.List<CmsResource> workflowResources, CmsWorkflow overrideWorkflow, java.lang.Integer tooManyCount)
      Creates new instance.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      int getLowerBoundForSize()
      Gets a number that can be used as a lower bound for the number of publish resources if the list is too big (bigger than the workflow manager's resource limit).
      CmsWorkflow getOverrideWorkflow()
      Gets the override workflow, or null.
      java.lang.Integer getTooManyCount()
      Gets the approximate amount of resources if there are too many resources.
      java.util.List<CmsResource> getWorkflowResources()
      Returns the workflowResources.
      boolean isTooMany()
      Returns true if there are too many resources.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • CmsWorkflowResources

        public CmsWorkflowResources​(java.util.List<CmsResource> workflowResources,
                            CmsWorkflow overrideWorkflow,
                            java.lang.Integer tooManyCount)
        Creates new instance.

        Parameters:
        workflowResources - the workflow resources
        overrideWorkflow - the workflow to override the selected workflow
        tooManyCount - null if there are not too many resources, otherwise the approximate resource count

    • Method Detail

      • getLowerBoundForSize

        public int getLowerBoundForSize()
        Gets a number that can be used as a lower bound for the number of publish resources if the list is too big (bigger than the workflow manager's resource limit).
        Returns:
        a lower bound for the number of publish resources

      • getTooManyCount

        public java.lang.Integer getTooManyCount()
        Gets the approximate amount of resources if there are too many resources.

        Returns:
        the approximate amount of resources if there are too many

      • getWorkflowResources

        public java.util.List<CmsResource> getWorkflowResources()
        Returns the workflowResources.

        Note that if the isTooMany() method returns true, this method may return an empty list.

        Returns:
        the workflowResources

      • isTooMany

        public boolean isTooMany()
        Returns true if there are too many resources.

        Returns:
        true if there are too many resources