Class SetAgentGroupProperties

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.SetAgentGroupProperties

public class SetAgentGroupProperties extends XMLRequest
Sets properties of agent group
  • Constructor Details

    • SetAgentGroupProperties

      public SetAgentGroupProperties(String agentGroupName)
      creates new instance of SetAgentGroupProperties. You need to create and send a GetAgentGroupProperties object first to get the current value. you might then override certain values with new content prior to sending the set request to the server.
      Parameters:
      agentGroupName - Name of the AgentGroup
  • Method Details

    • getSrc

      protected String getSrc()
      Description copied from class: XMLRequest
      Returns the request source. This method is used internally.
      Specified by:
      getSrc in class XMLRequest
      Returns:
      Source
    • createRequest

      protected void createRequest(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo)
      Description copied from class: XMLRequest
      Creates the XML Document for the request. This method is used internally.
      Specified by:
      createRequest in class XMLRequest
      Parameters:
      doc - Document, used to create new Elements
      request - Request Element - classes append information to this request element
      sessionInfo - Information about the session
    • isAllowedInClientZero

      protected boolean isAllowedInClientZero()
      Description copied from class: XMLRequest
      This method is used internally. Tests if this XMLRequest is allowed in client 0. The default implementation returns false, subclasses may override.
      Overrides:
      isAllowedInClientZero in class XMLRequest
      Returns:
      true if this request is allowed in client 0, false otherwise
    • isDirty

      public boolean isDirty()
      Returns true if the object data has changed
      Returns:
      boolean
    • setMaxJobs

      public void setMaxJobs(int maxJobs)
      Sets the maximum number of jobs for this Agent Group. The value -1 can be used to set max jobs to unlimited.
      Parameters:
      maxJobs - Positive Integer between 0 and 100000 or -1 for unlimited
    • setMaxFileTransfer

      public void setMaxFileTransfer(int maxFileTransfer)
      Sets the maximum number of file transfer for this Agent Group. The value -1 can be used to set max file transfer to unlimited.
      Parameters:
      maxFileTransfer - Positive Integer between 0 and 100000 or -1 for unlimited
    • setMaxReportBlocks

      public void setMaxReportBlocks(int maxReportBlocks)
      Sets the maximum number of report blocks for this Agent Group. The value -1 can be used to set max report blocks transfer to unlimited.
      Parameters:
      maxReportBlocks - Positive Integer between 0 and 10000 or -1 for unlimited
    • setCheckInterval

      public void setCheckInterval(int checkInterval)
      Sets the check interval for this Agent Group. The value -1 can be used to set check interval to unlimited.
      Parameters:
      checkInterval - Positive Integer between 0 and 32767 or -1 for unlimited