com.uc4.api.objects

Class Host

java.lang.Object

com.uc4.api.objects.UC4Object

com.uc4.api.objects.Host

public class Host
extends UC4Object

An instance of this class represents a single HOST object.

Constructor Summary

Constructors

Constructor and Description
Host()

Method Summary

Modifier and Type	Method and Description
HostAttributes	attributes()
Authorizations	authorizations() Returns the authorization data of this object.
java.lang.String	getSolutionDisplayText() Returns the display name of the RA Agent.
java.lang.String	getSolutionName() Returns the technical name of the RA solution.
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 RA values of the agent panel.
SAPAgentPanel	sapConnectionPanel() Returns the SAP Agent Panel or null if this HOST is not an SAP host.
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

Host

public Host()

Method Detail

loadContent

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

getSolutionName

public java.lang.String getSolutionName()

Returns the technical name of the RA solution.

Returns:

Solution name or null if this is not an RA Agent

getSolutionDisplayText

public java.lang.String getSolutionDisplayText()

Returns the display name of the RA Agent.

Returns:

User friendly name of the RA Solution with lower case characters or null if this is not an RA Agent

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

ocvValues

public OCVPanel ocvValues()

This method provides access to the RA values of the agent panel. If this Agent is not a RA Agent the return value is null.

Returns:

Values or null if this is not an RA Agent.

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

sapConnectionPanel

public SAPAgentPanel sapConnectionPanel()

Returns the SAP Agent Panel or null if this HOST is not an SAP host. This returned object can be used to read an set SAP Connection Objects for this HOST.

Returns:

SAP Agent Panel or null

authorizations

public Authorizations authorizations()

Returns the authorization data of this object. This is the information of the authorization tab in the dialog client. The authorizations can only be read and set in client 0. This method returns null if it's called in a client other than 0.

Returns:

Authorizations object or null if the object is not in client 0.

attributes

public HostAttributes attributes()

Returns:

Attributes of this HOST object

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.