com.uc4.communication.requests

Class GetSyncMonitor

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.GetSyncMonitor

public class GetSyncMonitor
extends XMLRequest

This request can be used to read the current state and value of a SYNC object.

Constructor Summary

Constructors

Constructor and Description
GetSyncMonitor(UC4ObjectName name) Creates a new GetSyncMonitor.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCurrentState()
java.lang.String	getModifiedBy() Returns the user or task that modified this sync.
DateTime	getModifiedDate() Returns the last modification time of this SYNC.
int	getValue()
boolean	hasWritePermission() Returns the modify information.

Methods inherited from class com.uc4.communication.requests.XMLRequest

getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetSyncMonitor

public GetSyncMonitor(UC4ObjectName name)

Creates a new GetSyncMonitor.

Parameters:

name - Name of the Sync Object

Method Detail

getValue

public int getValue()

Returns:

The current value of the SYNC object

getCurrentState

public java.lang.String getCurrentState()

Returns:

The current state of the SYNC object

getModifiedDate

public DateTime getModifiedDate()

Returns the last modification time of this SYNC. This method returns null in AE versions before V12.

Returns:

DateTime or null if not supported.

Since:

V12

hasWritePermission

public boolean hasWritePermission()

Returns the modify information.

Returns:

true if the property can be changed and false if NOT.

Since:

V12

getModifiedBy

public java.lang.String getModifiedBy()

Returns the user or task that modified this sync.

Returns:

Source of the last modification. Example "SCRI.NEW.10(1174006)" or "UESR/DEPARTMENT" or null if not supported

Since:

V12