com.businessobjects.rebean.wi
Interface ChangeDataSourceObjectMapping

public interface ChangeDataSourceObjectMapping

Warning:This interface is no longer functional from the SAP BusinessObjects XI 4.0 release onwards.

ChangeDataSourceObjectMapping interface defines a mapping between two data source objects when replacing a data source.

Since:

11.5

Method Summary

DataSourceObject	getFromObject() The object in the old data source that is being replaced.
ChangeDataSourceMapping	getMapping() Returns the mapping to which this object mapping is part of.
ChangeDataSourceMappingDetail	getMappingDetail() The detail of how the default mapping was found.
DataSourceObject	getToObject() The object that will replace the source object in the document after changing the data source.
void	setToObject(DataSourceObject object) Sets the data source object from the new data source, or null when the source object should be removed from the document without a replacement.

Method Detail

getFromObject

DataSourceObject getFromObject()

The object in the old data source that is being replaced.

Returns:

The old object.

getToObject

DataSourceObject getToObject()

The object that will replace the source object in the document after changing the data source. REBean will provide a guess to the best match by default, but users can change this using ChangeDataSourceObjectMapping.setToObject(DataSourceObject).

When this method returns null, the source object will be removed from the document without being replaced by an object from the new data source.

Returns:

The new object, or null.

setToObject

void setToObject(DataSourceObject object)

Sets the data source object from the new data source, or null when the source object should be removed from the document without a replacement.

After calling this method, ChangeDataSourceObjectMapping.getMappingDetail() will always return ChangeDataSourceMappingDetail.CUSTOM.

Parameters:

object - The new object, or null.

Throws:

java.lang.IllegalArgumentException - Thrown when object is not part of the new data source, or when the qualification and type are not identical to the source object.

getMappingDetail

ChangeDataSourceMappingDetail getMappingDetail()

The detail of how the default mapping was found.

Returns:

The detail of how the default mapping was found.

getMapping

ChangeDataSourceMapping getMapping()

Returns the mapping to which this object mapping is part of.

Returns:

The mapping this object mapping is part of.