no.g9.support

Class ObjectSelection

java.lang.Object

no.g9.support.ObjectSelection

All Implemented Interfaces:

Serializable

public class ObjectSelection
extends Object
implements Serializable

Instances of the class holds data for one object selection and points out the root of interest and the role to operate on. Object selection data are always represented by a object tree starting at the (sub)root object, according to the object selection model. Methods to get and put object selection data are available for both single domain objects and lists of domain objects.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ObjectSelection() Create an empty ObjectSelection.
ObjectSelection(Object currentRoot, String currentRootName, String targetRoleName, String applicationName, String objectSelectionName) The constructor to use when instantiating a completed ObjectSelection object.
ObjectSelection(String currentRootName, String targetRoleName, String applicationName, String objectSelectionName) The constructor to use when instantiating a partially completed ObjectSelection object.

Method Summary

Modifier and Type	Method and Description
Map<Object,ActionType>	getActions()
String	getApplicationName() Access method for the applicationName property.
String	getCurrentRootName() Access method for the currentRootName property.
boolean	getDoAnyLevelManyRelated()
boolean	getDoFirstLevelManyRelated()
boolean	getDoOneRelated()
boolean	getDoParents()
FindData	getFindData()
String	getObjectSelectionName() Access method for the objectSelectionName property.
Object	getRootObject(String rootName) Get the domain object for the given root role name.
List<Object>	getRootObjects(String rootName) Get the list of domain objects for the given root role name.
boolean	getSetsContainAllRelated()
String	getTargetMainKey()
String	getTargetRoleName() Access method for the targetRoleName property.
void	putRootObject(String rootName, Object rootObject) Put a domain object for the given root role name.
void	putRootObjects(String rootName, List<Object> rootObjects) Put a list of domain objects for the given root role name.
void	removeAllRootObjects() Remove all entered root objects
void	setActions(Map<Object,ActionType> actions) Sets the actions map
void	setApplicationName(String aApplicationName) Sets the value of the applicationName property.
void	setCurrentRootName(String aCurrentRootName) Sets the value of the currentRootName property.
void	setDoAnyLevelManyRelated(boolean doAnyLevelManyRelated) Sets the doAnyLevelManyRelated flag
void	setDoFirstLevelManyRelated(boolean doFirstLevelManyRelated) Sets the doFirstLevelManyRelated flag
void	setDoOneRelated(boolean doOneRelated) Sets the doOneRelated flag
void	setDoParents(boolean doParents) Sets the doParents flag
void	setFindData(FindData findData)
void	setObjectSelectionName(String aObjectSelectionName) Sets the value of the objectSelectionName property.
void	setSetsContainAllRelated(boolean setsContainAllRelated) Sets the setsContainAllRelated flag
void	setTargetMainKey(String targetMainKey) The main key used to identify the target role instance.
void	setTargetRoleName(String aTargetRoleName) Sets the value of the targetRoleName property.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectSelection

public ObjectSelection(Object currentRoot,
                       String currentRootName,
                       String targetRoleName,
                       String applicationName,
                       String objectSelectionName)

The constructor to use when instantiating a completed ObjectSelection object.

Parameters:

currentRoot - The current root role object

currentRootName - The name of the current root role

targetRoleName - The name of the target role for the action

applicationName - The name of the application

objectSelectionName - The name of the object selection

ObjectSelection

public ObjectSelection(String currentRootName,
                       String targetRoleName,
                       String applicationName,
                       String objectSelectionName)

The constructor to use when instantiating a partially completed ObjectSelection object.

Parameters:

currentRootName - The name of the current root role

targetRoleName - The name of the target role for the action

applicationName - The name of the application

objectSelectionName - The name of the object selection

ObjectSelection

public ObjectSelection()

Create an empty ObjectSelection.

Method Detail

removeAllRootObjects

public void removeAllRootObjects()

Remove all entered root objects

putRootObject

public void putRootObject(String rootName,
                          Object rootObject)

Put a domain object for the given root role name.

Parameters:

rootName - The name of the root role for the domain object, or currentRootName if null

rootObject - The domain object

putRootObjects

public void putRootObjects(String rootName,
                           List<Object> rootObjects)

