com.ibm.portal.content
Interface ModifiableStaticContentPage

All Superinterfaces:

ActiveFlag, ContentNode, ContentPage, DeviceClassCapable, DisplayOptions, Identifiable, Localized, MarkupCapable, Modifiable, ModifiableActiveFlag, ModifiableContentNode, ModifiableContentPage, ModifiableDeviceClassCapable, com.ibm.portal.content.ModifiableDisplayOptions, ModifiableIdentifiable, ModifiableLocalized, ModifiableMarkupCapable, StaticContentPage, ThemeProvider, ThemeSetter

public interface ModifiableStaticContentPage
extends ModifiableContentPage, com.ibm.portal.content.ModifiableDisplayOptions, StaticContentPage

An interface representing a modifiable static content page instance. Implementations of ModifiableStaticContentPage will only modify the StaticContentPage but not guarantee the consistency between the resources in the associated LayoutModel and the static resources.

Since:

8.0.0.1

Nested Class Summary

Nested classes/interfaces inherited from interface com.ibm.portal.content.DisplayOptions

DisplayOptions.DisplayOption

Method Summary

boolean	confirmSetFileName(Markup markup, java.lang.String fileName) Deprecated. use confirmSetFileName(Markup, String, Context) instead
boolean	confirmSetFileName(Markup markup, java.lang.String fileName, Context ctx) Checks if a modification of the file name is a valid operation
boolean	confirmSetFileName(java.lang.String markup, java.lang.String fileName) Deprecated. use confirmSetFileName(String, String, Context) instead
boolean	confirmSetFileName(java.lang.String markup, java.lang.String fileName, Context ctx) Checks if a modification of the file name is a valid operation
boolean	confirmSetZipInputStream(Markup markup, java.util.zip.ZipInputStream in) Deprecated. use confirmSetZipInputStream(Markup, ZipInputStream, Context) instead
boolean	confirmSetZipInputStream(Markup markup, java.util.zip.ZipInputStream in, Context ctx) Checks if an assignment of the ZIP stream is a valid operation.
boolean	confirmSetZipInputStream(java.lang.String markup, java.util.zip.ZipInputStream in) Deprecated. use confirmSetZipInputStream(String, ZipInputStream, Context) instead
boolean	confirmSetZipInputStream(java.lang.String markup, java.util.zip.ZipInputStream in, Context ctx) Checks if an assignment of the ZIP stream is a valid operation.
void	setFileName(Markup markup, java.lang.String fileName) Deprecated. use setFileName(Markup, String, Context) instead
void	setFileName(Markup markup, java.lang.String fileName, Context ctx) Associates the filename of a static resource with a markup.
void	setFileName(Markup markup, java.lang.String fileName, Context ctx, boolean forceDelete) Associates the filename of a static resource with a markup.
void	setFileName(java.lang.String markup, java.lang.String fileName) Deprecated. use setFileName(String, String, Context) instead
void	setFileName(java.lang.String markup, java.lang.String fileName, Context ctx) Associates the filename of a static resource with a markup.
void	setFileName(java.lang.String markup, java.lang.String fileName, Context ctx, boolean forceDelete) Associates the filename of a static resource with a markup.
java.io.OutputStream	setStaticContent(Markup markup, java.lang.String fileName) Deprecated. use setStaticContent(Markup, String, Context) instead
java.io.OutputStream	setStaticContent(Markup markup, java.lang.String fileName, Context ctx) Associates zipped content with a markup.
java.io.OutputStream	setStaticContent(Markup markup, java.lang.String fileName, Context ctx, boolean forceDelete) Associates zipped content with a markup.
java.io.OutputStream	setStaticContent(java.lang.String markup, java.lang.String fileName) Deprecated. use setStaticContent(String, String, Context) instead
java.io.OutputStream	setStaticContent(java.lang.String markup, java.lang.String fileName, Context ctx) Associates zipped content with a markup.
java.io.OutputStream	setStaticContent(java.lang.String markup, java.lang.String fileName, Context ctx, boolean forceDelete) Associates zipped content with a markup.
void	setZipInputStream(Markup markup, java.lang.String fileName, java.util.zip.ZipInputStream in) Deprecated. use setZipInputStream(Markup, String, ZipInputStream, Context) instead
void	setZipInputStream(Markup markup, java.lang.String fileName, java.util.zip.ZipInputStream in, Context ctx) Associates the content of a ZipInputStream with a markup.
void	setZipInputStream(Markup markup, java.lang.String fileName, java.util.zip.ZipInputStream in, Context ctx, boolean forceDelete) Associates the content of a ZipInputStream with a markup.
void	setZipInputStream(java.lang.String markup, java.lang.String fileName, java.util.zip.ZipInputStream in) Deprecated. use setZipInputStream(String, String, ZipInputStream, Context) instead
void	setZipInputStream(java.lang.String markup, java.lang.String fileName, java.util.zip.ZipInputStream in, Context ctx) Associates the content of a ZipInputStream with a markup.
void	setZipInputStream(java.lang.String markup, java.lang.String fileName, java.util.zip.ZipInputStream in, Context ctx, boolean forceDelete) Associates the content of a ZipInputStream with a markup.

