Package com.microstrategy.web.objects

Class RWSecondaryDataProviderHelperImpl

java.lang.Object

com.microstrategy.web.objects.RWSecondaryDataProviderHelperImpl

All Implemented Interfaces:

RWSecondaryDataProviderHelper

public class RWSecondaryDataProviderHelperImpl
extends java.lang.Object
implements 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)

Methods inherited from class java.lang.Object

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

Method Detail

setProviders

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

Specified by:

setProviders in interface RWSecondaryDataProviderHelper

Throws:

WebObjectsException

extraKeys

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

Specified by:

extraKeys in interface RWSecondaryDataProviderHelper

Throws:

WebObjectsException

haveSelectedSecondaryProvidersChanged

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

Description copied from interface: RWSecondaryDataProviderHelper

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.

Specified by:

haveSelectedSecondaryProvidersChanged in interface RWSecondaryDataProviderHelper

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

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

Description copied from interface: RWSecondaryDataProviderHelper

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

Specified by:

getAvailableSecondaryProviders in interface RWSecondaryDataProviderHelper

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

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

Description copied from interface: RWSecondaryDataProviderHelper

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.

Specified by:

getSelectedSecondaryProviders in interface RWSecondaryDataProviderHelper

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