com.uc4.api.objects

Class RAConnection

java.lang.Object

com.uc4.api.objects.UC4Object

com.uc4.api.objects.RAConnection

public class RAConnection
extends UC4Object

This class represents an RA Connection Object.

Constructor Summary

Constructors

Constructor and Description
RAConnection()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getConnectionName() Returns the technical name of the connection within the RA solution.
java.lang.String	getSolutionName() Returns the technical name of the RA solution which belongs to this connection.
UC4HostName	getTestAgentName() Returns the name of an RA Agent which is able to use this connection.
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.
protected void	storeContent(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement, ConnectionAttributes sessionInfo) Stores the object specific data under the objectElement element.

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RAConnection

public RAConnection()

Method Detail

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

getSolutionName

public java.lang.String getSolutionName()

Returns the technical name of the RA solution which belongs to this connection.

Returns:

Solution name

getConnectionName

public java.lang.String getConnectionName()

Returns the technical name of the connection within the RA solution.

Returns:

Template name

getTestAgentName

public UC4HostName getTestAgentName()

Returns the name of an RA Agent which is able to use this connection. This Agent will be used for testing the connection.

Returns:

Agent for testing the connection.

loadContent

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

storeContent

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

Description copied from class: UC4Object

Stores the object specific data under the objectElement element.

Parameters:

doc - XML Document, used to create subelements

objectElement - the newly created elements are children of the objectElement element

sessionInfo - Information about the current session

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.