Class ApplicationFacadeParmsDTO

  • All Implemented Interfaces:
    Cloneable

    public class ApplicationFacadeParmsDTO
    extends Object
    implements Cloneable
    A data transfer object to be the parameter of the method IFoundationBF.getNewApplicationFacade()
    • Field Summary

      Fields 
      Modifier and Type Field Description
      String acceptTechnology
      specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: CAPTAIN_CASA_APPLET or CAPTAIN_CASA_WEBSTART, VAADIN) if null a default technology is chosen
      String client
      The client of the new session.
      Boolean displayFullWorkplace
      true to display the complete workspace (central, user and info panel).
      Boolean displayStatusbar
      true to display statusbar, false
      Boolean displayTitlebar
      true to display header, false if ac should not show header
      Boolean isACEmbedded
      true to display header and statusbar, false if ac should be embedded in another
      String language
      The two letter ISO code of the language of the new session.
      Boolean openToTray
      Optional field, which may be set if application should be opened to tray (default: false) - currently not available for vaadin, will be ignored
      Integer preferredHeight
      Optional field, which may be set if preferred height of AF should be different from default.
      Integer preferredWidth
      Optional field, which may be set if preferred width of AF should be different from default.
      String productname
      Optional field, which may be set if productname differs from standard product name - only available when technology is set to CAPTAIN_CASA_* -
      String productShortName
      Optional field, which may be set if productShortName differs from standard product name
      String stylevariant
      customized styleVariant (one of DeployXnsgProperties.ProductStyleVariant for application facade
      String user
      The user of the new session.
      It is not required, that this user is a valid user name of the client.
    • Field Detail

      • client

        public String client
        The client of the new session. This should be a legal identCode of a client in the system.
        If it is NOT a legal identCode of a client in the system, the user will see a login prompt before he is able to see the application facade. (See IFoundationBF.getAllClients()).
        When the application facade web service call is authenticated, this value will be checked against the authentication data and the call is rejected if it does not match.
      • user

        public String user
        The user of the new session.
        It is not required, that this user is a valid user name of the client. However: Such a user may get granted only have the role "I_EVERYONE" unless XNSG is configured to use e.g. an LDAP server and the user can be found in the LDAP server with some roles granted to the user.
        No password is required because other servers which contact over the business facade will be trusted to have checked the users access rights. This enables a kind of "single sign on" between different e.g. XNSG servers.
      • language

        public String language
        The two letter ISO code of the language of the new session. Currently "de" and "en" are supported.
      • displayFullWorkplace

        public Boolean displayFullWorkplace
        true to display the complete workspace (central, user and info panel). Use false or null to display only the single ac.
      • isACEmbedded

        public Boolean isACEmbedded
        true to display header and statusbar, false if ac should be embedded in another
      • displayStatusbar

        public Boolean displayStatusbar
        true to display statusbar, false
      • displayTitlebar

        public Boolean displayTitlebar
        true to display header, false if ac should not show header
      • stylevariant

        public String stylevariant
        customized styleVariant (one of DeployXnsgProperties.ProductStyleVariant for application facade
      • acceptTechnology

        public String acceptTechnology
        specify which technology the clients wants to access the application; one token (or several, separated by semicolon) - the server may chose to ignore this possible tokens are specific for each server technology, XNSG-Servers currently honor strings from the GUIInvocationTechnology enum (e.g.: CAPTAIN_CASA_APPLET or CAPTAIN_CASA_WEBSTART, VAADIN) if null a default technology is chosen
      • productname

        public String productname
        Optional field, which may be set if productname differs from standard product name - only available when technology is set to CAPTAIN_CASA_* -
      • productShortName

        public String productShortName
        Optional field, which may be set if productShortName differs from standard product name
      • preferredWidth

        public Integer preferredWidth
        Optional field, which may be set if preferred width of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way
      • preferredHeight

        public Integer preferredHeight
        Optional field, which may be set if preferred height of AF should be different from default. Preferred height may not be always applyable but wins against workstation settings. - not available for vaadin, invoker must open browser in correct way
      • openToTray

        public Boolean openToTray
        Optional field, which may be set if application should be opened to tray (default: false) - currently not available for vaadin, will be ignored
    • Constructor Detail

      • ApplicationFacadeParmsDTO

        public ApplicationFacadeParmsDTO()