com.uc4.communication.requests

Class OpenObject

java.lang.Object

com.uc4.communication.requests.XMLRequest

com.uc4.communication.requests.OpenObject

public class OpenObject
extends XMLRequest

Opens an existing UC4 Object.

Constructor Summary

Constructors

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.

Method Summary

Methods

Modifier and Type	Method and Description
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.

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

OpenObject

public OpenObject(UC4ObjectName name)

Constructs a OpenObject using the specified UC4 Object name. The complete object is returned. The object can be modified.

Parameters:

name - name of the UC4 Object

OpenObject

public OpenObject(UserListItem user)

Opens a user object based on an entry in the user list of the system overview.

Parameters:

user - Item of the user list

OpenObject

public OpenObject(UC4ObjectName name,
          boolean readOnly,
          boolean fullObject)

Constructs a OpenObject using the specified UC4 Object name. The parameter readOnly is used to open the object read only.

Parameters:

name - name of the UC4 Object

readOnly - true if the object should be opened read only

fullObject - true if the complete object should be returned.

Method Detail

getUC4Object

public UC4Object getUC4Object()

Returns a subclass of 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.

Returns:

subclass of UC4Object

getType

public java.lang.String getType()

Returns the type of the object.

Returns:

String containing the type of the uc4 object