Package com.uc4.communication.requests
Class GetReplaceList
- java.lang.Object
-
- com.uc4.communication.requests.XMLRequest
-
- com.uc4.communication.requests.GetReplaceList
-
public class GetReplaceList extends XMLRequest
Returns list of UC4 Objects in which the specified UC4 Object is used.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetReplaceList.ReplaceListItem
Represents an item in the replace list.
-
Constructor Summary
Constructors Constructor Description GetReplaceList(UC4ObjectName obj)
Creates a newGetReplaceList
request to replace the specified object.GetReplaceList(RenameObject rename)
Creates a newGetReplaceList
request using the specifiedRenameObject
instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
appendRows(com.uc4.util.XMLDocument doc, org.w3c.dom.Element result, int startFrom, int replaceMax)
Deprecated.Do not use it.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
getCountDescription()
Returns the description of the item count.UC4ObjectName
getObjName()
Returns the name of the AE Object.java.lang.String
getPlatform()
Returns the information about the platform.protected org.w3c.dom.Element
getReplaceElement()
java.util.List<GetReplaceList.ReplaceListItem>
getReplaceList()
Returns the list of items to replace.protected java.lang.String
getSrc()
Returns the request source.java.lang.String
getType()
Returns the type of the AE Object.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
hasMore()
There is more to replace.protected boolean
isAllowedInClientZero()
This method is used internally.int
size()
Returns the number of items.-
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 Detail
-
GetReplaceList
public GetReplaceList(RenameObject rename)
Creates a newGetReplaceList
request using the specifiedRenameObject
instance. TheRenameObject
instance must already be executed and its return value must be message box with the number 4005704. This message number means that the object which should renamed is used in other objects. The newly created instance ofGetReplaceList
can be used to get the list of these objects.- Parameters:
rename
- Already executed RenameObject request
-
GetReplaceList
public GetReplaceList(UC4ObjectName obj)
Creates a newGetReplaceList
request to replace the specified object. The returned list does not actually replace the object. this is done using the requestReplaceObject
- Parameters:
obj
- Name of the object to replace
-
-
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 classXMLRequest
- Parameters:
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- 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 classXMLRequest
- 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 classXMLRequest
- Parameters:
doc
- XML Documentsession
- Info about the user session
-
getPlatform
public java.lang.String getPlatform()
Returns the information about the platform.- Returns:
- The platform information.
-
getReplaceList
public java.util.List<GetReplaceList.ReplaceListItem> getReplaceList()
Returns the list of items to replace.- Returns:
- A list of items to replace.
-
getReplaceElement
protected org.w3c.dom.Element getReplaceElement()
-
size
public int size()
Returns the number of items.- Returns:
- Number of items.
-
getCountDescription
public java.lang.String getCountDescription()
Returns the description of the item count.- Returns:
- Description of the item count.
-
appendRows
@Deprecated public void appendRows(com.uc4.util.XMLDocument doc, org.w3c.dom.Element result, int startFrom, int replaceMax)
Deprecated.Do not use it. Internal only.- Parameters:
doc
- XML documentresult
- DOM element (not described here)startFrom
- See AWI sourcereplaceMax
- See AWI source
-
getObjName
public UC4ObjectName getObjName()
Returns the name of the AE Object.- Returns:
- Name
-
getType
public java.lang.String getType()
Returns the type of the AE Object.- Returns:
- Type
-
hasMore
public boolean hasMore()
There is more to replace.- Returns:
- True if more objects can be replaced
-
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
-
-