Package com.axemble.vdoc.sdk.interfaces

Interface IViewController

All Superinterfaces:
IController, Serializable
All Known Implementing Classes:
PortalLibraryViewController, ProcessViewController
public interface IViewController extends IController
This class allows to create functional queries based on field values and scopes such as ICatalog, IWorkflowContainer, IWorkflow and ITask.
Since:
1.0, 15/04/2008
Author:
vlygeros
See Also:

  • Method Details

    • addEqualsConstraint

      void addEqualsConstraint(String name, Object value)
      Add equal constraint
      Parameters:
      name - the name
      value - the value

    • addNotEqualsConstraint

      void addNotEqualsConstraint(String name, Object value)
      Add not equal constraint
      Parameters:
      name - the name
      value - the value

    • addGreaterConstraint

      void addGreaterConstraint(String name, Object value)
      Add greater than constraint
      Parameters:
      name - the name
      value - the value

    • addGreaterOrEqualConstraint

      void addGreaterOrEqualConstraint(String name, Object value)
      Add greater than or equal constraint
      Parameters:
      name - the name
      value - the value

    • addLessConstraint

      void addLessConstraint(String name, Object value)
      Add less than constraint
      Parameters:
      name - the name
      value - the value

    • addLessOrEqualsConstraint

      void addLessOrEqualsConstraint(String name, Object value)
      Add less than or equal constraint
      Parameters:
      name - the name
      value - the value

    • addLikeConstraint

      void addLikeConstraint(String name, Object value)
      Add like constraint
      Parameters:
      name - the name
      value - the value

    • addNotLikeConstraint

      void addNotLikeConstraint(String name, Object value)
      Add not like constraint
      Parameters:
      name - the name
      value - the value

    • addInConstraint

      void addInConstraint(String name, Object value)
      Add in constraint
      Parameters:
      name - the name
      value - the value

    • addNotInConstraint

      void addNotInConstraint(String name, Object value)
      Add not in constraint
      Parameters:
      name - the name
      value - the value

    • addIsEmptyConstraint

      void addIsEmptyConstraint(String name, Object value)
      Add is empty constraint
      Parameters:
      name - the name
      value - the value

    • addIsNotEmptyConstraint

      void addIsNotEmptyConstraint(String name, Object value)
      Add is not empty
      Parameters:
      name - the name
      value - the value

    • setStart

      void setStart(int start)
      Sets the start page
      Parameters:
      start - the start index

    • setCount

      void setCount(int count)
      Sets the number of elements per page
      Parameters:
      count - the number of elements

    • setOrberBy

      @Deprecated void setOrberBy(String orberBy, Class<?> orderByType, boolean ascendant)
      Deprecated.
      Use setOrderBy instead

    • setOrderBy

      void setOrderBy(String orderBy, Class<?> orderByType, boolean ascendant)
      Sets order by and sort type properties
      Parameters:
      orderBy - the order name
      orderByType - the order type
      ascendant - the order direction (true for ascendant, false for descendant)

    • setStatus

      void setStatus(int status)
      Sets the required status
      Parameters:
      status - The status could be one of the following values:

    • evaluate

      Collection evaluate()
      Evaluate the request on the server scope
      Returns:
      The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

    • evaluate

      Collection evaluate(ICatalog catalog)
      Evaluate the request on the catalog scope
      Parameters:
      catalog - The ICatalog object.
      Returns:
      The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

    • evaluate

      Collection evaluate(IWorkflowContainer workflowContainer)
      Evaluate the request on the workflow container scope
      Parameters:
      workflowContainer - The IWorkflowContainer object.
      Returns:
      The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

    • evaluate

      Collection evaluate(IWorkflow workflow)
      Evaluate the request on the workflow scope
      Parameters:
      workflow - The IWorkflow object.
      Returns:
      The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

    • evaluate

      Collection evaluate(ITask task)
      Evaluate the request on the task scope
      Parameters:
      task - The ITask object.
      Returns:
      The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

    • evaluate

      Collection evaluate(IResourceDefinition resourceDefinition)
      Evaluate the request on the resource definition scope
      Parameters:
      resourceDefinition - The IResourceDefinition object.
      Returns:
      The returned value is a collection of IWorkflowInstance, ITaskInstance or IResource instances

    • evaluate

      Collection evaluate(ILibrary library)
      Evaluate the request on the library scope
      Parameters:
      library - The ILibrary object.
      Returns:
      The returned value is a collection of IFile instances

    • evaluateSize

      int evaluateSize()
      Evaluate the request on the server scope
      Returns:
      The number of elements

    • evaluateSize

      int evaluateSize(ICatalog catalog)
      Evaluate the request on the catalog scope
      Parameters:
      catalog - The ICatalog object.
      Returns:
      The number of elements

    • evaluateSize

      int evaluateSize(IWorkflowContainer workflowContainer)
      Evaluate the request on the workflow container scope
      Parameters:
      workflowContainer - The IWorkflowContainer object.
      Returns:
      The number of elements

    • evaluateSize

      int evaluateSize(IWorkflow workflow)
      Evaluate the request on the workflow scope
      Parameters:
      workflow - The IWorkflow object.
      Returns:
      The number of elements

    • evaluateSize

      int evaluateSize(ITask task)
      Evaluate the request on the task scope
      Parameters:
      task - The ITask object.
      Returns:
      The number of elements

    • evaluateSize

      int evaluateSize(IResourceDefinition resourceDefinition)
      Evaluate the request on the resource definition scope
      Parameters:
      resourceDefinition - The IResourceDefinition object.
      Returns:
      The number of elements

    • evaluateSize

      int evaluateSize(ILibrary library)
      Evaluate the request on the library scope
      Parameters:
      library - The ILibrary object.
      Returns:
      The returned value is a collection of IFile instances

    • setSecurityApplied

      void setSecurityApplied(boolean securityApplied)
      Specifies if the security should be applied.
      Parameters:
      securityApplied - true if the security should be applied, false otherwise.

    • setAllowSystemCatalogs

      void setAllowSystemCatalogs(boolean allowSystemCatalogs)
      Specifies if the system catalogs should be part of the result.
      Parameters:
      allowSystemCatalogs - true if the system ICatalog object should be part of the result, false otherwise.