Package de.xima.fc.api.system

Class BeanAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.system.BeanAPI

public class BeanAPI
extends ASubAPI

API class for manipulation of beans.

Author:

XIMA MEDIA GmbH

Constructor Summary

Constructors

Constructor	Description
BeanAPI()

Method Summary

Modifier and Type	Method	Description
Map<String,Object>	getProp(UserContext uc, Serializable bean, BeanAttribute[] beanAttributs)	Reading a specific value from committed object based on the property name.

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

BeanAPI

public BeanAPI()

Method Detail

getProp

public Map<String,Object> getProp(UserContext uc,
                                        Serializable bean,
                                        BeanAttribute[] beanAttributs)
                                 throws PropertyException

Reading a specific value from committed object based on the property name. If a property is passed following the pattern [Name Collection-based property].ids, the IDs of the entities are removed from the Collection returns as JSONArray, otherwise the value is read out normally.

Parameters:

uc - UserContext the user context in which the action is to be performed.

bean - Serializable Target object.

beanAttributs - Array of BeanAttributes properties whose values are to be fetched.

Returns:

Value of the property in the passed object.

Throws:

PropertyException - if the property couldn't read.

Since:

2.4.3