com.endeca.infront.assembler

Interface Assembler

public interface Assembler

Used to invoke a single assembly process.

Field Summary

Fields

Modifier and Type	Field and Description
static String	TOPIC_ASSEMBLE The topic of events dispatched when the assemble process is invoked

Method Summary

Modifier and Type	Method and Description
void	addAssemblerEventListener(AssemblerEventListener pListener) Adds a listener to all activity within the context of this request.
ContentItem	assemble(ContentItem pContentItem) Invokes the assembly process and returns the assembled results.
void	removeAssemblerEventListener(AssemblerEventListener pListener) Removes a listener previously added by addAssemblerEventListener(AssemblerEventListener)

Field Detail

TOPIC_ASSEMBLE

static final String TOPIC_ASSEMBLE

The topic of events dispatched when the assemble process is invoked

Method Detail

assemble

ContentItem assemble(ContentItem pContentItem)
              throws AssemblerException

Invokes the assembly process and returns the assembled results.

Parameters:

pContentItem - cartridge instance configuration. The assembler, associated with this request context, will resolve and invoke a CartridgeHandler based upon the content item type attribute.

Returns:

the assembled results.

Throws:

AssemblerException - if the entire assembly process was terminated.

See Also:

CartridgeHandler.preprocess(ContentItem), CartridgeHandler.process(ContentItem)

addAssemblerEventListener

void addAssemblerEventListener(AssemblerEventListener pListener)

Adds a listener to all activity within the context of this request.

Parameters:

pListener - an AssemblerEventListener

removeAssemblerEventListener

void removeAssemblerEventListener(AssemblerEventListener pListener)

Removes a listener previously added by addAssemblerEventListener(AssemblerEventListener)

Parameters:

pListener - an AssemblerEventListener