Class CloseObject

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

public class CloseObject extends XMLRequest
Closes an open UC4 Objekt.
  • Constructor Details

    • CloseObject

      public CloseObject(UC4Object object)
      Creates a new CloseObject If the UC4 Object is already closed this request should do nothing. In this case there is no error message.
      Parameters:
      object - UC4 Object which should be closed
    • CloseObject

      public CloseObject(Integer idnr)
      Creates a new CloseObject If the UC4 Object is already closed this request should do nothing. In this case there is no error message.
      Parameters:
      idnr - UC4 Object ID which should be closed
  • 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