Class ReplaceObject

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

public class ReplaceObject extends XMLRequest
Replaces UC4 objects.
  • Constructor Details

    • ReplaceObject

      public ReplaceObject(GetReplaceList list)
      This request is used to replace the use of all selected objects provided by the GetReplaceList request.
      Parameters:
      list - Replace list
    • ReplaceObject

      public ReplaceObject(GetReplaceList list, List<String> itemsToReplace)
      This request is used to replace the use of selected objects
      Parameters:
      list - Replace list
      itemsToReplace - ID of items
    • ReplaceObject

      public ReplaceObject(GetReplaceList list, UC4ObjectName name, int replaceMax)
      Replaces an UC4 Object.
      Parameters:
      list - List of occurrence
      name - Name of the replacement
      replaceMax - Maximum number of replaces at once
    • ReplaceObject

      public ReplaceObject(UC4ObjectName oldName, String type, UC4ObjectName newName, SearchResultItem... results)
      Replaces an UC4 Object based on a search result.
      Parameters:
      oldName - Name of the object which should be replaced
      type - Object type, for example JOBS
      newName - Object name of the replacement
      results - Items to replace based on a search result (search for use)
  • Method Details

    • 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
    • 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