Package ch.tocco.nice2.netui.api.bind.entity

Interface RelationsListService

All Known Implementing Classes:

RelationsListServiceImpl

public interface RelationsListService

Returns [some] related entities (the names, not records) of an entity.

Method Summary

Modifier and Type	Method	Description
Map<String,String[]>	getRelations(String entityName, String pk, boolean onlyToMany, boolean withCount)	Which relations are returned depends on config, param and convention: If configuration exists then it dictates.

Method Details

getRelations

Map<String,String[]> getRelations(String entityName,
 String pk,
 boolean onlyToMany,
 boolean withCount)
                           throws PersistException

Which relations are returned depends on config, param and convention: If configuration exists then it dictates. From the entity xml file, section visualisation, tag relation-list. Otherwise all to-n relations are taken (param 'onlyToMany' has a default of true), and related entities of type "standard" come before those of type "lookup" because they are usually more important.

The action returns (for historical reasons) a map with the relation name as key (eg 'relMembership') and an String[] with the 3 entries - 'label' (as localized text, eg 'Mitgliedschaft'), - entity name (eg 'Membership), - number of relations 0-n, -1 if the getting the amount threw an ex.

Throws:

PersistException