Skip navigation links

com.sigmadynamics.sdo.support
Class SDChoiceGroup

java.lang.Object
com.sigmadynamics.sdo.support.SDOBase
com.sigmadynamics.sdo.base.SDO
com.sigmadynamics.sdo.support.SDEligibleObject
com.sigmadynamics.sdo.base.EligibleObject
com.sigmadynamics.sdo.support.SDChoiceGroup

All Implemented Interfaces:

ChoiceGroupInterface, ChoiceHistoryQueryInterface, EligibleObjectInterface, SDOInterface

Direct Known Subclasses:

ChoiceGroup

public abstract class SDChoiceGroup

extends EligibleObject

implements ChoiceGroupInterface

Field Summary

Fields inherited from class com.sigmadynamics.sdo.support.SDOBase

description, internalName, sdExternalName

Constructor Summary

SDChoiceGroup()

Method Summary

static ChoiceGroup	findChoiceGroup(java.lang.String choiceGroupId) Get a choice group from all those defined by the inline service.
ChoiceArrayInterface	getAllDynamicChoices() get descendant Choices (dynamic only)
static Choice	getChoice(java.lang.String choiceID)
static ChoiceGroup	getChoiceGroup(java.lang.String choiceGroupId)
protected abstract Choice	getChoiceInternal(java.lang.String choiceId) delegates to ${className}.getChoice(String choiceId).
void	getEligibleChoices(ChoiceArrayInterface eligibleChoices) Adds clones of all eligible descendent Choices to the Choice Array parameter (static and dynamic)
protected ChoiceEventInterface	getEventObject(java.lang.String eventName)
ChoiceArrayInterface	getMyDynamicChoices() get child Choices (dynamic only)
ChoiceGroupInterface[]	getSubGroups() SDChoiceGroup.getTopLevelSubGroups()
static ChoiceGroupInterface[]	getTopLevelSubGroups()
boolean	isEligible()

Methods inherited from class com.sigmadynamics.sdo.support.SDOBase

getDescription, getSDOId, getSDOLabel, getSDOLabelOrId, setDescription, setSDOId, setSDOLabel

Methods inherited from class java.lang.Object

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

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

cloneGroup, getAllChoices, getMyChoices, getMyEligibleChoices

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

Constructor Detail

SDChoiceGroup

public SDChoiceGroup()

Method Detail

isEligible

public boolean isEligible()

Specified by:

isEligible in interface EligibleObjectInterface

Overrides:

isEligible in class SDEligibleObject

getEligibleChoices

public void getEligibleChoices(ChoiceArrayInterface eligibleChoices)

Description copied from interface: ChoiceGroupInterface

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

Specified by:

getEligibleChoices in interface ChoiceGroupInterface

Parameters:

eligibleChoices - Choice Array implementation, not null

getChoice

public static Choice getChoice(java.lang.String choiceID)

Returns:

a prototype Choice object or null, if choiceID not found

getSubGroups

public ChoiceGroupInterface[] getSubGroups()

Description copied from interface: ChoiceGroupInterface

SDChoiceGroup.getTopLevelSubGroups()

Specified by:

getSubGroups in interface ChoiceGroupInterface

getTopLevelSubGroups

public static ChoiceGroupInterface[] getTopLevelSubGroups()

Returns:

clones of child ChoiceGroups.

getChoiceGroup

public static ChoiceGroup getChoiceGroup(java.lang.String choiceGroupId)

getChoiceInternal

protected abstract Choice getChoiceInternal(java.lang.String choiceId)

delegates to ${className}.getChoice(String choiceId).

Returns:

null or the choice from this group or its subtree

getAllDynamicChoices

public ChoiceArrayInterface getAllDynamicChoices()

Description copied from interface: ChoiceGroupInterface

get descendant Choices (dynamic only)

Specified by:

getAllDynamicChoices in interface ChoiceGroupInterface

Returns:

SDChoiceArray, never null

getMyDynamicChoices

public ChoiceArrayInterface getMyDynamicChoices()

Description copied from interface: ChoiceGroupInterface

get child Choices (dynamic only)

Specified by:

getMyDynamicChoices in interface ChoiceGroupInterface

Returns:

SDChoiceArray, never null

getEventObject

protected ChoiceEventInterface getEventObject(java.lang.String eventName)

findChoiceGroup

public static ChoiceGroup findChoiceGroup(java.lang.String choiceGroupId)

Get a choice group from all those defined by the inline service.

Returns:

a prototype ChoiceGroup or null

Since:

1.0

Skip navigation links