com.businessobjects.dsws.reportengine
Interface TrackData

public interface TrackData

TrackData interface is used to track the data changes in the document.

Example: Activating track data changes on the current report

 RetrieveMustFillInfo fillInfo = RetrieveMustFillInfo.Factory.newInstance();
 RetrieveTrackData trackdata = RetrieveTrackData.Factory.newInstance();
 fillInfo.setRetrieveTrackData(trackdata);

 DocumentInformation docInfo = boRepEng.getDocumentInformation(strDocid,fillInfo,null,null,null);
 TrackData objTrackData = docInfo.getTrackData();
 objTrackData.setActive(true);
 objTrackData.setTrackDataViewMode(TrackDataViewMode.CURRENT_REPORT);
 objTrackData.setCurrentAsReference(true);
 objTrackData.setShowChanges(true);

 UpdateTrackData updateTDC = UpdateTrackData.Factory.newInstance();
 updateTDC.setTrackData(objTrackData);
 Action[] actions = new Action[1];
 actions[0] = updateTDC;
 docInfo = boRepEng.getDocumentInformation(strDocid,fillInfo,actions,null,null);

 actions[0] = Refresh.Factory.newInstance();
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 RetrieveView retBOView = RetrieveView.Factory.newInstance();
 retBOData.setRetrieveView(retBOView);

 docInfo = boRepEng.getDocumentInformation(strDocid,fillInfo,actions,null,retBOData);

 CharacterView myBOView = (CharacterView)docInfo.getView();
 String docContents = myBOView.getContent();
 out.print(docContents);
 

Since:

12.0

See Also:

TrackDataViewMode, DocumentInformation, UpdateTrackData, RetrieveMustFillInfo

Nested Class Summary

static class

TrackData.Factory A class with methods for creating instances of the TrackData type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

boolean	getActive() Internal Use Only.
boolean	getCurrentAsReference() Internal use only
java.util.Calendar	getReferenceDate() Internal Use Only.
boolean	getShowChanges() Internal use only
TrackDataViewMode.Enum	getTrackDataViewMode() Internal Use Only.
void	setActive(boolean active) Activates the track data if the boolean is set to true
void	setCurrentAsReference(boolean currentAsReference) Sets the actual document as the comparison reference for the Track Data Changes feature.
void	setReferenceDate(java.util.Calendar referenceDate) Sets the ReferenceDate attribute.
void	setShowChanges(boolean showChanges) This methods allows to show/hide changes on all reports.
void	setTrackDataViewMode(TrackDataViewMode.Enum trackDataViewMode) Sets the track data mode and activates the feature if it's not already done.
org.apache.xmlbeans.XmlBoolean	xgetActive() Internal use only
org.apache.xmlbeans.XmlBoolean	xgetCurrentAsReference() Internal use only
org.apache.xmlbeans.XmlDateTime	xgetReferenceDate() Internal use only
org.apache.xmlbeans.XmlBoolean	xgetShowChanges() Internal use only
TrackDataViewMode	xgetTrackDataViewMode() Internal use only
void	xsetActive(org.apache.xmlbeans.XmlBoolean active) Internal use only
void	xsetCurrentAsReference(org.apache.xmlbeans.XmlBoolean currentAsReference) Internal use only
void	xsetReferenceDate(org.apache.xmlbeans.XmlDateTime referenceDate) Internal use only
void	xsetShowChanges(org.apache.xmlbeans.XmlBoolean showChanges) Internal use only
void	xsetTrackDataViewMode(TrackDataViewMode trackDataViewMode) Internal use only

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getActive

boolean getActive()

Internal Use Only.

xgetActive

org.apache.xmlbeans.XmlBoolean xgetActive()

Internal use only

setActive

void setActive(boolean active)

Activates the track data if the boolean is set to true

Parameters:

active - - a boolean to activate or deactivate TrackData

xsetActive

void xsetActive(org.apache.xmlbeans.XmlBoolean active)

Internal use only

getShowChanges

boolean getShowChanges()

Internal use only

xgetShowChanges

org.apache.xmlbeans.XmlBoolean xgetShowChanges()

Internal use only

setShowChanges

void setShowChanges(boolean showChanges)

This methods allows to show/hide changes on all reports.

Parameters:

showChanges - - a boolean to show/hide changes on all reports.

xsetShowChanges

void xsetShowChanges(org.apache.xmlbeans.XmlBoolean showChanges)

Internal use only

getCurrentAsReference

boolean getCurrentAsReference()

Internal use only

xgetCurrentAsReference

org.apache.xmlbeans.XmlBoolean xgetCurrentAsReference()

Internal use only

setCurrentAsReference

void setCurrentAsReference(boolean currentAsReference)

Sets the actual document as the comparison reference for the Track Data Changes feature.

Parameters:

currentAsReference - - a boolean to set actual document as the comparison reference for the Track Data Changes feature.

xsetCurrentAsReference

void xsetCurrentAsReference(org.apache.xmlbeans.XmlBoolean currentAsReference)

Internal use only

getTrackDataViewMode

TrackDataViewMode.Enum getTrackDataViewMode()

Internal Use Only.

xgetTrackDataViewMode

TrackDataViewMode xgetTrackDataViewMode()

Internal use only

setTrackDataViewMode

void setTrackDataViewMode(TrackDataViewMode.Enum trackDataViewMode)

Sets the track data mode and activates the feature if it's not already done.

Parameters:

trackDataViewMode - - The TrackDataViewMode instance

xsetTrackDataViewMode

void xsetTrackDataViewMode(TrackDataViewMode trackDataViewMode)

Internal use only

getReferenceDate

java.util.Calendar getReferenceDate()

Internal Use Only.

xgetReferenceDate

org.apache.xmlbeans.XmlDateTime xgetReferenceDate()

Internal use only

setReferenceDate

void setReferenceDate(java.util.Calendar referenceDate)

Sets the ReferenceDate attribute.

Parameters:

referenceDate - - The reference date attribute

xsetReferenceDate

void xsetReferenceDate(org.apache.xmlbeans.XmlDateTime referenceDate)

Internal use only