Package com.novomind.ecom.api.imail.routing.persistence

Interface TextModuleFirstLevelGroupModifier

All Superinterfaces:

Modifier<TextModuleFirstLevelGroup>, TextModuleGroupModifier<TextModuleFirstLevelGroup>, TextModuleNodeModifier<TextModuleFirstLevelGroup>

public interface TextModuleFirstLevelGroupModifier
extends TextModuleGroupModifier<TextModuleFirstLevelGroup>

Defines an API to modify an instance of type TextModuleFirstLevelGroup

Since:

10.0.206

Method Summary

Modifier and Type	Method	Description
TextModuleFirstLevelGroupModifier	addAssignedCategories(Category... categories)	Assign the textmodule first level group to the passed categories.
java.util.Set<Category>	getAssignedCategories()	Get an unmodifiable view of the current assigned categories which are held in this TextModuleFirstLevelGroupModifier.
java.util.List<TextModuleNode>	getChildTextModuleNodes()	Get the current direct child textmodule nodes list which is held in this TextModuleFirstLevelGroupModifier.
java.util.List<TextModuleSecondLevelGroup>	getChildTextModuleSecondLevelGroups()	Get the current direct child textmodule second level groups list which is held in this TextModuleFirstLevelGroupModifier.
TextModuleFirstLevelGroup.Classification	getClassification()	Get the current classification which is held in this TextModuleFirstLevelGroupModifier.
boolean	isVisible()	Get the current visibility which is held in this TextModuleNodeModifier.
TextModuleFirstLevelGroupModifier	removeAssignedCategories(Category... categories)	Remove the assignment of the textmodule first level group to the passed categories.
TextModuleFirstLevelGroupModifier	setChildTextModuleNodes(java.util.List<TextModuleNode> childTextModuleNodes)	Change the direct child textmodule nodes list of the associated TextModuleFirstLevelGroup.
TextModuleFirstLevelGroupModifier	setClassification(TextModuleFirstLevelGroup.Classification classification)	Change the classification of the associated TextModuleFirstLevelGroup.
TextModuleFirstLevelGroupModifier	setName(java.lang.String name)	Change the name of the associated TextModuleNode.
TextModuleFirstLevelGroupModifier	setVisible(boolean visible)	Change the visibility.
boolean	validateChildTextModuleNodes(java.util.List<TextModuleNode> childTextModuleNodes)	Validate the given direct child textmodule nodes list.
boolean	validateClassification(TextModuleFirstLevelGroup.Classification classification)	Validate the given classification.
boolean	validateVisible(boolean visible)	Validate the given visibility.

Methods inherited from interface com.novomind.ecom.api.imail.routing.persistence.Modifier

delete, get, write

Methods inherited from interface com.novomind.ecom.api.imail.routing.persistence.TextModuleGroupModifier

getChildTextModules

Methods inherited from interface com.novomind.ecom.api.imail.routing.persistence.TextModuleNodeModifier

getName, validateName

Method Detail

setName

TextModuleFirstLevelGroupModifier setName(java.lang.String name)
                                   throws ValidationException

Description copied from interface: TextModuleNodeModifier

Change the name of the associated TextModuleNode.

The change is applied after the Modifier.write() method is called.

Specified by:

setName in interface TextModuleGroupModifier<TextModuleFirstLevelGroup>

Specified by:

setName in interface TextModuleNodeModifier<TextModuleFirstLevelGroup>

Parameters:

name - the new name as String

Returns:

the TextModuleNodeModifier

Throws:

ValidationException - if the new name is invalid

isVisible

boolean isVisible()

Get the current visibility which is held in this TextModuleNodeModifier.

Returns:

true if visible, otherwise false

Since:

10.0.206

setVisible

TextModuleFirstLevelGroupModifier setVisible(boolean visible)
                                      throws ValidationException

Change the visibility.

The change is applied after the Modifier.write() method is called.

Parameters:

visible - the new visibility

Returns:

the TextModuleNodeModifier

