public class GetObjectProperties extends XMLRequest
Constructor and Description |
---|
GetObjectProperties(int oh_idnr)
Creates a new Request to get information about an UC4 object.
|
GetObjectProperties(UC4ObjectName name)
Creates a new Request to get information about an UC4 object.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getApplicationName()
Returns the name of the Application.
|
java.lang.String |
getArchiveKey1()
Returns the value of the first archive key.
|
java.lang.String |
getArchiveKey2()
Returns the value of the second archive key.
|
java.lang.String |
getComponentName()
Returns the name of the component.
|
UC4UserName |
getCreatedByUser()
Returns the name of the user who created the object.
|
DateTime |
getCreatedDate()
Returns the date and time when the object was created.
|
int |
getEstimatedRuntime()
Returns the estimated runtime in seconds.
|
java.lang.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. |
int |
getHomeFolderId()
Returns the OH_IDNR of the objects home folder.
|
UC4UserName |
getLastModifiedByUser()
Returns the name of the user that has done the last modification in the object.
|
DateTime |
getLastModifiedDate()
Returns the time stamp when the object was last modified.
|
int |
getModificationCount()
Returns the number of modifications on this object.
|
UC4ObjectName |
getName()
Returns the name of the Object.
|
ObjectAuthorizations |
getObjectAuthorizations()
Returns the
ObjectAuthorizations for the UC4 Object. |
java.lang.String |
getObjectType()
Returns the type of the UC4 Object or an empty String if the object does not exist.
|
UC4UserName |
getOpenByUser()
If the object is currently edited by a user this method will return
the name of the User.
|
DateTime |
getOpenSince()
Returns a
DateTime instance that contains the time when
the User started editing the object. |
java.lang.String |
getPlatform()
Returns the platform of the object.
|
java.lang.String |
getSubType()
Returns the sub-type of the object.
|
java.lang.String |
getTitle()
Returns the title of the UC4 Object.
|
java.lang.String |
getWorkflowName()
Returns the name of the Workflow.
|
boolean |
isApplicationWorkflow()
Returns
true if the type of this deployment ProcessFlow is application workflow. |
boolean |
isComponentWorkflow()
Returns
true if this workflow is a component workflow. |
boolean |
isNormalWorkflow()
Returns
true if this is a normal workflow which is has not been enabled for deployment. |
getMessageBox, getRequestID, handleResponse, send
public GetObjectProperties(UC4ObjectName name)
name
- Name of the UC4 Objectpublic GetObjectProperties(int oh_idnr)
oh_idnr
- OH_Idnrpublic java.lang.String getHomeFolder()
null
if the object does not exist or this request has not been sent.public boolean isComponentWorkflow()
true
if this workflow is a component workflow.public java.lang.String getApplicationName()
null
if this is not deployment ProcessFlowpublic java.lang.String getWorkflowName()
null
if this is not deployment ProcessFlowpublic boolean isApplicationWorkflow()
true
if the type of this deployment ProcessFlow is application workflow.
If this is a component workflow the return value is false
public java.lang.String getComponentName()
null
if this is not a component workflowpublic boolean isNormalWorkflow()
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.public int getHomeFolderId()
public int getEstimatedRuntime()
public java.lang.String getTitle()
public UC4UserName getCreatedByUser()
public UC4ObjectName getName()
public UC4UserName getLastModifiedByUser()
public DateTime getCreatedDate()
public DateTime getLastModifiedDate()
public int getModificationCount()
public java.lang.String getArchiveKey1()
public java.lang.String getArchiveKey2()
public UC4UserName getOpenByUser()
null
.public DateTime getOpenSince()
DateTime
instance that contains the time when
the User started editing the object.
If the object is not open the return value is null
.public java.lang.String getObjectType()
public ObjectAuthorizations getObjectAuthorizations()
ObjectAuthorizations
for the UC4 Object.public java.lang.String getSubType()
null
.public java.lang.String getPlatform()
null
.