Put a list of domain objects for the given root role name.

Parameters:

rootName - The name of the root role for the domain objects, or currentRootName if null

rootObjects - The list of domain objects

getRootObject

public Object getRootObject(String rootName)

Get the domain object for the given root role name. If there are more than one object for the root role name the first is returned.

Parameters:

rootName - The name of the root role for the domain object, or currentRootName if null

Returns:

The first domain object for the given root role name

getRootObjects

public List<Object> getRootObjects(String rootName)

Get the list of domain objects for the given root role name.

Parameters:

rootName - The name of the root role for the domain object, or currentRootName if null

Returns:

The list of domain objects for the given root role name

getCurrentRootName

public String getCurrentRootName()

Access method for the currentRootName property.

Returns:

the current value of the currentRootName property

setCurrentRootName

public void setCurrentRootName(String aCurrentRootName)

Sets the value of the currentRootName property.

Parameters:

aCurrentRootName - the new value of the currentRootName property

getTargetRoleName

public String getTargetRoleName()

Access method for the targetRoleName property.

Returns:

the current value of the targetRoleName property

setTargetRoleName

public void setTargetRoleName(String aTargetRoleName)

Sets the value of the targetRoleName property.

Parameters:

aTargetRoleName - the new value of the targetRoleName property

getObjectSelectionName

public String getObjectSelectionName()

Access method for the objectSelectionName property.

Returns:

the current value of the objectSelectionName property

setObjectSelectionName

public void setObjectSelectionName(String aObjectSelectionName)

Sets the value of the objectSelectionName property.

Parameters:

aObjectSelectionName - the new value of the objectSelectionName property

getApplicationName

public String getApplicationName()

Access method for the applicationName property.

Returns:

the current value of the applicationName property

setApplicationName

public void setApplicationName(String aApplicationName)

Sets the value of the applicationName property.

Parameters:

aApplicationName - the new value of the applicationName property

getFindData

public FindData getFindData()

Returns:

Returns the findData.

setFindData

public void setFindData(FindData findData)

Parameters:

findData - The findData to set.

getTargetMainKey

public String getTargetMainKey()

Returns:

Returns the targetMainKey

setTargetMainKey

public void setTargetMainKey(String targetMainKey)

The main key used to identify the target role instance. Primary key is used if not set.

Parameters:

targetMainKey - (missing javadoc)

getSetsContainAllRelated

public boolean getSetsContainAllRelated()

Returns:

Returns the setsContainAllRelated flag

setSetsContainAllRelated

public void setSetsContainAllRelated(boolean setsContainAllRelated)

Sets the setsContainAllRelated flag

Parameters:

setsContainAllRelated - (missing javadoc)

getActions

public Map<Object,ActionType> getActions()

Returns:

Returns the actions map

setActions

public void setActions(Map<Object,ActionType> actions)

Sets the actions map

Parameters:

actions - (missing javadoc)

getDoParents

public boolean getDoParents()

Returns:

Returns the doParents flag

setDoParents

public void setDoParents(boolean doParents)

Sets the doParents flag

Parameters:

doParents - (missing javadoc)

getDoOneRelated

public boolean getDoOneRelated()

Returns:

Returns the doOneRelated flag

setDoOneRelated

public void setDoOneRelated(boolean doOneRelated)

Sets the doOneRelated flag

Parameters:

doOneRelated - (missing javadoc)

getDoFirstLevelManyRelated

public boolean getDoFirstLevelManyRelated()

Returns:

Returns the doFirstLevelManyRelated flag

setDoFirstLevelManyRelated

public void setDoFirstLevelManyRelated(boolean doFirstLevelManyRelated)

Sets the doFirstLevelManyRelated flag

Parameters:

doFirstLevelManyRelated - (missing javadoc)

getDoAnyLevelManyRelated

public boolean getDoAnyLevelManyRelated()

Returns:

Returns the doAnyLevelManyRelated flag

setDoAnyLevelManyRelated

public void setDoAnyLevelManyRelated(boolean doAnyLevelManyRelated)

Sets the doAnyLevelManyRelated flag

Parameters:

doAnyLevelManyRelated - (missing javadoc)

toString

public String toString()

Overrides:

toString in class Object