com.endeca.infront.content
Class MdexContentRequestBroker

java.lang.Object
  com.endeca.infront.content.MdexContentRequestBroker

public class MdexContentRequestBroker
extends Object

Internal class used by Endeca cartridge handlers used to retrieve content using the MDEX-based rules engine -- Should not be used directly outside of Endeca content cartridge handlers.

Field Summary

protected boolean	mAuditEnabled
protected MdexResource	mMdexResource
protected NavigationState	mNavigationState
protected UserState	mUserState
static String	ZONE_KEY Name of zone property in supplemental property map.

Constructor Summary

MdexContentRequestBroker(MdexResource pMdexResource, NavigationState pNavigationState, UserState pUserState, boolean pAuditEnabled)
Builds an MDEX Content Request Broker

Method Summary

List<com.endeca.infront.content.support.AuditContentItem>	getAuditContents(String pContentCollection) This method is for internal Oracle use only and should never be called. If audit is enabled, returns the audit contents.
List<ContentItem>	getContents(String pContentCollection, int pRuleLimit) This method is for internal Oracle use only and should never be called. Query for rule-triggered content from a specified content collection.
boolean	isAuditEnabled() This method is for internal Oracle use only and should never be called. Returns a value indicating whether audit is enabled.

Methods inherited from class java.lang.Object

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

Field Detail

ZONE_KEY

public static final String ZONE_KEY

Name of zone property in supplemental property map.

See Also:

Constant Field Values

mMdexResource

protected final MdexResource mMdexResource

mNavigationState

protected final NavigationState mNavigationState

mUserState

protected final UserState mUserState

mAuditEnabled

protected final boolean mAuditEnabled

Constructor Detail

MdexContentRequestBroker

public MdexContentRequestBroker(MdexResource pMdexResource,
                                NavigationState pNavigationState,
                                UserState pUserState,
                                boolean pAuditEnabled)

Builds an MDEX Content Request Broker

Parameters:

pMdexResource - Identifies the MDEX to query

pNavigationState - The navigation state

pUserState - The user segment and date state to use for content queries

pAuditEnabled - True if audit should be enabled

Method Detail

isAuditEnabled

public boolean isAuditEnabled()

This method is for internal Oracle use only and should never be called.
Returns a value indicating whether audit is enabled.

getContents

public List<ContentItem> getContents(String pContentCollection,
                                     int pRuleLimit)
                              throws ContentException

This method is for internal Oracle use only and should never be called.
Query for rule-triggered content from a specified content collection.

Parameters:

pContentCollection - the ID of the content collection

pRuleLimit - an upper bound on the length of the content list returned by this method. If this value is less than one, there is no limit.

Returns:

a list of content items, never null, never longer than the upper bound

Throws:

ContentException - if an error in the system prevents access to the content

getAuditContents

public List<com.endeca.infront.content.support.AuditContentItem> getAuditContents(String pContentCollection)
                                                                           throws ContentException

This method is for internal Oracle use only and should never be called.
If audit is enabled, returns the audit contents. Audit content is metadata about the content items returned by the MDEX.

Parameters:

pContentCollection - the ID of the desired content collection

Returns:

a list of audit content items. May be empty, but never null.

Throws:

ContentException