The List EndPoints are used to create lists (tables with data).

1 Usage

The endPoints of type List are the most used. They can be created to show any kind of data through the webpage

The lists will commontly have an endPoint at the menu as a way to get access to his data. Sometimes this point at the navigation bar will be hidden, and in other cases, one list may be the child of another.

2 Programming a List EndPoint

When it comes to create a list endPoint, we can set a bunch of functions to define the table with some parameters or another ones.

Function Req Mult Params
Variable Type Req Default Description
setPath     path String   URL path to select this endPoint
setTitle     title String   Label code to get the title written at the Menu navigation bar and the title of the table
titleSingluar String   Value of "title" Label code to get the title of each row of the table
dontShow     Hide the endPoint from the navigation bar
setRoles     roles String[]   Selects if the user is able to see this endPoint or not. If no roles added, all the users can see it. While if setRoles is implemented only the users which role is inside the list will be able to see the endPoint
setListViewSqlCatalog     sqlCatalogCode String   SQL code to get the resultset that will be displayed
setFormViewSqlCatalog     sqlFormViewCode String   SQL code to get the resultset that will be displayed as a header information for the pages that are coming from one of the rows of the sqlCatalogCode
setDbms     dbms String   dbms from config Change the dataBase where the SQL call is going to be executed
addLink     columnName String   Column where the link is going to be added
href String   Link where the user is going to be redirected
addChild     fkColName String   Column that is going to be used to make the relation between the children and the parent
columnLinked String   Value of "fkColName" Column where the link to the children is going to be implemented
child EndpointDefinition   children endPoint. contains all the information about the children
extraParams String...   column names of the values that want to be sent to the children column in order to open it properly
setPrintable     objCode String   Object code used to create the pdf
cond String   Condition used when going to create the pdf
printCol String   Column that is used as a param to print the user selected data at the pdf
editableI EditableI   All rows can print pdf Condition to decide which rows can print pdf or which not
setEdit     editCode String   SQL code to get the metadata of the columns that will appear in the formulary
transactioCode String   Value of "editCode" Transaction code to make an insert or update to the database
editableI EditableI   All rows can be edited Condition to decide which rows can print pdf or which not
addConstraint     constraint AbstractConstraint   Add a constraint, can be a DefaultConstraint or a DefaultConstraint (see point X.XX for more information)
setFilterPosition     filterPosition FilterPosition   Vertical Here we define where the filter will appear. The Vertical filter loads the data calling ajax every time. The Horizontal filter is filtering via JavaScript. Both filters can be called with Both, either we can decide we don't want filter for this table, on that case Any will be selected.
setTableInitLoaded     tableLoaded Boolean     If  , the table won't be loaded until the user applies some filters to the table

2.1 AbstractConstraint

AbstractConstraint is a java class created for this project, it can contain two kind of diferent constraints: DefaultConstraint or NotEditableContraint

Depending on the situation the programmer will select one or another or neither of them

  • DefaultConstraint: Is used to set a default value to a row. This value is going to be inserted in the selected column each time a transaction is done, no matter if Insert or Update
  • NotEditableContraint: The column is not going to be able to be edited when doing an Update, and the column is going to be inserted as null when doing an Insert