Page Comparison

Table of Contents

Getting Started

How to create a page

First of all, create a page in XHTML file format, a file with a .xhtml extension and declared the necessary Namespaces.

Code Block

language	xml

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"
      xmlns:ui="http://xmlns.jcp.org/jsf/facelets"
      xmlns:p="http://primefaces.org/ui"
	  xmlns:f="http://java.sun.com/jsf/core"
	  xmlns:pt="http://xmlns.jcp.org/jsf/passthrough"
	  xmlns:h="http://java.sun.com/jsf/html"
	  xmlns:fn="http://java.sun.com/jsp/jstl/functions"
      xmlns:c="http://java.sun.com/jsp/jstl/core"
	  xmlns:crm="http://java.sun.com/jsf/composite/crm">

</html>

Define the template of the page in a ui:composition tag.

Code Block

language	xml

<ui:composition template=""></ui:composition>

...

Tag Library	URI	Prefix	Contents
XHTML namespace	http://www.w3.org/1999/xhtml		Tags for xhtml
JavaServer Faces Facelets Tag Library	http://xmlns.jcp.org/jsf/facelets	ui:	Tags for templating
PrimeFaces components	http://primefaces.org/ui	p:	Tags for PrimeFaces components
JavaServer Faces Core Tag Library	http://java.sun.com/jsf/core	f:	Tags for JavaServer Faces custom actions that are independent of any particular render kit
Pass-through Attributes Tag Library	http://xmlns.jcp.org/jsf/passthrough	p:	Tags to support HTML5-friendly markup
JavaServer Faces HTML Tag Library	http://java.sun.com/jsf/html	h:	JavaServer Faces component tags for all UIComponent objects
JSTL Functions Tag Library	http://java.sun.com/jsp/jstl/functions	fn:	JSTL 1.2 Functions Tags
JSTL Core Tag Library	http://java.sun.com/jsp/jstl/core	c:	JSTL 1.2 Core Tags
CRM Composite Components Tag Library	http://java.sun.com/jsf/composite/crm	crm:	Tags for CRM Components

...

A typical JavaServer Faces application includes one or more managed beans, each of which can be associated with the components used in a particular page.

A managed bean for summary pages must extend SummaryView class and for data entry pages must extend DataEntryView class.

Code Block

language	java

@ManagedBean(name = "summaryManagedBeanView", eager = true)
@ViewScoped
public class SummaryManagedBeanView extends SummaryView {

}

@ManagedBean(name = "dataEntryManagedBeanView", eager = true)
@ViewScoped
public class DataEntryManagedBeanView extends DataEntryView{

}

Class SummaryView

SummaryView class implements commonly used functions Commonly Used Functions for summary pages.

Class DataEntryView

DataEntryView class implements commonly used functions implements Commonly Used Functions for data entry pages.

The below list shows functions that can be used from data entry pages:

Expand

title	public void addCustomFields()

This method add adds custom fields on the page.

Expand

title	public List<SelectItem> getDefinedLanguageOptions()

This method loads the language optionsreturns a list of languages.

Expand

title	public String getEditorSuggestions(String entityID,String entityTags)

This method method returns a list of editor suggestions based on the specified entity and entity tags.

Expand

title	public String getEditorSuggestionsList<SelectItem> getOptionsFromString(String entityID,String entityTagsoptions)

This method method returns a list of options from the specified semicolon-seperated String.

Expand

title	public List<SelectItem> getOptionsFromStringBoolean isGooglePlacesAutocompleteEnable(String options)

This method method returns if the google places autocomplete for address registry is enabled, otherwise false.

Expand

title	public List<SelectItem> getOptionsFromStringBoolean isInternationalAddressFormatEnabled(String options)

This method method returns true if the international address format is enabled, otherwise false.

Expand

title	public List<SelectItem> getOptionsFromStringBoolean isModuleRestricted(String optionsmoduleid)

This method

Expand

method returns true if the module with the specified id is restricted, otherwise false.

Expand

title	public Boolean isGooglePlacesAutocompleteEnablevoid onload()

This method method initialize page parameters and is executed on GET request of a page.

Expand

title	public Boolean isInternationalAddressFormatEnabledList<CRMDO> searchCountry(String searchValue)

This method method returns a list of countries where country name starts with the specified search value.

Expand

title	public Boolean isModuleRestricted(String moduleid)

This method

Expand

title	public void onload()

This method

Expand

title	public List<CRMDO> searchCountry(String searchValue)

This method

Expand

title	public void setGoogleAddress(CRMDOContactInfoAddress contactInfoAddress)

This method method sets the google address of a contact info address.

Expand

title	public CRMDO setMandatoryField(CRMDO dto, String xPath, String value)

This method method sets as mandatory the field of the specified data object based on the specified xPath and value.

Expand

title	public void setTranslations()

This method method sets the translations of the page's data object.

Expand

title	public void setTranslations(CRMDO dto)

This method method sets the translations of the specified data object

