Package com.microstrategy.web.objects.rw

Interface RWSecondaryDataProviderHelper

All Known Implementing Classes:

RWSecondaryDataProviderHelperImpl

public interface RWSecondaryDataProviderHelper

Since:

MicroStrategy Web 8.1.1

Method Summary

Modifier and Type	Method	Description
java.util.Set	extraKeys(RWControl ctl)
java.util.List	getAvailableSecondaryProviders(RWUnitDef unit)	Returns a list all the RWUnitDef objects that are available as secondary providers of the selected unit
java.util.List	getSelectedSecondaryProviders(RWUnitDef unit, java.util.List available)	Returns the list of RWUnitDef objects that have been selected as secondary providers for the current unit.
boolean	haveSelectedSecondaryProvidersChanged(RWUnitDef unit, java.util.List selected)	Whether the secondary data sources have changed for the selected unit.
void	setProviders(RWUnitDef unit, java.lang.String keys)

Method Detail

setProviders

void setProviders(RWUnitDef unit,
                  java.lang.String keys)
           throws WebObjectsException

Throws:

WebObjectsException

extraKeys

java.util.Set extraKeys(RWControl ctl)
                 throws WebObjectsException

Throws:

WebObjectsException

haveSelectedSecondaryProvidersChanged

boolean haveSelectedSecondaryProvidersChanged(RWUnitDef unit,
                                              java.util.List selected)
                                       throws WebBeanException

Whether the secondary data sources have changed for the selected unit.
This happens when one (or more) of the secondary providers for the unit become unavailable because it was removed or moved to a lower section on the group by.

Parameters:

unit - The primary unit that is being edited

selected - The list of selected secondary data sources

Returns:

Whether the secondary data sources have changed for the selected unit

Throws:

WebBeanException

getAvailableSecondaryProviders

java.util.List getAvailableSecondaryProviders(RWUnitDef unit)
                                       throws WebBeanException

Returns a list all the RWUnitDef objects that are available as secondary providers of the selected unit

Parameters:

unit - the selected unit

Returns:

a list of all the RWUnitDef objects that are available as secondary providers of the selected unit

Throws:

WebBeanException

getSelectedSecondaryProviders

java.util.List getSelectedSecondaryProviders(RWUnitDef unit,
                                             java.util.List available)
                                      throws WebBeanException

Returns the list of RWUnitDef objects that have been selected as secondary providers for the current unit.
Units on the list are validated so that they still exist on the document and have not been moved to a lower section on the group by.

Parameters:

unit - the selected unit

available - the list of available providers

Returns:

the list of RWUnitDef objects that have been selected as secondary providers for the current unit.

Throws:

WebBeanException