com.ibm.portal.admin
Interface ModifiableMarkupCapable

All Superinterfaces:

MarkupCapable, Modifiable

All Known Subinterfaces:

ModifiableContentLabel, ModifiableContentNode, ModifiableContentPage, ModifiableContentURL, ModifiableExternalContentURL, ModifiableInternalContentURL

public interface ModifiableMarkupCapable
extends MarkupCapable, Modifiable

An interface representing a modifiable markup capable instance.

Since:

6.1.0

Method Summary

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

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

getMarkups, com.ibm.portal.admin.Markup)">supportsMarkup, supportsMarkup

Method Detail

com.ibm.portal.admin.Markup)">

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 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

com.ibm.portal.admin.Markup)">

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

com.ibm.portal.admin.Markup)">

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 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

com.ibm.portal.admin.Markup)">

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