|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IGetMarkupBaseResponseContext
A base response context that represents partial output data of the "getMarkup" operation.
Method Summary | |
---|---|
int |
getExpires()
Returns the number of seconds the markup referenced by this context object remains valid. |
String |
getLocale()
Returns the locale of the returned markup. |
String |
getMarkupCharacterSet()
Returns the character set used to encode the markup. |
InputStream |
getMarkupData()
Returns an InputStream to read the returned markup. |
String |
getMimeType()
Returns the Mime type of the returned markup. |
String |
getPreferredTitle()
Returns the title preferred by the portlet. |
String |
getUserScope()
Returns a string indicating when the markup may be used by various users. |
String |
getValidateTag()
Returns a string (unique id on a Producer) that a Consumer can use it to revalidate markup once the expires duration elapses. |
boolean |
isRequiresUrlRewritingOn()
Returns "true" if a Producer/Portlet indicated that the Consumer-side URL rewriting is required. |
boolean |
isUseCachedMarkupOn()
Returns true if the markup the Consumer indicated it has cached is still valid. |
void |
setMarkupCharacterSet(String encoding)
Sets the supplied encoding as the encoding used
for the encapsulated markup. |
void |
setMarkupData(InputStream markupData)
Sets the supplied |
void |
setMimeType(String mimeType)
Sets the supplied string as the Mime type of the returned markup. |
void |
setPreferredTitle(String title)
Sets the supplied title as the portlet's preferred title. |
void |
setRequiresUrlRewritingOn(boolean value)
Sets the supplied value to indicate whether Consumer-side URL rewriting is required or not. |
void |
setUseCachedMarkupOn(boolean value)
Sets the supplied value that indicates to the Consumer that the cached markup is valid or not. |
Methods inherited from interface com.bea.wsrp.model.markup.IBaseResponseContext |
---|
getMimeHeaders, getNamespaceUri, getResponseCookies, render |
Methods inherited from interface com.bea.wsrp.model.markup.ISessionContext |
---|
getSessionExpires, getSessionID, setSessionExpires, setSessionID |
Method Detail |
---|
boolean isUseCachedMarkupOn()
void setUseCachedMarkupOn(boolean value)
value
- a boolean value.String getMimeType()
void setMimeType(String mimeType)
mimeType
- a new Mime type.InputStream getMarkupData() throws IOException
IOException
- if unable to create an input stream.void setMarkupData(InputStream markupData)
markupData
- a new input stream to read the markup.String getMarkupCharacterSet()
void setMarkupCharacterSet(String encoding)
encoding
as the encoding used
for the encapsulated markup.
encoding
- a character set name.String getLocale()
boolean isRequiresUrlRewritingOn()
void setRequiresUrlRewritingOn(boolean value)
value
- a boolean value to indicate Consumer-side URL rewriting is required or not.int getExpires()
String getUserScope()
String getValidateTag()
String getPreferredTitle()
void setPreferredTitle(String title)
title
as the portlet's preferred title.
title
- The portlet's preferred title.
|
Copyright © 2000, 2008, Oracle and/or its affiliates. All rights reserved. | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |