Package 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	Description
GetSyncMonitor(UC4ObjectName name)	Creates a new GetSyncMonitor.

Method Summary

Modifier and Type	Method	Description
protected void	createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)	Creates the XML Document for the request.
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.
protected java.lang.String	getSrc()	Returns the request source.
int	getValue()
protected void	handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)	Sub classes extract the values from the XML document and provide public getter methods.
boolean	hasWritePermission()	Returns the modify information.
protected boolean	isAllowedInClientZero()	This method is used internally.

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

assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, ignoreMessageBox, send, setMessageBox, showQuarantineNotification

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

createRequest

protected void createRequest(com.uc4.util.XMLDocument doc,
                             org.w3c.dom.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 java.lang.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

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

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