Helper to manage Database List values (used like a Static list) of a class

Description

This application is a helper for simple users that allows them to design the fields of a DataBase List, which is used as a Static List that users can easily edit, without needing editing rights on the class.

Usage

Just write:

{{dblist_manager property='..' wikiclass='..' showQuery='true|false' documentHandler='..' showTitle='true|false' /}}

Where :

• "property" is the property of the class to manage (must be a Database List!).
• "wikiclass" is the class which contains the property.
• "showQuery" (optional) is for the class designer: display or not the query to put on the "Hibernate Query" field of the property. (default: false)
• "documentHandler" (optional) is the document where the Database list entries will be saved. Default: the current document where is used this macro.
• "showTitle" (optional) shows or not the title. (default: true)

Then, in your class, you can create a 'Database List' property and fill in the 'Hibernate Query' the content that you can display with showQuery parameter of the macro.

Example of use

1. In your class, add a Database List field
   
2. In the page where you want the user can customise it, call the macro:
   
   (or)
   
3. Get the Hibernate Query
   
4. Put it on the "Hibernate Query" field of your property in your class:
   
5. Add some values using the macro
   
6. Enjoy the results, when you create an object of your class:
   

Maven

Developers, if you want to add this application as a dependency of your own XAR, just add the following lines in your pom.xml file:

  <dependencies>
    <dependency>
      <groupId>org.xwiki.contrib</groupId>
      <artifactId>xwiki-dblistmanager-application</artifactId>
      <version>1.0</version>
      <type>xar</type>
    </dependency>
  </dependencies>

Prerequisites & Installation Instructions

Don't forget to add Macros.DBListManagerTranslations to your translation files.

Versions