public class OpenObject extends XMLRequest
Constructor and Description |
---|
OpenObject(UC4ObjectName name)
Constructs a
OpenObject using the specified UC4 Object name. |
OpenObject(UC4ObjectName name,
boolean readOnly,
boolean fullObject)
Constructs a
OpenObject using the specified UC4 Object name. |
OpenObject(UserListItem user)
Opens a user object based on an entry in the user list of the system overview.
|
Modifier and Type | Method and Description |
---|---|
protected void |
createRequest(com.uc4.util.XMLDocument doc,
org.w3c.dom.Element request,
ConnectionAttributes sessionInfo)
Creates the XML Document for the request.
|
protected UC4Object |
getObjectForType(java.lang.String oType,
com.uc4.util.XMLDocument doc)
Returns a sub class of
UC4Object for the specified type. |
protected java.lang.String |
getSrc()
Returns the request source.
|
java.lang.String |
getType()
Returns the type of the object.
|
UC4Object |
getUC4Object()
Returns a subclass of
UC4Object or null if the
object could not be opened or is not supported. |
protected void |
handleContent(com.uc4.util.XMLDocument doc,
ConnectionAttributes session) |
protected boolean |
ignoreMessageBox() |
protected boolean |
isAllowedInClientZero()
This method is used internally.
|
assertClientZero, assertServerVersion, checkClient, checkID, checkLnr, checkNull, checkSelStatisticsPrivilege, checkSystemOverviewPrivilege, checkUC4ObjectEmptyName, checkUC4ObjectName, createNATFor, createNATRequest, emptyAttributes, getAllMessageBoxes, getMessageBox, getRequestID, handleResponse, send, setMessageBox, showQuarantineNotification
public OpenObject(UC4ObjectName name)
OpenObject
using the specified UC4 Object name.
The complete object is returned. The object can be modified.name
- name of the UC4 Objectpublic OpenObject(UserListItem user)
user
- Item of the user listpublic OpenObject(UC4ObjectName name, boolean readOnly, boolean fullObject)
OpenObject
using the specified UC4 Object name.
The parameter readOnly
is used to open the object read only.name
- name of the UC4 ObjectreadOnly
- true
if the object should be opened read onlyfullObject
- true
if the complete object should be returned.protected java.lang.String getSrc()
XMLRequest
getSrc
in class XMLRequest
public UC4Object getUC4Object()
UC4Object
or null
if the
object could not be opened or is not supported.
Note: Each object may only be opened once. Subsequent calls to OpenObject will return null here.
The object has to be closed with an CloseObject
request before another OpenObject request will succeed.
UC4Object
public java.lang.String getType()
protected void createRequest(com.uc4.util.XMLDocument doc, org.w3c.dom.Element request, ConnectionAttributes sessionInfo)
XMLRequest
createRequest
in class XMLRequest
doc
- Document, used to create new Elementsrequest
- Request Element - classes append information to this request elementsessionInfo
- Information about the sessionprotected void handleContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
handleContent
in class XMLRequest
protected UC4Object getObjectForType(java.lang.String oType, com.uc4.util.XMLDocument doc)
UC4Object
for the specified type. Sub
classes may override this method.oType
- Object typenull
if the type is not
implementedprotected boolean isAllowedInClientZero()
XMLRequest
XMLRequest
is allowed in client 0.
The default implementation returns false
, subclasses may override.isAllowedInClientZero
in class XMLRequest
true
if this request is allowed in client 0, false
otherwiseprotected boolean ignoreMessageBox()
ignoreMessageBox
in class XMLRequest