Methods inherited from interface com.ibm.portal.ModifiableIdentifiable

getModifiableObjectID

Methods inherited from interface com.ibm.portal.ModifiableLocalized

confirmRemoveDescription, confirmRemoveDescriptions, confirmRemoveDescriptions, confirmRemoveTitle, confirmRemoveTitles, confirmRemoveTitles, confirmRetainDescriptions, confirmRetainTitles, confirmSetAll, confirmSetDescription, confirmSetDescriptions, confirmSetTitle, confirmSetTitles, removeDescription, removeDescriptions, removeDescriptions, removeTitle, removeTitles, removeTitles, retainDescriptions, retainTitles, setAll, setDescription, setDescriptions, setTitle, setTitles

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

addMarkup, addMarkups, confirmAddMarkup, confirmAddMarkups, confirmRemoveMarkup, confirmRemoveMarkups, removeMarkup, removeMarkups

Methods inherited from interface com.ibm.portal.ModifiableActiveFlag

confirmSetActive, setActive

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

addDeviceClass, addDeviceClasses, confirmAddDeviceClass, confirmAddDeviceClasses, confirmRemoveDeviceClass, confirmRemoveDeviceClasses, removeDeviceClass, removeDeviceClasses

Methods inherited from interface com.ibm.portal.content.ThemeSetter

confirmSetTheme, setTheme

Methods inherited from interface com.ibm.portal.content.ModifiableDisplayOptions

confirmSetDisplayOption, confirmSetDisplayOption, setDisplayOption, setDisplayOption

Methods inherited from interface com.ibm.portal.content.StaticContentPage

getFileName, getFileName, getStaticContent, getStaticContent, getZipInputStream, getZipInputStream

Methods inherited from interface com.ibm.portal.content.ContentNode

getContentNodeType

Methods inherited from interface com.ibm.portal.Identifiable

getObjectID

Methods inherited from interface com.ibm.portal.Localized

getDescription, getLocales, getTitle

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

getMarkups, supportsMarkup, supportsMarkup

Methods inherited from interface com.ibm.portal.ActiveFlag

isActive

Methods inherited from interface com.ibm.portal.devicesupport.DeviceClassCapable

getDeviceClasses, supportsDeviceClass

Methods inherited from interface com.ibm.portal.content.ThemeProvider

getTheme

Methods inherited from interface com.ibm.portal.content.DisplayOptions

getDisplayOption, getDisplayOption

Method Detail

confirmSetFileName

@Deprecated
boolean confirmSetFileName(Markup markup,
                                      java.lang.String fileName)
                           throws ModelException

Deprecated. use confirmSetFileName(Markup, String, Context) instead

Checks if a modification of the file name is a valid operation

Parameters:

markup - markup name

fileName - new filename, may be null

Returns:

true if the option may be changed, else false

Throws:

ModelException

confirmSetFileName

boolean confirmSetFileName(Markup markup,
                           java.lang.String fileName,
                           Context ctx)
                           throws ModelException

Checks if a modification of the file name is a valid operation

Parameters:

markup - markup name

fileName - new filename, may be null

ctx - the COR context used to resolve references, may be null

Returns:

true if the option may be changed, else false

Throws:

ModelException

