com.businessobjects.publisher.postprocessing
Interface IPublicationPostProcessingContext

public interface IPublicationPostProcessingContext

This interface contains contextual information about the post-processing publication extension, including the current session, the scope and destination, and the publication that invoked the extension.

Method Summary

ILogger	getAdminLog() Deprecated. For internal use only. Use IPublicationPostProcessingContext.getAdminLogAdapter() instead.
ILoggerAdapter	getAdminLogAdapter() Returns a logger that can be used to log information during post-processing.
IDestination	getDestination() Returns the current destination.
java.util.ArrayList	getDocuments() Returns the static documents and schedulable document artifacts for the current scope and destination.
IEnterpriseSession	getEnterpriseSession() Returns the session associated with the current user.
IInfoStore	getInfoStore() Returns an InfoStore object that can be used to query the BusinessObjects Enterprise repository.
java.io.Serializable	getOptions() Returns the generic parameter value.
java.util.ArrayList	getPluginArtifacts() Returns all artifacts that have been generated during the publishing process.
IPublication	getPublication() Returns the publication that invoked this plugin.
IScopeBatch	getScopeBatch() For internal use only.
IScopeFilter	getScopeFilter(IInfoObject doc) Returns IScopeFilter object that can be used to obtain personalization information
int	getScopeID() Returns the ID of the current scope.
ISecuritySession	getSession() Deprecated. For internal use only. Use IPublicationPostProcessingContext.getEnterpriseSession() instead.
java.lang.String	getTempDirectory() Returns the path of the directory on the processing server that is used by BusinessObjects Enterprise for storing temporary files.
void	setOptions(java.io.Serializable options) Sets the generic parameter value.

Method Detail

getDocuments

java.util.ArrayList getDocuments()

Returns the static documents and schedulable document artifacts for the current scope and destination.

Returns:

ArrayList containing IInfoObject objects.

getPluginArtifacts

java.util.ArrayList getPluginArtifacts()

Returns all artifacts that have been generated during the publishing process.

Returns:

ArrayList containing IInfoObject objects.

getOptions

java.io.Serializable 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.io.Serializable 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.

getSession

ISecuritySession getSession()

Deprecated. For internal use only. Use IPublicationPostProcessingContext.getEnterpriseSession() instead.

Returns the session associated with the current user.

Returns:

ISecuritySession object.

getEnterpriseSession

IEnterpriseSession getEnterpriseSession()

Returns the session associated with the current user.

Returns:

IEnterpriseSession object.

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.

getScopeID

int getScopeID()

Returns the ID of the current scope. Each scope represents a personalized instance of a publication.

Returns:

ID of the scope.

getDestination

IDestination getDestination()

Returns the current destination.

Returns:

IDestination specifying the current destination.

getAdminLog

ILogger getAdminLog()

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

getAdminLogAdapter

ILoggerAdapter getAdminLogAdapter()

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

Returns:

ILoggerAdapter object.

getTempDirectory

java.lang.String getTempDirectory()

Returns the path of the directory on the processing server that is used by BusinessObjects Enterprise for storing temporary files.

Returns:

String containing the path to the temporary directory.

getScopeFilter

IScopeFilter getScopeFilter(IInfoObject doc)
                            throws PublishingException

Returns IScopeFilter object that can be used to obtain personalization information

Parameters:

doc - is one of the documents in the publication

Throws:

PublishingException