Throws:

ValidationException - if the change is invalid

Since:

10.0.206

validateVisible

boolean validateVisible(boolean visible)
                 throws ValidationException

Validate the given visibility.

Parameters:

visible - the new visibility

Returns:

true if the change is valid

Throws:

ValidationException - if the change is invalid

Since:

10.0.206

getAssignedCategories

java.util.Set<Category> getAssignedCategories()

Get an unmodifiable view of the current assigned categories which are held in this TextModuleFirstLevelGroupModifier.

Returns:

the current assigned categories as an unmodifiable set

Since:

10.0.206

addAssignedCategories

TextModuleFirstLevelGroupModifier addAssignedCategories(Category... categories)
                                                 throws ValidationException

Assign the textmodule first level group to the passed categories.

The change is applied after the Modifier.write() method is called.

Parameters:

categories - the categories the textmodule first level group should be assigned to

Returns:

the TextModuleFirstLevelGroupModifier

Throws:

ValidationException - if a category is null or already assigned

Since:

10.0.206

removeAssignedCategories

TextModuleFirstLevelGroupModifier removeAssignedCategories(Category... categories)
                                                    throws ValidationException

Remove the assignment of the textmodule first level group to the passed categories.

The change is applied after the Modifier.write() method is called.

Parameters:

categories - the categories for which the assignment should be removed

Returns:

the TextModuleFirstLevelGroupModifier

Throws:

ValidationException - if a category is null or not assigned

Since:

10.0.206

getClassification

TextModuleFirstLevelGroup.Classification getClassification()

Get the current classification which is held in this TextModuleFirstLevelGroupModifier.

Returns:

the classification

Since:

10.0.206

setClassification

TextModuleFirstLevelGroupModifier setClassification(TextModuleFirstLevelGroup.Classification classification)
                                             throws ValidationException

Change the classification of the associated TextModuleFirstLevelGroup.

The change is applied after the Modifier.write() method is called.

Parameters:

classification - the new classification

Returns:

the TextModuleFirstLevelGroupModifier

Throws:

ValidationException - if the new classification is invalid

Since:

10.0.206

validateClassification

boolean validateClassification(TextModuleFirstLevelGroup.Classification classification)
                        throws ValidationException

Validate the given classification.

Parameters:

classification - the classification to validate

Returns:

true if the classification is valid

Throws:

ValidationException - if the classification is invalid

Since:

10.0.206

getChildTextModuleSecondLevelGroups

java.util.List<TextModuleSecondLevelGroup> getChildTextModuleSecondLevelGroups()

Get the current direct child textmodule second level groups list which is held in this TextModuleFirstLevelGroupModifier.

Returns:

the direct child textmodule second level groups list

Since:

10.0.206

getChildTextModuleNodes

java.util.List<TextModuleNode> getChildTextModuleNodes()

Get the current direct child textmodule nodes list which is held in this TextModuleFirstLevelGroupModifier.

Returns:

the direct child textmodule nodes list

Since:

10.0.206

setChildTextModuleNodes

TextModuleFirstLevelGroupModifier setChildTextModuleNodes(java.util.List<TextModuleNode> childTextModuleNodes)
                                                   throws ValidationException

Change the direct child textmodule nodes list of the associated TextModuleFirstLevelGroup.

The change is applied after the Modifier.write() method is called.

Parameters:

childTextModuleNodes - the new direct child textmodule nodes list

Returns:

the TextModuleGroupModifier

Throws:

ValidationException - if the new new direct child textmodule nodes list is invalid

Since:

10.0.206

validateChildTextModuleNodes

boolean validateChildTextModuleNodes(java.util.List<TextModuleNode> childTextModuleNodes)
                              throws ValidationException

Validate the given direct child textmodule nodes list.

Parameters:

childTextModuleNodes - the direct child textmodule nodes list to validate

Returns:

true if the direct child textmodule nodes list is valid

Throws:

ValidationException - if the direct child textmodule nodes list is invalid

Since:

10.0.206