de.tif.jacob.entrypoint
Class IGuiEntryPoint

java.lang.Object
  de.tif.jacob.entrypoint.IGuiEntryPoint

All Implemented Interfaces:

IEntryPoint

public abstract class IGuiEntryPoint
extends java.lang.Object
implements IEntryPoint

Field Summary

static java.lang.String	RCS_ID
static java.lang.String	RCS_REV

Constructor Summary

IGuiEntryPoint()

Method Summary

void	alert(java.lang.String message) Display an alert message on the user interface.
abstract void	enter(IClientContext context, java.util.Properties props)
abstract java.lang.String	getDomain()
abstract java.lang.String	getForm()
java.lang.String	getUrl(java.lang.String baseUrl, java.lang.String appId, java.util.Properties props) Deprecated. use EntryPointUrl.getUrl(SessionContext, IGuiEntryPoint, Properties, boolean) instead.
abstract boolean	hasNavigation()
abstract boolean	hasSearchBrowser()
abstract boolean	hasToolbar()

Methods inherited from class java.lang.Object

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

Field Detail

RCS_ID

public static final transient java.lang.String RCS_ID

See Also:

Constant Field Values

RCS_REV

public static final transient java.lang.String RCS_REV

See Also:

Constant Field Values

Constructor Detail

IGuiEntryPoint

public IGuiEntryPoint()

Method Detail

enter

public abstract void enter(IClientContext context,
                           java.util.Properties props)
                    throws java.lang.Exception

Throws:

java.lang.Exception

getDomain

public abstract java.lang.String getDomain()

Returns:

the domainId which you want see first

getForm

public abstract java.lang.String getForm()

Returns:

the formId which you want see first

hasNavigation

public abstract boolean hasNavigation()

Returns:

return false if you don't want see the domain&form navigation.

hasSearchBrowser

public abstract boolean hasSearchBrowser()

Returns:

false if you don't want see the SearchBrowser at the top.

hasToolbar

public abstract boolean hasToolbar()

Returns:

false if you don't want see the toolbar at the top.

alert

public final void alert(java.lang.String message)

Display an alert message on the user interface.

Parameters:

message - The message itself of the dialog box.

getUrl

public final java.lang.String getUrl(java.lang.String baseUrl,
                                     java.lang.String appId,
                                     java.util.Properties props)
                              throws java.lang.Exception

Deprecated. use EntryPointUrl.getUrl(SessionContext, IGuiEntryPoint, Properties, boolean) instead.

The returned URL is the common access URL for this EntryPoint. If you call this URL, the EntryPoint will be called by the system.

Parameters:

baseUrl - the base URL of the jACOB server (like http://123.43.11.11:8080/jacob/ )

appId - the application in which the EntryPoint is

props - additional Properties which should hand over to the entryPoint.

Returns:

the access URL for this EntryPoint

Throws:

java.lang.Exception