com.novell.afw.portlet.api
Interface EbiMarkupContext

public interface EbiMarkupContext

This interface is for markup context.

Since:

v5.0

Method Summary

com.novell.afw.wsrp.core.CacheControl	getCacheControl() Gets a cache control object (for expiration cache property support)
Locale	getLocale() Gets the locale used for the markup.
byte[]	getMarkupBinary() Gets the markup segment as a byte array.
String	getMarkupString() Gets the markup String.
String	getMimeType() Gets the mime type.
String	getPreferredTitle() Gets the preferred title.
Boolean	getRequiresUrlRewriting() Gets the Requires URL Rewriting flag.
Boolean	getUseCachedMarkup() Gets the Use Cached Markup flag.
void	setCacheControl(com.novell.afw.wsrp.core.CacheControl cacheControlVal) Sets a cache control object.
void	setLocale(Locale locale) Sets the locale used for the markup.
void	setMarkupBinary(byte[] markupBinaryVal) Sets the markup segment.
void	setMarkupString(String markupStringVal) Sets the markup String.
void	setMimeType(String mimeTypeVal) Sets the mime type.
void	setPreferredTitle(String preferredTitleVal) Sets the preferred title.
void	setRequiresUrlRewriting(Boolean requiresUrlRewritingVal) Sets the Requires URL Rewriting flag.
void	setUseCachedMarkup(Boolean useCachedMarkupVal) Sets the Use Cached Markup flag.

Method Detail

getUseCachedMarkup

public Boolean getUseCachedMarkup()

Gets the Use Cached Markup flag.

Returns:

an EbiMarkupContext object.

Since:

v5.0

setUseCachedMarkup

public void setUseCachedMarkup(Boolean useCachedMarkupVal)

Sets the Use Cached Markup flag.

Parameters:

useCachedMarkupValue - a boolean value if set to true, use cached markup.

Since:

v5.0

getMimeType

public String getMimeType()

Gets the mime type.

Returns:

the mime type.

Since:

v5.0

setMimeType

public void setMimeType(String mimeTypeVal)

Sets the mime type.

Parameters:

mimeTypeVal - a mime type.

Since:

v5.0

getMarkupString

public String getMarkupString()

Gets the markup String.

Returns:

the markup String.

Since:

v5.0

setMarkupString

public void setMarkupString(String markupStringVal)

Sets the markup String.

Parameters:

markupStringVal - a markup String

Since:

v5.0

getMarkupBinary

public byte[] getMarkupBinary()

Gets the markup segment as a byte array.

Returns:

a byte array for the markup segment.

Since:

v5.0

setMarkupBinary

public void setMarkupBinary(byte[] markupBinaryVal)

Sets the markup segment.

Parameters:

markupBinaryVal - a byte array for the markup segment.

Since:

v5.0

getLocale

public Locale getLocale()

Gets the locale used for the markup.

Returns:

the locale.

Since:

v5.0

setLocale

public void setLocale(Locale locale)

Sets the locale used for the markup.

Parameters:

locale - the locale for this markup.

Since:

v5.0

getRequiresUrlRewriting

public Boolean getRequiresUrlRewriting()

Gets the Requires URL Rewriting flag.

Returns:

a boolean value indicating whether it requires URL rewriting.

Since:

v5.0

setRequiresUrlRewriting

public void setRequiresUrlRewriting(Boolean requiresUrlRewritingVal)

Sets the Requires URL Rewriting flag.

Parameters:

requiresUrlRewritingVal - a boolean value indicating whether it requires URL rewriting.

Since:

v5.0

getCacheControl

public com.novell.afw.wsrp.core.CacheControl getCacheControl()

Gets a cache control object (for expiration cache property support)

CacheControl class is provided in wsrp.jar. (The classes included in wsrp.jar are generated from the WSRP wsdl files provided by OASIS Committee based on WSRP Specification).

Returns:

a CacheControl object.

Since:

v5.0

setCacheControl

public void setCacheControl(com.novell.afw.wsrp.core.CacheControl cacheControlVal)

Sets a cache control object.

Parameters:

cacheControlVal - a CacheControl object

Since:

v5.0

getPreferredTitle

public String getPreferredTitle()

Gets the preferred title.

Returns:

the preferred title.

Since:

v5.0

setPreferredTitle

public void setPreferredTitle(String preferredTitleVal)

Sets the preferred title.

Parameters:

perferredTitleVal - a title to be set as preferred title.

Since:

v5.0