com.businessobjects.publisher.dynamicrecipients
Interface IDataProviderContext

All Superinterfaces:

java.io.Serializable

public interface IDataProviderContext
extends java.io.Serializable

An IDataProviderContext object is passed to IDataProvider implementations when IDataProvider.getRecipients(com.businessobjects.publisher.dynamicrecipients.IDataProviderContext) is invoked.

Nested Class Summary

static interface

IDataProviderContext.CeDataProviderType This interface defines constants used to identify the type of data provider.

Method Summary

boolean	equalsIgnoreFilter(java.lang.Object obj) For internal use only.
int	getDocumentID() For internal use only.
IEnterpriseSession	getEnterpriseSession() Returns the session for the current user.
java.lang.String	getGenericParameter() Returns the value specified for the generic parameter that was to the data provider.
java.util.Locale	getLocale() Returns the locale of the client.
int	getPublicationInstanceID() For internal use only.
IRecipientFilter	getRecipientFilter() For internal use only.
java.lang.String	getSourceName() For internal use only.
void	setDocumentID(int documentID_) For internal use only.
void	setEnterpriseSession(IEnterpriseSession sess_) For internal use only.
void	setGenericParameter(java.lang.String parameterValue_) For internal use only.
void	setRecipientFilter(IRecipientFilter filter_) For internal use only.
void	setSourceName(java.lang.String sourceName_) For internal use only.

Method Detail

getEnterpriseSession

IEnterpriseSession getEnterpriseSession()

Returns the session for the current user.

Returns:

the IEnterpriseSession for the current user.

setEnterpriseSession

void setEnterpriseSession(IEnterpriseSession sess_)

For internal use only.

getPublicationInstanceID

int getPublicationInstanceID()

For internal use only. One usage of this ID is to allow scheduling of a dynamic recipient document instance to under the Publication Instance object.

getDocumentID

int getDocumentID()

For internal use only.

setDocumentID

void setDocumentID(int documentID_)

For internal use only.

getSourceName

java.lang.String getSourceName()

For internal use only.

setSourceName

void setSourceName(java.lang.String sourceName_)

For internal use only.

getGenericParameter

java.lang.String getGenericParameter()

Returns the value specified for the generic parameter that was to the data provider.

Returns:

A String containing the paramete value.

setGenericParameter

void setGenericParameter(java.lang.String parameterValue_)

For internal use only.

getRecipientFilter

IRecipientFilter getRecipientFilter()

For internal use only.

setRecipientFilter

void setRecipientFilter(IRecipientFilter filter_)

For internal use only.

getLocale

java.util.Locale getLocale()

Returns the locale of the client.

Returns:

The locale set by the client.

equalsIgnoreFilter

boolean equalsIgnoreFilter(java.lang.Object obj)

For internal use only.