com.businessobjects.publisher.distribution
Interface IDistributionCompleteContext

public interface IDistributionCompleteContext

An IDistributionCompleteContext object is passed to IDistributionCompletePlugin implementations when IDistributionCompletePlugin.onDistributionComplete(com.businessobjects.publisher.distribution.IDistributionCompleteContext) is invoked.

Method Summary

ILogger	getAdminLog() Deprecated. For internal use only. Use IDistributionCompleteContext.getAdminLogAdapter() instead.
ILoggerAdapter	getAdminLogAdapter() Returns a logger that can be used to log information during post-distribution.
IInfoStore	getInfoStore() Returns an InfoStore object that can be used to query the BusinessObjects Enterprise repository.
java.lang.String	getOptions() Returns the generic parameter value.
IPublication	getPublication() Returns the publication that invoked this plugin.
IScopeBatch	getScopeBatch() For internal use only.
java.util.List	getScopeFilters(IInfoObject doc) Returns a list of IScopeFilter objects that can be used to obtain personalization information
void	setOptions(java.lang.String options) Sets the generic parameter value.

Method Detail

getInfoStore

IInfoStore getInfoStore()

Returns an InfoStore object that can be used to query the BusinessObjects Enterprise repository.

Returns:

IInfoStore associated with the current session.

getPublication

IPublication getPublication()

Returns the publication that invoked this plugin.

Returns:

IPublication containing the publication instance.

getScopeBatch

IScopeBatch getScopeBatch()

For internal use only.

getOptions

java.lang.String getOptions()

Returns the generic parameter value. This value is set either in the publication UI or by calling IPublicationEventHandlerInfo.setGenericParameter(java.lang.String).

Returns:

String containing the parameter value.

setOptions

void setOptions(java.lang.String options)

Sets the generic parameter value. This value is usually set either in the publication UI or by calling IPublicationEventHandlerInfo.setGenericParameter(java.lang.String).

Parameters:

options - A String containing the parameter value.

getAdminLog

ILogger getAdminLog()

Deprecated. For internal use only. Use IDistributionCompleteContext.getAdminLogAdapter() instead.

getScopeFilters

java.util.List getScopeFilters(IInfoObject doc)
                               throws PublishingException

Returns a list of IScopeFilter objects that can be used to obtain personalization information

Parameters:

doc - is one of the documents in the publication

Throws:

PublishingException

getAdminLogAdapter

ILoggerAdapter getAdminLogAdapter()

Returns a logger that can be used to log information during post-distribution.

Returns:

ILoggerAdapter object.