com.esri.gpt.control.search.browse
Class TocContext

java.lang.Object
  com.esri.gpt.control.search.browse.TocContext

public class TocContext
extends Object

Holds context properties and summary information for a build toc request.

Constructor Summary

TocContext()
Default constructor.

Method Summary

TocIndexAdapter	getIndexAdapter() Gets the Lucene index adapter.
MessageBroker	getMessageBroker() Gets the resource bundle message broker.
String	getMimeType() Gets the HTTP response MIME type.
String	getOutputFormat() Gets the output format.
RequestContext	getRequestContext() Gets the underlying request context.
String	getSubjectResourceID() Gets the subject resource identifier (if applicable).
void	setMessageBroker(MessageBroker messageBroker) Sets the resource bundle message broker.
void	setOutputFormat(String outputFormat) Sets the HTTP output format (MIME type).
void	setRequestContext(RequestContext requestContext) Sets the underlying request context.
void	setSubjectResourceID(String id) Sets the subject resource identifier (if applicable).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TocContext

public TocContext()

Default constructor.

Method Detail

getIndexAdapter

public TocIndexAdapter getIndexAdapter()

Gets the Lucene index adapter.

Returns:

the index adapter.

getMessageBroker

public MessageBroker getMessageBroker()

Gets the resource bundle message broker.

Returns:

the message broker (can be null)

setMessageBroker

public void setMessageBroker(MessageBroker messageBroker)

Sets the resource bundle message broker.

Parameters:

messageBroker - the message broker

getMimeType

public String getMimeType()

Gets the HTTP response MIME type.

Returns:

the response MIME type

getOutputFormat

public String getOutputFormat()

Gets the output format.

Returns:

the output format (can be null)

setOutputFormat

public void setOutputFormat(String outputFormat)

Sets the HTTP output format (MIME type).

Parameters:

outputFormat - the output format

getRequestContext

public RequestContext getRequestContext()

Gets the underlying request context.

Returns:

the request context

setRequestContext

public void setRequestContext(RequestContext requestContext)

Sets the underlying request context.

Parameters:

requestContext - the request context

getSubjectResourceID

public String getSubjectResourceID()

Gets the subject resource identifier (if applicable).

Returns:

the resource id

setSubjectResourceID

public void setSubjectResourceID(String id)

Sets the subject resource identifier (if applicable).

Parameters:

id - the resource id