Commonly

...

Used Functions

The below list shows functions that can be used both from summary and data entry pages:

Expand

title	public void createArchivedFile(String id)

This method ...creates an archive file with the specified id.

Expand

title	public Boolean exists(ArrayList<CRMDO> dtoList, CRMDO dto)

This method indicates returns true if the specified data object exists in the specified list, otherwise false.

Expand

title	public ArrayList<CRMDO> filterDeleted(ArrayList<CRMDO> records)

This method method returns a list of non delete items of the specified list.

Expand

title	public Set filterDeletedSet(Set records)

This method

Expand

title	public void findNode(TreeNode node,CRMDO crmdo)

This method

method returns a list of non deleted items of the specified set.

Expand

title	public String formatAmount(CRMDOCurrency currency, BigDecimal amount)

This method

Expand

method formats the specified amount to a . The format of the resulting String is [currency prefix] [amount].

If no currency is specified then the system default currency is used.

The default scale of the amount is 2.

This method

Expand

title	public String formatAmount(CRMDOCurrency currency, BigDecimal amount, Boolean showCurrency, Integer scale)

, BigDecimal amount, Boolean showCurrency)

This method formats the specified amount to a String. The format of the resulting String is:

[currency prefix] [amount] If showCurrency parameter is true, otherwise
[amount]

If no currency is specified then the system default currency is used.

The default scale of the amount is 2.

Expand

title	public String formatAmount(CRMDOCurrency currency, BigDecimal amount, Boolean showCurrency, Integer scale)

This method formats the specified amount to a String. The format of the resulting String is:

[currency prefix] [amount] If showCurrency parameter is true, otherwise
[amount]

If no currency is specified then the system default currency is used.

If no scale is specified then the default scale of the amount is 2.

Expand

title	public Object formatDate(Object date)

This method method formats the specified date to a String based on the configured system date format.

Expand

title	public Object formatDateTime(Object date)

This method method formats the specified date time to a String based on the configured system date time format.

Expand

title	public Object formatDateTime(Object date, String format)

This method method formats the specified date time to a String based on the specified format.

Expand

title	public String formatSearchFilter(String searchFilter)

This method method formats the specified String, removing special characters such as % and _.

Expand

title	public TreeNode generateTree(ArrayList<CRMDO> categories)

This method

Expand

title	public TreeNode generateTree(ArrayList<CRMDO> categories)

This method method generates a tree based on the specified list.

Expand

title	public List<Object> getActiveInactiveOptions()

This method loads the active/inactive optionsmethod returns a list of two options: Active and Inactive.

This method

Expand

title	public String getAllowedFileTypes()

String getAllowedFileTypes()

This method returns a String of allowed file types. The format of the resulting String is: /(\\.|\\/)([comma-seperated file extensions])$/

Expand

title	public List<SelectItem> getApplicationServerScopeOptions()

This method loads the returns a list of allowed application server scope optionsscopes.

Expand

title	public List<SelectItem> getApplicationServersOptions()

This method loads the application server optionsmethod returns a list of allowed application servers.

Expand

title	public List<SelectItem> getBillingTermSchemeCodeOptions()

This method loads the method returns a list of billing term scheme code optionscodes.

Expand

title	public List<SelectItem> getBillingTermSchemeCodeOptions(BillType billType)

This method method returns a list of billing term scheme codes based on the specified bill type.

Expand

title	public ArrayList<CRMDO> getBillingTermSchemeOptions()

This method loads the method returns a list of billing term scheme code optionsschemes.

Expand

title	public List<SelectItem> getCountryOptions()

This method loads the country optionsmethod returns a list of countries.

Expand

title	public List<SelectItem> getCurrencyOptions()

This method loads the currency optionsmethod returns a list of currencies.

Expand

title	public Date getCurrentDate()

This method returns the current date without milliseconds;.

Expand

title	public String getCurrentYear()

This method returns the current year.

...

Expand

title	public String getDateFormat()

This method method returns a String for the configured system date format.

This method

Expand

title	public String getDateTimeFormat()

)

This method returns a String for the configured system date time format.

Expand

title	public String getDayOfWeekLabel(Integer dayOfWeek)

This method method returns the day-of-week label of the specified Int value.

Expand

title	public List<SelectItem> getDaysOfMonthOptions()

This method method returns a list of days of months.

Expand

title	public String getDecimalSeperatorSymbol()

This method method returns the configued system decimal seperator symbol.

Expand

title	public String getDefaultHomePageName(String defaultHomePageId)

This method

String defaultHomePageId)

This method returns the default home page name based on the specified page id.

Expand

title	public List<SelectItem> getHomePageOptions()

This method loads the home page optionsreturns a list of home pages.

Expand

title	public List<SelectItem> getHourOptions()

This method loads the returns a list of hour options.

Expand

title	public List<SelectItem> getJobTypeOptions()

This method loads the method returns a list of job type options.

Expand