confirmSetFileName

@Deprecated
boolean confirmSetFileName(java.lang.String markup,
                                      java.lang.String fileName)

Deprecated. use confirmSetFileName(String, String, Context) instead

Checks if a modification of the file name is a valid operation

Parameters:

markup - markup name

fileName - new filename, may be null

Returns:

true if the option may be changed, else false

confirmSetFileName

boolean confirmSetFileName(java.lang.String markup,
                           java.lang.String fileName,
                           Context ctx)

Checks if a modification of the file name is a valid operation

Parameters:

markup - markup name

fileName - new filename, may be null

ctx - the COR context used to resolve references, may be null

Returns:

true if the option may be changed, else false

confirmSetZipInputStream

@Deprecated
boolean confirmSetZipInputStream(Markup markup,
                                            java.util.zip.ZipInputStream in)
                                 throws ModelException

Deprecated. use confirmSetZipInputStream(Markup, ZipInputStream, Context) instead

Checks if an assignment of the ZIP stream is a valid operation. The stream will NOT be exhausted as a result of calling this method

Parameters:

markup - markup name

in - the stream containing the resources

Returns:

true if the option may be changed, else false

Throws:

ModelException

confirmSetZipInputStream

boolean confirmSetZipInputStream(Markup markup,
                                 java.util.zip.ZipInputStream in,
                                 Context ctx)
                                 throws ModelException

Checks if an assignment of the ZIP stream is a valid operation. The stream will NOT be exhausted as a result of calling this method

Parameters:

markup - markup name

in - the stream containing the resources

ctx - the COR context used to resolve references, may be null

Returns:

true if the option may be changed, else false

Throws:

ModelException

confirmSetZipInputStream

@Deprecated
boolean confirmSetZipInputStream(java.lang.String markup,
                                            java.util.zip.ZipInputStream in)

Deprecated. use confirmSetZipInputStream(String, ZipInputStream, Context) instead

Checks if an assignment of the ZIP stream is a valid operation. The stream will NOT be exhausted as a result of calling this method

Parameters:

markup - markup name

in - the stream containing the resources

Returns:

true if the option may be changed, else false

confirmSetZipInputStream

boolean confirmSetZipInputStream(java.lang.String markup,
                                 java.util.zip.ZipInputStream in,
                                 Context ctx)

Checks if an assignment of the ZIP stream is a valid operation. The stream will NOT be exhausted as a result of calling this method

Parameters:

markup - markup name

in - the stream containing the resources

ctx - the COR context used to resolve references, may be null

Returns:

true if the option may be changed, else false

setFileName

@Deprecated
void setFileName(Markup markup,
                            java.lang.String fileName)
                 throws CannotModifyPropertyException,
                        ModelException,
                        java.io.IOException

Deprecated. use setFileName(Markup, String, Context) instead

Associates the filename of a static resource with a markup. This filename references content inside a ZIP file that is also potentially assigned.

Parameters:

markup - markup name

fileName - new filename, may be null

Throws:

ModelException

CannotModifyPropertyException

java.io.IOException

setFileName

void setFileName(Markup markup,
                 java.lang.String fileName,
                 Context ctx)
                 throws CannotModifyPropertyException,
                        ModelException,
                        java.io.IOException

Associates the filename of a static resource with a markup. This filename references content inside a ZIP file that is also potentially assigned.

Parameters:

markup - markup name

fileName - new filename, may be null

ctx - the COR context used to resolve references, may be null

Throws:

ModelException

CannotModifyPropertyException

java.io.IOException

setFileName

void setFileName(Markup markup,
                 java.lang.String fileName,
                 Context ctx,
                 boolean forceDelete)
                 throws CannotModifyPropertyException,
                        ModelException,
                        java.io.IOException

Associates the filename of a static resource with a markup. This filename references content inside a ZIP file that is also potentially assigned.

Parameters:

markup - markup name

fileName - new filename, may be null

ctx - the COR context used to resolve references, may be null

forceDelete - indicates if the content old content will be fully removed.

Throws:

ModelException

CannotModifyPropertyException

java.io.IOException

Since:

800

setFileName

