de.tif.jacob.entrypoint
Class EntryPointUrl

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

public class EntryPointUrl
extends java.lang.Object

The URL to a dedicated entry point to a jACOB application.
You can create a URL for a GUI base EntryPoint or to Cmd (command) base entry Point.
usage:

      Properties props=new Properties();
      props.setProperty("template",(String)name2templates.get(userSelection));
      props.setProperty("pkey",call.getStringValue("pkey"));
      EntryPointUrl.show(context,new MyGuiEntryPoint(),props);
  

Field Summary

static de.tif.jacob.entrypoint.EntryPointUrl.EntryPointType	ENTRYPOINT_CMD
static de.tif.jacob.entrypoint.EntryPointUrl.EntryPointType	ENTRYPOINT_GUI

Constructor Summary

EntryPointUrl(de.tif.jacob.entrypoint.EntryPointUrl.EntryPointType type, java.lang.String entryName, java.util.Properties props)
Deprecated. This method will be protected in the next release. Use the static methods 'popup(...)' and 'show(...)' to work with entry points.

Method Summary

static java.lang.String	getUrl(SessionContext context, ICmdEntryPoint entry, java.util.Properties props, boolean useVersion) Constructs the entry point URL for a given command entry point.
static java.lang.String	getUrl(SessionContext context, IGuiEntryPoint entry, java.util.Properties props, boolean useVersion) Constructs the entry point URL for a given GUI entry point.
void	popup(IClientContext context) Deprecated. use the static method 'popup(...)'
static void	popup(IClientContext context, ICmdEntryPoint entry, java.util.Properties props) Show the hands over EntryPoint.
static void	popup(IClientContext context, IGuiEntryPoint entry, java.util.Properties props) Show the hands over EntryPoint.
static void	popup(IClientContext context, IGuiEntryPoint entry, java.util.Properties props, int height, int width) Show the hands over EntryPoint.
void	popup(IClientContext context, int width, int height) Deprecated. use the static method popup
void	show(IClientContext context) Deprecated. use the static method 'show(...)'
java.lang.String	toURL(SessionContext context) Deprecated. This method will be protected in the next release. Use the static methods 'popup(...)' and 'show(...)' to handle entry points.

Methods inherited from class java.lang.Object

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

Field Detail

ENTRYPOINT_GUI

public static final de.tif.jacob.entrypoint.EntryPointUrl.EntryPointType ENTRYPOINT_GUI

ENTRYPOINT_CMD

public static final de.tif.jacob.entrypoint.EntryPointUrl.EntryPointType ENTRYPOINT_CMD

Constructor Detail

EntryPointUrl

public EntryPointUrl(de.tif.jacob.entrypoint.EntryPointUrl.EntryPointType type,
                     java.lang.String entryName,
                     java.util.Properties props)

Deprecated. This method will be protected in the next release. Use the static methods 'popup(...)' and 'show(...)' to work with entry points.

Parameters:

type -

entryName -

props -

Method Detail

getUrl

public static java.lang.String getUrl(SessionContext context,
                                      ICmdEntryPoint entry,
                                      java.util.Properties props,
                                      boolean useVersion)

Constructs the entry point URL for a given command entry point.

Parameters:

context - the current session context

entry - the desired command entry point

props - the entry point properties

useVersion - if set to true the entry point will only succeed for the current application version, otherwise the entry point will enter the most resent version of the application.

Returns:

the URL to call the entry point from a http client

getUrl

public static java.lang.String getUrl(SessionContext context,
                                      IGuiEntryPoint entry,
                                      java.util.Properties props,
                                      boolean useVersion)

Constructs the entry point URL for a given GUI entry point.

Parameters:

context - the current session context

entry - the desired GUI entry point

props - the entry point properties

useVersion - if set to true the entry point will only succeed for the current application version, otherwise the entry point will enter the most resent version of the application.

Returns:

the URL to call the entry point from a http client

popup

public static void popup(IClientContext context,
                         ICmdEntryPoint entry,
                         java.util.Properties props)

Show the hands over EntryPoint.
example:

      Properties props=new Properties();
      props.setProperty("template",(String)name2templates.get(userSelection));
      props.setProperty("pkey",call.getStringValue("pkey"));
      EntryPointUrl.popup(context,new MyCmdEntryPoint(),props);
    

Parameters:

context -

entry -

props -

popup

public static void popup(IClientContext context,
                         IGuiEntryPoint entry,
                         java.util.Properties props,
                         int height,
                         int width)

Show the hands over EntryPoint.
example:

      Properties props=new Properties();
      props.setProperty("template",(String)name2templates.get(userSelection));
      props.setProperty("pkey",call.getStringValue("pkey"));
      EntryPointUrl.show(context,new MyGuiEntryPoint(),props, 300,400);
    

Parameters:

context - the curent working context

entry - an instance of the GuiEntryPoint

props - any properties which will be hands over to the entry point.

width - the width of the new screen

height - the height of the new screen

popup

public static void popup(IClientContext context,
                         IGuiEntryPoint entry,
                         java.util.Properties props)

Show the hands over EntryPoint.
example:

      Properties props=new Properties();
      props.setProperty("template",(String)name2templates.get(userSelection));
      props.setProperty("pkey",call.getStringValue("pkey"));
      EntryPointUrl.show(context,new MyGuiEntryPoint(),props);
    

Parameters:

context - the current working context

entry - an instance of the GuiEntryPoint

props - any properties which will be hands over to the entry point.

popup

public void popup(IClientContext context,
                  int width,
                  int height)

Deprecated. use the static method popup

Open a new window with the handsover size and display the EntryPoint

Parameters:

context - the current working context

width - the width of the new screen

height - the height of the new screen

popup

public void popup(IClientContext context)

Deprecated. use the static method 'popup(...)'

Open a new window and display the EntryPoint

Parameters:

context -

show

public void show(IClientContext context)

Deprecated. use the static method 'show(...)'

Use the current window and replace the content with the content of the EntryPoint.

Parameters:

context -

toURL

public java.lang.String toURL(SessionContext context)

Deprecated. This method will be protected in the next release. Use the static methods 'popup(...)' and 'show(...)' to handle entry points.