title	public List<SelectItem> getLanguageOptions()

This method loads the language optionsmethod returns a list of languages.

Expand

title	public String getMaxFileSize()

This method method return a String of the configured system maximum file size.

Expand

title	public String getMenuoption(List<Menuoption> menuoptions, String menuoptionid)

This method method returns the menu option with the specified id that exists in the specified list.

Expand

title	public List<SelectItem> getMinuteOptions()

This method loads the minute optionsreturns a list of minutes.

Expand

title	public List<SelectItem> getMinuteOptions(Integer number)

This method loads the returns a list of minutes with the specified interval number between minute options.

Expand

title	public String getMonthLabel(Integer month)

This method returns the month label of the specified Int value.

Expand

title	public List<SelectItem> getMonthNumberOptions()

This methodThis method returns a list of month numbers.

Expand

title	public List<SelectItem> getMonthOptions()

This method returns a list of months.

Expand

title	public List<SelectItem> getNormalBillingTermSchemeCodeOptions()

This method loads the returns a list of normal billing term scheme code optionscodes.

Expand

title	public String getNumberOfDecimalDigits()

This method

Expand

title	public String getPath(CRMSession ejbSession)

This method

Expand

title	public String getPaymentGatewayCardBrandIcon(String brand)

This method method returns a String of the configured system number of decimal digits.

Expand

title	public String getPeriodOrdinalIndicatorgetPaymentGatewayCardBrandIcon(String periodbrand)

This method method return an icon class of the specified payment gateway card brand.

Expand

title	public ArrayList<SelectItem> getProductCriterionTypeOptions()

This method returns the a list of product criterion type optionstypes.

Expand

title	public List<SelectItem> getRecurrenceScopeOptions()

This method method returns a list of recurrence scopes.

Expand

title	public ArrayList<CRMDO> getSubscriptionTypeOptions()

This method loads the subscription type options

Expand

title	public String getThousandSeperatorSymbol()

This method returns a list of subscription types.

Expand

title	public String getTimeLabelgetThousandSeperatorSymbol(Integer hour, Integer minutes)

This method method returns a String for the configured system thousand seperator symbol.

Expand

title	public String getTimeLabel(Integer hour, Integer minutes, Integer seconds)

This method

Expand

title	public String getTimestamp()

This method

method returns the time label of the specified hour and minutes. The format of the resulting String is [hour]:[minutes].

Expand

title	public List<SelectItem> getTimezoneOptions(String getTimeLabel(Integer hour, Integer minutes, Integer seconds)

This method loads the available timezone optionsreturns the time label of the specified hour, minutes and seconds. The format of the resulting String is [hour]:[minutes]:[seconds].

Expand

title	public String getTranslationgetTimestamp(String label)

This method returns the current timestamp.

Expand

title	public List<SelectItem> getUnitOfTimeOptionsgetTimezoneOptions()

This method returns a list of available time zones.

Expand

title	public String getValueTranslationgetTranslation(String valuelabel)

This method returns the translation of the specified key label.

Expand

title	public List<SelectItem> getWeekdayOptionsgetUnitOfTimeOptions()

This method returns a list of unit times.

Expand

title	public List<SelectItem> getYearOptionsString getValueTranslation(String value)

This method returns the translation of the specified value.

Expand

title	public List<Object> getYesNoOptionsList<SelectItem> getWeekdayOptions()

This method loads the yes/no optionsreturns a list of week days.

Expand

title	public List<SelectItem> loadMonthNumberOptionsgetYearOptions()

This method loads the month (number) optionsreturns a list of years, starting from 1900 until the current year.

Expand

title	public List<SelectItem> loadPrintoutExportTypeOptionsList<Object> getYesNoOptions()

This method list of printout export type optionsreturns a list with two options: Yes and No.

Expand

title	public ArrayList<SelectItem> loadYearOptionsList<SelectItem> loadPrintoutExportTypeOptions()

This method loads the year optionsreturns a list of printout export types.

Expand

title	public void navigateToHomePage()

This method method navigates the user to home page.

Expand

title	public void refresh()

This method method refresh the page.

Expand

title	public List<CRMDOCommunity> searchCommunities(String searchValue)

This method method returns a list of communities where community name starts with the specified search value.

This method

Expand

title	public List<CRMDO> searchGroups(String searchValue)

This method returns a list of unit groups where unit group name starts with the specified search value.

Expand

title	public List<CRMDO> searchUnits(String searchValue)

This method method returns a list of units where unit name starts with the specified search value.

Expand

title	public List<CRMDO> searchUsers(String query)

This method method returns a list of users where user username starts with the specified search value.

Expand

title	public String setContactOrderBy()

This method method return a String for contact order by clause based on the active name display rule.

Template Pages

Child pages (Children Display)

sort	creation

Versions Compared

Old Version 61

New Version Current

Key

Getting Started

How to create a page

Class SummaryView

Class DataEntryView

Commonly

Used Functions

Template Pages