@Deprecated
void setFileName(java.lang.String markup,
                            java.lang.String fileName)
                 throws CannotModifyPropertyException,
                        ModelException,
                        java.io.IOException

Deprecated. use setFileName(String, String, Context) instead

Associates the filename of a static resource with a markup. This filename references content inside a ZIP file that is also potentially assigned.

Parameters:

markup - markup name

fileName - new filename, may be null

Throws:

ModelException

CannotModifyPropertyException

java.io.IOException

setFileName

void setFileName(java.lang.String markup,
                 java.lang.String fileName,
                 Context ctx)
                 throws CannotModifyPropertyException,
                        ModelException,
                        java.io.IOException

Associates the filename of a static resource with a markup. This filename references content inside a ZIP file that is also potentially assigned.

Parameters:

markup - markup name

fileName - new filename, may be null

ctx - the COR context used to resolve references, may be null

Throws:

ModelException

CannotModifyPropertyException

java.io.IOException

setFileName

void setFileName(java.lang.String markup,
                 java.lang.String fileName,
                 Context ctx,
                 boolean forceDelete)
                 throws CannotModifyPropertyException,
                        ModelException,
                        java.io.IOException

Associates the filename of a static resource with a markup. This filename references content inside a ZIP file that is also potentially assigned.

Parameters:

markup - markup name

fileName - new filename, may be null

ctx - the COR context used to resolve references, may be null

forceDelete - indicates if the content old content will be fully removed.

Throws:

ModelException

CannotModifyPropertyException

java.io.IOException

Since:

800

setStaticContent

@Deprecated
java.io.OutputStream setStaticContent(Markup markup,
                                                 java.lang.String fileName)
                                      throws ModelException

Deprecated. use setStaticContent(Markup, String, Context) instead

Associates zipped content with a markup. The content needs to be written to the OutputStream that is returned by this method. Only after the OutputStream.close() method is called the association is complete.

Parameters:

markup - markup name

fileName - new filename, may be null

Returns:

the stream that receives the zipped bytes

Throws:

ModelException

setStaticContent

java.io.OutputStream setStaticContent(Markup markup,
                                      java.lang.String fileName,
                                      Context ctx)
                                      throws ModelException

Associates zipped content with a markup. The content needs to be written to the OutputStream that is returned by this method. Only after the OutputStream.close() method is called the association is complete.

Parameters:

markup - markup name

fileName - new filename, may be null

ctx - the COR context used to resolve references, may be null

Returns:

the stream that receives the zipped bytes

Throws:

ModelException

setStaticContent

java.io.OutputStream setStaticContent(Markup markup,
                                      java.lang.String fileName,
                                      Context ctx,
                                      boolean forceDelete)
                                      throws ModelException

Associates zipped content with a markup. The content needs to be written to the OutputStream that is returned by this method. Only after the OutputStream.close() method is called the association is complete.

Parameters:

markup - markup name

fileName - new filename, may be null

ctx - the COR context used to resolve references, may be null

forceDelete - indicates if the content old content will be fully removed.

Returns:

the stream that receives the zipped bytes

Throws:

ModelException

Since:

800

setStaticContent

@Deprecated
java.io.OutputStream setStaticContent(java.lang.String markup,
                                                 java.lang.String fileName)

Deprecated. use setStaticContent(String, String, Context) instead

Associates zipped content with a markup. The content needs to be written to the OutputStream that is returned by this method. Only after the OutputStream.close() method is called the association is complete.

Parameters:

markup - markup name

fileName - new filename, may be null

Returns:

the stream that receives the zipped bytes

setStaticContent

java.io.OutputStream setStaticContent(java.lang.String markup,
                                      java.lang.String fileName,
                                      Context ctx)

Associates zipped content with a markup. The content needs to be written to the OutputStream that is returned by this method. Only after the OutputStream.close() method is called the association is complete.

Parameters:

markup - markup name

fileName - new filename, may be null

ctx - the COR context used to resolve references, may be null

Returns:

the stream that receives the zipped bytes

setStaticContent

java.io.OutputStream setStaticContent(java.lang.String markup,
                                      java.lang.String fileName,
                                      Context ctx,
                                      boolean forceDelete)

Associates zipped content with a markup. The content needs to be written to the OutputStream that is returned by this method. Only after the OutputStream.close() method is called the association is complete.

