Skip navigation links

com.sigmadynamics.sdo.interfaces.client
Interface ChoiceGroupInterface

All Superinterfaces:

ChoiceHistoryQueryInterface, EligibleObjectInterface, SDOInterface

All Known Implementing Classes:

ChoiceGroup, SDChoiceGroup

public interface ChoiceGroupInterface

extends EligibleObjectInterface, ChoiceHistoryQueryInterface

Interface implemented by Choice Group classes in generated code.

Method Summary

ChoiceGroupInterface	cloneGroup() constructs a new instance of this Choice Group object with new CLASSNAME();
ChoiceArrayInterface	getAllChoices() get clones of descendent Choices (static and dynamic)
ChoiceArrayInterface	getAllDynamicChoices() get descendant Choices (dynamic only)
void	getEligibleChoices(ChoiceArrayInterface eligibleChoices) Adds clones of all eligible descendent Choices to the Choice Array parameter (static and dynamic)
ChoiceArrayInterface	getMyChoices() get clones of child Choices (static and dynamic)
ChoiceArrayInterface	getMyDynamicChoices() get child Choices (dynamic only)
ChoiceArrayInterface	getMyEligibleChoices() get clones of eligible child Choices (static and dynamic)
ChoiceGroupInterface[]	getSubGroups() SDChoiceGroup.getTopLevelSubGroups()

Methods inherited from interface com.sigmadynamics.sdo.interfaces.client.EligibleObjectInterface

isEligible

Methods inherited from interface com.sigmadynamics.sdo.interfaces.client.SDOInterface

getDescription, getSDOId, getSDOLabel, getSDOLabelOrId

Methods inherited from interface com.sigmadynamics.sdo.interfaces.client.ChoiceHistoryQueryInterface

daysSinceLastEvent, daysSinceLastEvent, numberOfEventsDuringLastNDays, numberOfEventsDuringLastNDays

Method Detail

getEligibleChoices

void getEligibleChoices(ChoiceArrayInterface eligibleChoices)

Adds clones of all eligible descendent Choices to the Choice Array parameter (static and dynamic)

Parameters:

eligibleChoices - Choice Array implementation, not null

getAllChoices

ChoiceArrayInterface getAllChoices()

get clones of descendent Choices (static and dynamic)

Returns:

specialized ChoiceArrayInterface, never null

getMyChoices

ChoiceArrayInterface getMyChoices()

get clones of child Choices (static and dynamic)

Returns:

a specialized ChoiceArrayInterface

cloneGroup

ChoiceGroupInterface cloneGroup()

constructs a new instance of this Choice Group object with new CLASSNAME();

getSubGroups

ChoiceGroupInterface[] getSubGroups()

SDChoiceGroup.getTopLevelSubGroups()

getMyDynamicChoices

ChoiceArrayInterface getMyDynamicChoices()

get child Choices (dynamic only)

Returns:

SDChoiceArray, never null

getAllDynamicChoices

ChoiceArrayInterface getAllDynamicChoices()

get descendant Choices (dynamic only)

Returns:

SDChoiceArray, never null

getMyEligibleChoices

ChoiceArrayInterface getMyEligibleChoices()

get clones of eligible child Choices (static and dynamic)

Returns:

SDChoiceArray, never null

See Also:

ChoiceGroupInterface.getMyChoices()

Skip navigation links