Package com.pnfsoftware.jeb.core

Interface IUnitContribution

All Superinterfaces:

IDynamicTargetPlugin, IPlugin

public interface IUnitContribution
extends IDynamicTargetPlugin

A unit contribution plugin.

Method Summary

Modifier and Type	Method	Description
TypedContent	getItemInformation(IAddressableUnit targetUnit, long itemId, String itemText, List<Object> documentObjects)	Provide some information for a given interactive item.
TypedContent	getLocationInformation(IAddressableUnit targetUnit, String location)	Provide some information for a given location URI.

Methods inherited from interface com.pnfsoftware.jeb.core.IDynamicTargetPlugin

getPrimaryTarget, isTarget, setPrimaryTarget

Methods inherited from interface com.pnfsoftware.jeb.core.IPlugin

dispose, getData, getPluginInformation, setData

Method Details

getItemInformation

TypedContent getItemInformation(IAddressableUnit targetUnit,
 long itemId,
 String itemText,
 List<Object> documentObjects)

Provide some information for a given interactive item.

Parameters:

targetUnit - the target unit

itemId - the identifier of an item managed by the target unit

itemText - the optional item text

documentObjects - optional list of document objects associated to the provided item

Returns:

content data of the contribution; null if none

getLocationInformation

TypedContent getLocationInformation(IAddressableUnit targetUnit,
 String location)

Provide some information for a given location URI.

Parameters:

targetUnit - the target unit

location - a location/URI

Returns:

content data of the contribution; null if none