Parameters:

markup - markup name

fileName - new filename, may be null

ctx - the COR context used to resolve references, may be null

forceDelete - indicates if the content old content will be fully removed.

Returns:

the stream that receives the zipped bytes

Since:

800

setZipInputStream

@Deprecated
void setZipInputStream(Markup markup,
                                  java.lang.String fileName,
                                  java.util.zip.ZipInputStream in)
                       throws java.io.IOException,
                              CannotModifyPropertyException,
                              ModelException

Deprecated. use setZipInputStream(Markup, String, ZipInputStream, Context) instead

Associates the content of a ZipInputStream with a markup. This stream contains the static resources associated with this page.

Parameters:

markup - markup name

fileName - new filename, may be null

in - the stream containing the resources

Throws:

java.io.IOException

CannotModifyPropertyException

ModelException

Since:

800

setZipInputStream

void setZipInputStream(Markup markup,
                       java.lang.String fileName,
                       java.util.zip.ZipInputStream in,
                       Context ctx)
                       throws java.io.IOException,
                              CannotModifyPropertyException,
                              ModelException

Associates the content of a ZipInputStream with a markup. This stream contains the static resources associated with this page.

Parameters:

markup - markup name

fileName - new filename, may be null

in - the stream containing the resources

ctx - the COR context used to resolve references, may be null

Throws:

java.io.IOException

CannotModifyPropertyException

ModelException

setZipInputStream

void setZipInputStream(Markup markup,
                       java.lang.String fileName,
                       java.util.zip.ZipInputStream in,
                       Context ctx,
                       boolean forceDelete)
                       throws java.io.IOException,
                              CannotModifyPropertyException,
                              ModelException

Associates the content of a ZipInputStream with a markup. This stream contains the static resources associated with this page.

Parameters:

markup - markup name

fileName - new filename, may be null

in - the stream containing the resources

ctx - the COR context used to resolve references, may be null

forceDelete - indicates if the content old content will be fully removed.

Throws:

java.io.IOException

CannotModifyPropertyException

ModelException

Since:

800

setZipInputStream

@Deprecated
void setZipInputStream(java.lang.String markup,
                                  java.lang.String fileName,
                                  java.util.zip.ZipInputStream in)
                       throws java.io.IOException,
                              CannotModifyPropertyException,
                              CannotInstantiateModifiableNodeException,
                              ModelException

Deprecated. use setZipInputStream(String, String, ZipInputStream, Context) instead

Associates the content of a ZipInputStream with a markup. This stream contains the static resources associated with this page.

Parameters:

markup - markup name

fileName - new filename, may be null

in - the stream containing the resources

Throws:

java.io.IOException

CannotModifyPropertyException

CannotInstantiateModifiableNodeException

ModelException

setZipInputStream

void setZipInputStream(java.lang.String markup,
                       java.lang.String fileName,
                       java.util.zip.ZipInputStream in,
                       Context ctx)
                       throws java.io.IOException,
                              CannotModifyPropertyException,
                              CannotInstantiateModifiableNodeException,
                              ModelException

Associates the content of a ZipInputStream with a markup. This stream contains the static resources associated with this page.

Parameters:

markup - markup name

fileName - new filename, may be null

in - the stream containing the resources

ctx - the COR context used to resolve references, may be null

Throws:

java.io.IOException

CannotModifyPropertyException

CannotInstantiateModifiableNodeException

ModelException

setZipInputStream

void setZipInputStream(java.lang.String markup,
                       java.lang.String fileName,
                       java.util.zip.ZipInputStream in,
                       Context ctx,
                       boolean forceDelete)
                       throws java.io.IOException,
                              CannotModifyPropertyException,
                              CannotInstantiateModifiableNodeException,
                              ModelException

Associates the content of a ZipInputStream with a markup. This stream contains the static resources associated with this page.

Parameters:

markup - markup name

fileName - new filename, may be null

in - the stream containing the resources

ctx - the COR context used to resolve references, may be null

forceDelete - indicates if the content old content will be fully removed.

Throws:

java.io.IOException

CannotModifyPropertyException

CannotInstantiateModifiableNodeException

ModelException

Since:

800