Package com.uc4.communication.requests

Class AgentAndGroupList.AgentAndGroupListFilter

  • Enclosing class:
    AgentAndGroupList
    public static class AgentAndGroupList.AgentAndGroupListFilter
extends java.lang.Object
    Cut the result of the list by using this filter.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void excludeAgentGroups()
      Exclude agentgroups in the result.
      void excludeGenerics()
      Exclude generic agents in the result.
      void setAgentTypes​(java.lang.String... agentTypes)
      Filter for one or more agent types.
      void setMaxRows​(int maxRows)
      Used to limit the number of returned agents.
      void setSolution​(java.lang.String solution)
      Filter for a specific RA (CIT) solution.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • AgentAndGroupListFilter

        public AgentAndGroupListFilter()
        Constructs an empty filter

      • AgentAndGroupListFilter

        public AgentAndGroupListFilter​(java.lang.String nameFilter)
        Constructs a name filter. Wildcards "*" and "?" are allowed.
        Parameters:
        nameFilter - name of the agent or agentgroup.

    • Method Detail

      • setAgentTypes

        public void setAgentTypes​(java.lang.String... agentTypes)
        Filter for one or more agent types. Wildcards are not allowed in an agent type.
        Parameters:
        agentTypes - AE AgentTypes (e.g. WINDOWS, UNIX, BS2000)

      • setSolution

        public void setSolution​(java.lang.String solution)
        Filter for a specific RA (CIT) solution.
        Parameters:
        solution - name of the solution

      • excludeAgentGroups

        public void excludeAgentGroups()
        Exclude agentgroups in the result. Agentgroups are included by default.

      • excludeGenerics

        public void excludeGenerics()
        Exclude generic agents in the result. Generic agents are included by default.

      • setMaxRows

        public void setMaxRows​(int maxRows)
        Used to limit the number of returned agents. The value is ignored if it is larger than AGENT_LIST_LIMIT in UC_SYSTEM_SETTINGS.
        Parameters:
        maxRows - Maximum number of rows, value between 1 and AGENT_LIST_LIMIT.
        Throws:
        java.lang.IllegalArgumentException - if the value is negative or zero or larger than the allowed maximum AGENT_LIST_LIMIT: 20000