com.ibm.portal.admin
Interface ModifiableMarkupCapable

All Superinterfaces:

MarkupCapable, Modifiable

All Known Subinterfaces:

ModifiableContentLabel, ModifiableContentNode, ModifiableContentPage, ModifiableContentURL, ModifiableExternalContentURL, ModifiableInternalContentURL, ModifiableSkin, ModifiableStaticContentPage, ModifiableTheme

public interface ModifiableMarkupCapable
extends MarkupCapable, Modifiable

An interface representing a modifiable markup capable instance.

Since:

6.1.0

Method Summary

boolean	addMarkup(Markup aMarkup) Adds a markup.
boolean	addMarkups(java.util.Set<Markup> aMarkupSet) Adds all markups specified by the set.
boolean	confirmAddMarkup(Markup aMarkup) Indicates if the specified markup may be set.
boolean	confirmAddMarkups(java.util.Set<Markup> aMarkupSet) Indicates if the specified markups may be set.
boolean	confirmRemoveMarkup(Markup aMarkup) Indicates if the specified markup may be removed.
boolean	confirmRemoveMarkups() Indicates if all markups may be removed.
boolean	removeMarkup(Markup aMarkup) Removes a markup.
boolean	removeMarkups() Clears all markups.

Methods inherited from interface com.ibm.portal.admin.MarkupCapable

getMarkups, supportsMarkup, supportsMarkup

Method Detail

addMarkup

boolean addMarkup(Markup aMarkup)
                  throws CannotModifyPropertyException

Adds a markup.

Parameters:

aMarkup - markup to add; must not be null

Returns:

true if this MarkupCapable was changed as a result of this call

Throws:

CannotModifyPropertyException - in case the markup cannot be added for the locale

addMarkups

boolean addMarkups(java.util.Set<Markup> aMarkupSet)
                   throws CannotModifyPropertyException

Adds all markups specified by the set.

Parameters:

aMarkupSet - set with the titles to add; must contain Markup instances.

Returns:

true if this MarkupCapable was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a markup cannot be added; in this case the markups are added only partially

removeMarkup

boolean removeMarkup(Markup aMarkup)
                     throws CannotModifyPropertyException

Removes a markup.

Parameters:

aMarkup - markup to remove; must not be null

Returns:

true if this MarkupCapable was changed as a result of this call

Throws:

CannotModifyPropertyException - in case the markup cannot be removed for the locale

removeMarkups

boolean removeMarkups()
                      throws CannotModifyPropertyException

Clears all markups.

Returns:

true if this MarkupCapable was changed as a result of this call

Throws:

CannotModifyPropertyException - in case a markup cannot be removed; in this case the markups are removed only partially

confirmAddMarkup

boolean confirmAddMarkup(Markup aMarkup)

Indicates if the specified markup may be set.

Parameters:

aMarkup - markup for which to indicate if it may be set; must not be null

Returns:

true if the specified markup may be set, false otherwise

confirmAddMarkups

boolean confirmAddMarkups(java.util.Set<Markup> aMarkupSet)

Indicates if the specified markups may be set.

Parameters:

aMarkupSet - set of Markups for which to indicate if they may be set; must not be null

Returns:

true if the specified markups may be set, false otherwise

confirmRemoveMarkup

boolean confirmRemoveMarkup(Markup aMarkup)

Indicates if the specified markup may be removed.

Parameters:

aMarkup - markup for which to indicate if it may be removed; must not be null

Returns:

true if the markup may be removed, false otherwise

confirmRemoveMarkups

boolean confirmRemoveMarkups()

Indicates if all markups may be removed.

Returns:

true if all markups may be removed, false otherwise