Package com.uc4.communication.requests
Class GetSyncMonitor
java.lang.Object
com.uc4.communication.requests.XMLRequest
com.uc4.communication.requests.GetSyncMonitor
This request can be used to read the current state and value
of a SYNC object.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
createRequest
(com.uc4.util.XMLDocument doc, Element request, ConnectionAttributes sessionInfo) Creates the XML Document for the request.Returns the user or task that modified this sync.Returns the last modification time of this SYNC.protected 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
Returns the modify information.protected boolean
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
-
Constructor Details
-
GetSyncMonitor
Creates a newGetSyncMonitor
.- Parameters:
name
- Name of the Sync Object
-
-
Method Details
-
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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the session
-
getSrc
Description copied from class:XMLRequest
Returns the request source. This method is used internally.- Specified by:
getSrc
in classXMLRequest
- Returns:
- Source
-
handleContent
Description copied from class:XMLRequest
Sub classes extract the values from the XML document and provide public getter methods.- Overrides:
handleContent
in classXMLRequest
- Parameters:
doc
- XML Documentsession
- Info about the user session
-
getValue
public int getValue()- Returns:
- The current value of the SYNC object
-
getCurrentState
- Returns:
- The current state of the SYNC object
-
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
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 thisXMLRequest
is allowed in client 0. The default implementation returnsfalse
, subclasses may override.- Overrides:
isAllowedInClientZero
in classXMLRequest
- Returns:
true
if this request is allowed in client 0,false
otherwise
-