org.imixs.workflow.office.config

Class ConfigController

java.lang.Object

org.imixs.workflow.office.config.ConfigController

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SetupController

@ApplicationScoped
public class ConfigController
extends Object
implements Serializable

This ConfigController acts as a frontend controller for a Config Entity. The entity (itemCollection) holds config params. The entity is stored with the type "configuration" and a configurable name (txtname). The property 'txtname' is used to select the config entity by a query. The bean interacts with the marty ConfigService EJB which is responsible for creation, loading and saving the entity. This singleton ejb can manage multiple config entities. The ConfigController bean is also ApplicationScoped, so it can be shared in one application. From the backend it is possible to use the ConfigControler or also directly the ConfigService EJB. The Bean can be overwritten to add additional busines logic (e.g. converting params or providing additional custom getter methods). Use multiple instances in one application, bean can be decleared in the faces-config.xml file. The managed-ban-name as the manged property 'name' can be set to custom values: myConfigController org.imixs.marty.config.ConfigController name REPORT_CONFIGURATION The Bean provides easy access to the config params from a JSF Page. Example:

Author:

rsoika

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConfigController()

Method Summary

Modifier and Type	Method and Description
String	getName() Returns the name of the configuration entity
List<javax.faces.model.SelectItem>	getSelectItems(String param) SelectItem getter Method provides a getter method to an ArrayList of objects for a specific param stored in the configuration entity.
org.imixs.workflow.ItemCollection	getWorkitem()
void	init() This method load the config entity after postContstruct.
void	loadConfiguration() Refresh the configItemCollection.
void	save() save method updates the txtname property and save the config entity
void	setName(String name) Sets the name of the configuration entity

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigController

public ConfigController()

Method Detail

init

@PostConstruct
public void init()

This method load the config entity after postContstruct. If no Entity exists than the ConfigService EJB creates a new config entity.

loadConfiguration

public void loadConfiguration()

Refresh the configItemCollection. The method can be called by a client to get an updated version of the config entity. The method discards the internal cache!

getName

public String getName()

Returns the name of the configuration entity

Returns:

setName

public void setName(String name)

Sets the name of the configuration entity

Parameters:

name -

getWorkitem

public org.imixs.workflow.ItemCollection getWorkitem()

getSelectItems

public List<javax.faces.model.SelectItem> getSelectItems(String param)
                                                  throws Exception

SelectItem getter Method provides a getter method to an ArrayList of objects for a specific param stored in the configuration entity. A param entry can be devided by a | into a label and a value component. Example: Important | 1 Unimportant | 0

Returns:

Throws:

Exception

save

public void save()
          throws org.imixs.workflow.exceptions.AccessDeniedException

save method updates the txtname property and save the config entity

Throws:

org.imixs.workflow.exceptions.AccessDeniedException