Package com.uc4.api.objects

Class GenericConnection

java.lang.Object

com.uc4.api.objects.UC4Object

com.uc4.api.objects.GenericConnection

public class GenericConnection
extends UC4Object

This class represents an Generic Connection Object.

Constructor Summary

Constructors

Constructor	Description
GenericConnection()

Method Summary

Modifier and Type	Method	Description
String	get(String key)	Retrieves the value of a specific connection parameter.
Header	header()	Returns the header data of this object.
boolean	isExecutable()	Returns true if this Object can be executed.
protected void	loadContent(com.uc4.util.XMLDocument doc, ConnectionAttributes session)
OCVPanel	ocvValues()	This method provides access to the values of this Connection Object.
void	set(String key, String value)	Sets a specific connection parameter.
protected void	storeContent(com.uc4.util.XMLDocument doc, Element objectElement, ConnectionAttributes sessionInfo)

Methods inherited from class com.uc4.api.objects.UC4Object

docu, getAccess, getIdnr, getModCount, getName, getObjectClient, getType, isOldVersion, load, store, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GenericConnection

public GenericConnection()

Method Details

header

public Header header()

Returns the header data of this object. This is the information of the header tab in the dialog client.

Returns:

header

ocvValues

public OCVPanel ocvValues()

This method provides access to the values of this Connection Object. The returned object can be used to read, modify and add parameters.

Returns:

Values

set

public void set(String key,
 String value)

Sets a specific connection parameter.

This updates the underlying OCV (Object CIT Values) panel with the provided key-value pair. If the value is null, a NullPointerException will be thrown.

Parameters:

key - The name of the parameter to set.

value - The value to assign to the parameter (must not be null).

Throws:

NullPointerException - if the provided value is null.

get

public String get(String key)

Retrieves the value of a specific connection parameter.

If the key exists within the panel, its corresponding value is returned. If the key does not exist or the value is null, an empty string is returned.

Parameters:

key - The name of the parameter to retrieve.

Returns:

The value associated with the key, or an empty string if not found.

loadContent

protected void loadContent(com.uc4.util.XMLDocument doc,
 ConnectionAttributes session)

storeContent

protected void storeContent(com.uc4.util.XMLDocument doc,
 Element objectElement,
 ConnectionAttributes sessionInfo)

isExecutable

public boolean isExecutable()

Description copied from class: UC4Object

Returns true if this Object can be executed.

Specified by:

isExecutable in class UC4Object

Returns:

true if the Object can be executed, false if not.