Hi all and welcome to another blog post on ADF Naming Conventions.
In my previous post ADF Namings Conventions – Part II I have focused my attention on:
- Model & View Controller Project
Today I will focus on:
- Task Flows
- JSF, JSFF, JSPX
- JAVA Events
- JAR, WAR, EAR files
In this section, we will provide the namings related with task flows.
Task Flow Namings
The name for Task Flows should be defined as follows:
<TASK_FLOW_CAMEL_CASE> + TF
We may have different task flows types, each one built to address one purpose. For these cases we added a constant to the name in order to easily recognize their purpose/target. Next table presents the Types and Target Names:
|Type||Task Flow Target Name|
|Task Flow to filter data||<TASK_FLOW_CAMEL_CASE> + Filter + TF|
|Task Flow to perform actions on data||<TASK_FLOW_CAMEL_CASE> + Action + TF|
|Task Flow to list data||<TASK_FLOW_CAMEL_CASE> + List + TF|
|Task Flow to detail data||<TASK_FLOW_CAMEL_CASE> + Detail + TF|
|Task Flow to combine multiple task flows||<TASK_FLOW_CAMEL_CASE> + Container + TF|
Task Flow Managed Beans
Task Flows’ managed beans are responsible for managing data. Multiple managed beans can be created for a single Task Flow. Nevertheless, you usually have one main managed bean. For these cases, managed beans should have a similar name as the task flow.
As you may have already noticed, you are free to provide any name you want to the Java Class you assign to your managed bean in “Managed Beans” task flow’s tab. For this scenario, we recommend to use the same name of the Java Class.
By following this two advises you will be able to find what you are looking more easily without losing time and effort to understand the mappings made by each developer. This is very important for developers during development and maintenance phases. Based on these assumptions take a look at the following example:
|Task Flow Name:||myTaskFlowTF|
|Java Class Name:||MyTaskFlow|
|Managed Bean Name:||MyTaskFlow|
Task Flow Input & Return Parameters
Task flow’s input parameters should be prefixed with “in”:
in + <CAMEL_CASE>
Task flow’s return parameters should be prefixed with “rtn”:
rtn + <CAMEL_CASE>
ADF lets us create different types of templates to abstract common functionalities used in our projects, for example Page Templates and Task Flow Templates. This templates should be created using the following pattern:
<CAMEL_CASE> + Template
Example: myTaskFlowTemplate, myPageTemplate
JSF, JSFF, JSPX Namings
Pages names should have a self-explanatory name in order to be easily identified and recognized with its purpose. The default pattern we followed was:
In Task Flows you may have multiple pages depending on the route it takes, but for the main page (if we have one) we should provide it with the same name as the task flow but without ‘TF’ suffix.
|Task Flow Name:||myFinantialTasksListTF|
Java Events Namings
For our controls events, we set suffixes for them. This will help you to understand the event type you are taking care without the need to go directly to the page, only if you need to understand it in more detail. The list of suffixes for each type of event are listed in the following table:
|Value Change Listener||VCL|
|Selection Event Listener||SEL|
|Client Event Listener||CEL|
|Return Event Listener||REL|
|Action Event Listener||AEL|
JAR, WAR, EAR Files
Building and deploying projects lead us to create deployment profiles. In this deployments profiles, you should use the same namings. The next table addresses this topic by providing the namings for each type of deployment profile.
|JAR||jar + <PROJECT_NAME> + <MODULE_NAME>|
|ADF JAR Library||adflib + <PROJECT_NAME> + <MODULE_NAME>|
|Shared Library||sharedlib + <PROJECT_NAME> + <MODULE_NAME>|
|WAR||war + <PROJECT_NAME> + <MODULE_NAME>|
|EAR||ear + <PROJECT_NAME> + <MODULE_NAME>|
You can find the PDF with these series of posts right here.
I hope these series of posts may help you in your projects 🙂
Post Header photo by Geoffrey Fairchild