{"id":24618,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/ucuavalidateform-1\/"},"modified":"2024-02-15T14:53:34","modified_gmt":"2024-02-15T22:53:34","slug":"ucuavalidateform-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/","title":{"rendered":"ucUAValidateForm"},"content":{"rendered":"<h3>\n\tPurpose<\/h3>\n<p>This display is used on the user account administration screen. It is called to validate all of the form parameters returned from the user before database modifications are made.<\/p>\n<h3>\n\tApplies To<\/h3>\n<p>User Account Display<\/p>\n<h3>\n\tSignature<\/h3>\n<pre class=\"code\">\r\n<code>public boolean ucUAValidateForm( \r\n                      String mode, \r\n                      FormParameters fp,\r\n                      SecurityUser su,\r\n                      HttpServletRequest request,\r\n                      HttpServletResponse response,\r\n                      Connection dbconn,\r\n                      SesameSession session) throws Exception <\/code>\r\n<\/pre>\n<h3>\n\tNotes<\/h3>\n<p>For unsuccessful return, the ALERT attribute in the current session should be set. The form will be refreshed, resulting in an alert to the user.<\/p>\n<h3>\n\tExample<\/h3>\n<pre class=\"code\">\r\n<code>public boolean ucUAValidateForm(String mode,\r\n                                    FormParameters fp,\r\n                                    SecurityUser su,\r\n                                    HttpServletRequest request,\r\n                                    HttpServletResponse response,\r\n                                    Connection dbconn,\r\n                                    SesameSession session) throws Exception {\r\n\r\n        \/\/ Don't validate if the area\/role form parameter doesn't exist\r\n        \/\/ or if we don't have visible permission on these fields\r\n        \/\/ (in case of non-admin user editing account settings)\r\n        \/\/check security permissions\r\n\r\n        String mUser = session.getUserId();\r\n        int mArea = session.getArea();\r\n        int mProject = session.getProject();\r\n\r\n        boolean userUserGroupPerm = \r\n                   SecurityPermission.getObjectAccess(\r\n                                       \"UC_USER_USER_GROUP\",\r\n                                       SecurityPermission.WRITE,\r\n                                       mUser, mArea, mProject, session);\r\n        boolean userSecurityGroupPerm = \r\n                   SecurityPermission.getObjectAccess(\r\n                                       \"SE_SECURITY_GROUP\",\r\n                                        SecurityPermission.WRITE,\r\n                                        mUser, mArea, mProject, session);\r\n\r\n        if ((userUserGroupPerm &amp;&amp; userSecurityGroupPerm ) &amp;&amp; \r\n             fp.containsKey(\"p_area_role\")  ){\r\n\r\n\r\n        String[] roles = fp.getArray(\"p_user_group\");\r\n\r\n        \/\/ Create ArrayList from roles String array, can use ArrayList.contains() method later\r\n        ArrayList rolesList = new ArrayList();\r\n\r\n        for (int r = 0; r &lt; roles.length; r++)\r\n            rolesList.add(roles[r]);\r\n\r\n        String[] areaRoles = fp.getArray(\"p_area_role\");\r\n        String invalidRoles = null;\r\n\r\n        \/\/ Check that the area\/role mapping selected matches with the list\r\n        \/\/ of roles the user has access to\r\n        for (int i = 0; i &lt; areaRoles.length; i++) {\r\n\r\n            \/\/ Get the role id of this area\/role mapping\r\n            String value = areaRoles[i]; \/\/ formatted as \"<\/code><area_id><code>|<\/code><role_id><code>\"\r\n            int barIndex = value.indexOf('|');\r\n            String roleId = value.substring(barIndex + 1);\r\n\r\n            \/\/ Verify that this role is in the list of user's allowed roles,\r\n            \/\/ ignoring special none value\r\n            if (!roleId.equals(\"{NULL}\") &amp;&amp; !rolesList.contains(roleId)) {\r\n                if (invalidRoles == null)\r\n                    invalidRoles = roleId;\r\n                else\r\n                    invalidRoles += \", \" + roleId;\r\n            }\r\n        }\r\n\r\n        \/\/ If any invalid roles have been found, set the ALERT session attribute\r\n        if (invalidRoles != null) {\r\n            session.setAttribute(\"ALERT\", \"<script type='text\/javascript'>\\n\" +\r\n                                 \"alert('The following roles selected in the Area\/Role Mapping are not set for the user:\\\\n\" +\r\n                                 invalidRoles + \"');\\n\" +\r\n                                 \"<\/script>\\n\");\r\n            return false;\r\n        }\r\n        }\r\n        return true;\r\n    }\r\n<\/code><\/role_id><\/area_id><\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Purpose This display is used on the user account administration screen. It is called to validate all of the form parameters returned from the user before database modifications are made. Applies To User Account Display Signature public boolean ucUAValidateForm( String mode, FormParameters fp, SecurityUser su, HttpServletRequest request, HttpServletResponse response, Connection dbconn, SesameSession session) throws Exception&#8230;<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":24510,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-24618","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v25.1 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>ucUAValidateForm - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"ucUAValidateForm - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"Purpose This display is used on the user account administration screen. It is called to validate all of the form parameters returned from the user before database modifications are made. Applies To User Account Display Signature public boolean ucUAValidateForm( String mode, FormParameters fp, SecurityUser su, HttpServletRequest request, HttpServletResponse response, Connection dbconn, SesameSession session) throws Exception...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/\",\"name\":\"ucUAValidateForm - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"User Custom Guide\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Java Interface\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"User Custom Methods\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"ucUAValidateForm\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"ucUAValidateForm - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/","og_locale":"en_US","og_type":"article","og_title":"ucUAValidateForm - Product Documentation","og_description":"Purpose This display is used on the user account administration screen. It is called to validate all of the form parameters returned from the user before database modifications are made. Applies To User Account Display Signature public boolean ucUAValidateForm( String mode, FormParameters fp, SecurityUser su, HttpServletRequest request, HttpServletResponse response, Connection dbconn, SesameSession session) throws Exception...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/","og_site_name":"Product Documentation","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/","name":"ucUAValidateForm - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/ucuavalidateform-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"User Custom Guide","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/"},{"@type":"ListItem","position":4,"name":"Java Interface","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/"},{"@type":"ListItem","position":5,"name":"User Custom Methods","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/user-custom-guide-1\/java-interface-1\/user-custom-methods-1\/"},{"@type":"ListItem","position":6,"name":"ucUAValidateForm"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24618","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=24618"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24618\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/24510"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=24618"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}