com.plumtree.server
Interface IPTContent

All Superinterfaces:
IPTUnknown

public interface IPTContent
extends IPTUnknown

Returns gatewayed content. This abstraction should be able to represent either a web response or a file and provide enough information for the content to be served up over HTTP. -jas

Author:
Joseph Stanko
See Also:
IPTGadgetAssociatedContentProvider

Method Summary
 byte[] GetBinaryBody()
          Returns the unprocessed body of the content as an array of bytes.
 byte[] GetBinaryHeaders()
          Deprecated.  
 java.lang.Object[][] GetBody()
          Returns the body of the content as an array of markup fragments, some of which require post-processing.
 java.lang.String GetHeaders()
          Returns the headers of the content.
 boolean GetIsText()
          Returns true if the content is of text type, false otherwise.
 java.lang.String GetMIMEType()
          Returns the MIME Type of this content piece.
 int GetStatusCode()
          Returns the status code of the content.
 boolean IsHostedDisplayMode()
          Returns true if the content should be displayed in hosted mode, i.e.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetMIMEType

java.lang.String GetMIMEType()
Returns the MIME Type of this content piece. May return E_NOTIMPL for certain implementations.

Returns:
The MIME type.

GetBody

java.lang.Object[][] GetBody()
Returns the body of the content as an array of markup fragments, some of which require post-processing. Only available when GetIsText() returns true. -jas

Returns:
A 2D array of markup fragments with columns defined by PT_MARKUP_ARRAY_COLS.

GetBinaryBody

byte[] GetBinaryBody()
Returns the unprocessed body of the content as an array of bytes. Must be used when GetIsText() returns false. -jas

Returns:
The raw content.

GetHeaders

java.lang.String GetHeaders()
Returns the headers of the content.

Returns:
All the headers, including carriage return and newline seperators.

GetBinaryHeaders

byte[] GetBinaryHeaders()
Deprecated. 


GetStatusCode

int GetStatusCode()
Returns the status code of the content.

Returns:
An HTTP status code.

GetIsText

boolean GetIsText()
Returns true if the content is of text type, false otherwise.

Returns:
True if the content is of text type, false otherwise.

IsHostedDisplayMode

boolean IsHostedDisplayMode()
Returns true if the content should be displayed in hosted mode, i.e. with standard portal header, navigation, and footer.

Returns:
True if the content should be displayed in hosted mode.