Package com.uc4.communication.requests

Class GetObjectProperties

java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.GetObjectProperties
public class GetObjectProperties extends XMLRequest
Returns information about an UC4 object. This request can also be used to test if an object exists. If the object does not exist in the currently connected client, client 0 will also be checked, when UC_SYSTEM_SETTINGS - OBJECT_ACCESS_CLIENT_ZERO is set to Y.

  • Constructor Details

    • GetObjectProperties

      public GetObjectProperties(UC4ObjectName name)
      Creates a new Request to get information about an UC4 object.
      Parameters:
      name - Name of the UC4 Object

    • GetObjectProperties

      public GetObjectProperties(int ohIdnr)
      Creates a new Request to get information about an UC4 object.
      Parameters:
      ohIdnr - OH_Idnr

  • Method Details

    • getID

      public String getID()
      Get the internal object oh_idnr
      Returns:
      The object oh_idnr

    • 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

    • 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

    • handleContent

      protected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
      Description copied from class: XMLRequest
      Sub classes extract the values from the XML document and provide public getter methods.
      Overrides:
      handleContent in class XMLRequest
      Parameters:
      doc - XML Document
      session - Info about the user session

    • getHomeFolder

      public String getHomeFolder()
      Returns the path to the folder where the Objects exists or null if the object does not exist or this request has not been sent.
      Returns:
      Folder

    • isComponentWorkflow

      public boolean isComponentWorkflow()
      Returns true if this workflow is a component workflow.
      Returns:
      Component Workflow?

    • getApplicationName

      public String getApplicationName()
      Returns the name of the Application.
      Returns:
      Application or null if this is not deployment ProcessFlow

    • getWorkflowName

      public String getWorkflowName()
      Returns the name of the Workflow.
      Returns:
      Workflow or null if this is not deployment ProcessFlow

    • isApplicationWorkflow

      public boolean isApplicationWorkflow()
      Returns true if the type of this deployment ProcessFlow is application workflow. If this is a component workflow the return value is false
      Returns:
      Application Workflow?

    • getComponentName

      public String getComponentName()
      Returns the name of the component.
      Returns:
      Component name or null if this is not a component workflow

    • isNormalWorkflow

      public boolean isNormalWorkflow()
      Returns true if this is a normal workflow which is has not been enabled for deployment. If the return value is false the workflow is either an application workflow or a component workflow.
      Returns:
      Normal Workflow?

    • getHomeFolderId

      public int getHomeFolderId()
      Returns the OH_IDNR of the objects home folder.
      Returns:
      ID of the home folder

    • getEstimatedRuntime

      public int getEstimatedRuntime()
      Returns the estimated runtime in seconds. The estimated runtime (ERT) is the expected time for the next execution of a task. The ERT itself is calculated from the real runtime (RRT) of the last 25 properly executed task runs. It is the central value for dynamic runtime monitoring calculations, for making forecasts, and for calculating the most recent ending of a task.
      Returns:
      Estimated runtime in seconds

    • getTitle

      public String getTitle()
      Returns the title of the UC4 Object.
      Returns:
      Title

    • getCreatedByUser

      public UC4UserName getCreatedByUser()
      Returns the name of the user who created the object.
      Returns:
      Name of the creator

    • getCreatedByFullName

      public String getCreatedByFullName()
      Returns the full name of the user who created the object.
      Returns:
      Full Name of the creator

    • getName

      public UC4ObjectName getName()
      Returns the name of the Object.
      Returns:
      Name

    • getLastModifiedByUser

      public UC4UserName getLastModifiedByUser()
      Returns the name of the user that has done the last modification in the object.
      Returns:
      User that modified the object

    • getLastModifiedByFullName

      public String getLastModifiedByFullName()
      Returns the full name of the user that has done the last modification in the object.
      Returns:
      Full Name of the user that modified the object

    • getCreatedDate

      public DateTime getCreatedDate()
      Returns the date and time when the object was created.
      Returns:
      Date and Time of object creation

    • getLastModifiedDate

      public DateTime getLastModifiedDate()
      Returns the time stamp when the object was last modified.
      Returns:
      Date time of the last modification

    • getModificationCount

      public int getModificationCount()
      Returns the number of modifications on this object.
      Returns:
      Number of modifications

    • getLastUsedByUser

      public UC4UserName getLastUsedByUser()
      Returns the name of the user that has used the object at least. (value only available for executable objects)
      Returns:
      User that used the object

    • getLastUsedByFullName

      public String getLastUsedByFullName()
      Returns the full name of the user that has used the object at least. (value only available for executable objects)
      Returns:
      Full Name of the user that used the object

    • getLastUsedDate

      public DateTime getLastUsedDate()
      Returns the time stamp when the object was last used. (value only available for executable objects)
      Returns:
      Date time of the last usage

    • getUsageCount

      public int getUsageCount()
      Returns the number of usages on this object. (value only available for executable objects)
      Returns:
      Number of usages

    • getArchiveKey1

      public String getArchiveKey1()
      Returns the value of the first archive key.
      Returns:
      Archive Key 1

    • getArchiveKey2

      public String getArchiveKey2()
      Returns the value of the second archive key.
      Returns:
      Archive Key 2

    • getOpenByUser

      public UC4UserName getOpenByUser()
      If the object is currently edited by a user this method will return the name of the User. If the object is not open the return value is null.
      Returns:
      User that is currently editing the object

    • getOpenSince

      public DateTime getOpenSince()
      Returns a DateTime instance that contains the time when the User started editing the object. If the object is not open the return value is null.
      Returns:
      Date and time since the object is beeing edited

    • getObjectType

      public String getObjectType()
      Returns the type of the UC4 Object or an empty String if the object does not exist.
      Returns:
      UC4 object type.

    • getObjectAuthorizations

      public ObjectAuthorizations getObjectAuthorizations()
      Returns the ObjectAuthorizations for the UC4 Object.
      Returns:
      ObjectAuthorizations

    • getSubType

      public String getSubType()
      Returns the sub-type of the object. If there is no sub-type specified the return value is null.
      Returns:
      subtype or null

    • getPlatform

      public String getPlatform()
      Returns the platform of the object. If there is no platform specified the return value is null.
      Returns:
      platform or null

    • 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

    • getClient

      public int getClient()
      Returns the client of the object. If no client is determined, it returns -1.
      Returns:
      client