com.businessobjects.dsws.reportengine
Interface DrillDetail

public interface DrillDetail

The DrillDetail interface provides the properties and functionality of BusinessObjects Universe detail. A detail is defined with the designer tool.

Example: Get the drill details from the drill dimension.

 RetrieveDrillInfo boDrillInfo = RetrieveDrillInfo.Factory.newInstance();
 RetrieveData retBOData = RetrieveData.Factory.newInstance();
 retBOData.setRetrieveDrillInfo(boDrillInfo);
 Action[] actions = new Action[1];
 Drill objDrill = Drill.Factory.newInstance();
 objDrill.setActiveDrill(true);
 actions[0] = objDrill;
 DocumentInformation boDocInfo = boRepEng.getDocumentInformation( strDocid, null, actions, null, retBOData);
 DrillInfo boDocDrill = boDocInfo.getDrillInfo();
 DrillDetail[] boDrDets = boDocDrill.getFreeDrillDetailsArray();
 for(int i=0;i < boDrDets.length;i++)
 {
      DrillDetail boDrDet = boDrDets[i];
      String strDrDet = boDrDet.getName();
      out.print(strDrDet);
 }
 

See Also:

Drill, Action, DrillPath, DocumentInformation, RetrieveData

Nested Class Summary

static class

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

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

LOV	addNewLOV() Internal Use Only.
java.lang.String	getDescription() Gets a description of the DrillDetail.
java.lang.String	getFilter() Returns the member on which the current Drill is being filtered.
java.lang.String	getID() Return the DrillDetail unique ID.
LOV	getLOV() Returns a List Of Values (LOV) included in the DrillDetail.
java.lang.String	getName() Returns the DrillDetail name.
boolean	isNilDescription() Checks if the Description element is nil.
boolean	isNilLOV() Checks if the LOV element is nil.
boolean	isSetDescription() Checks if the Description element is set.
boolean	isSetFilter() Checks if the Filter attribute is set.
boolean	isSetLOV() Checks if the LOV element is set.
void	setDescription(java.lang.String description) Internal Use Only.
void	setFilter(java.lang.String filter) Internal Use Only.
void	setID(java.lang.String id) Internal Use Only.
void	setLOV(LOV lov) Internal Use Only.
void	setName(java.lang.String name) Internal Use Only.
void	setNilDescription() Internal Use Only.
void	setNilLOV() Internal Use Only.
void	unsetDescription() Internal Use Only.
void	unsetFilter() Internal Use Only.
void	unsetLOV() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetDescription() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetFilter() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetID() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetName() Internal Use Only.
void	xsetDescription(org.apache.xmlbeans.XmlString description) Internal Use Only.
void	xsetFilter(org.apache.xmlbeans.XmlString filter) Internal Use Only.
void	xsetID(org.apache.xmlbeans.XmlString id) Internal Use Only.
void	xsetName(org.apache.xmlbeans.XmlString name) Internal Use Only.

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getLOV

LOV getLOV()

Returns a List Of Values (LOV) included in the DrillDetail.

Returns:

A List Of Values.

See Also:

LOV

isNilLOV

boolean isNilLOV()

Checks if the LOV element is nil.

Returns:

true if the LOV element is nil, otherwise false

isSetLOV

boolean isSetLOV()

Checks if the LOV element is set.

Returns:

true if the LOV element is set, otherwise false

setLOV

void setLOV(LOV lov)

Internal Use Only.

addNewLOV

LOV addNewLOV()

Internal Use Only.

setNilLOV

void setNilLOV()

Internal Use Only.

unsetLOV

void unsetLOV()

Internal Use Only.

getDescription

java.lang.String getDescription()

Gets a description of the DrillDetail.

Returns:

A string containing a description.

xgetDescription

org.apache.xmlbeans.XmlString xgetDescription()

Internal Use Only.

isNilDescription

boolean isNilDescription()

Checks if the Description element is nil.

Returns:

true if the description element is nil, otherwise false.

isSetDescription

boolean isSetDescription()

Checks if the Description element is set.

Returns:

true if the description element is set, otherwise false.

setDescription

void setDescription(java.lang.String description)

Internal Use Only.

xsetDescription

void xsetDescription(org.apache.xmlbeans.XmlString description)

Internal Use Only.

setNilDescription

void setNilDescription()

Internal Use Only.

unsetDescription

void unsetDescription()

Internal Use Only.

getName

java.lang.String getName()

Returns the DrillDetail name.

Returns:

A string containing the name of the DrillDetail.

xgetName

org.apache.xmlbeans.XmlString xgetName()

Internal Use Only.

setName

void setName(java.lang.String name)

Internal Use Only.

xsetName

void xsetName(org.apache.xmlbeans.XmlString name)

Internal Use Only.

getID

java.lang.String getID()

Return the DrillDetail unique ID.

Returns:

A string containing the DrillDetail unique ID.

xgetID

org.apache.xmlbeans.XmlString xgetID()

Internal Use Only.

setID

void setID(java.lang.String id)

Internal Use Only.

xsetID

void xsetID(org.apache.xmlbeans.XmlString id)

Internal Use Only.

getFilter

java.lang.String getFilter()

Returns the member on which the current Drill is being filtered.

When you analyze report result in Drill mode, filters can be applied as you drill on selected values. For example, if you drill on the value 'January' on a table cell to view more detailed results for each week, the values displayed should correspond to the weeks in January.

Returns:

The member on which the current Drill is being filtered.

xgetFilter

org.apache.xmlbeans.XmlString xgetFilter()

Internal Use Only.

isSetFilter

boolean isSetFilter()

Checks if the Filter attribute is set.

Returns:

true if the filter element is set, otherwise false

setFilter

void setFilter(java.lang.String filter)

Internal Use Only.

xsetFilter

void xsetFilter(org.apache.xmlbeans.XmlString filter)

Internal Use Only.

unsetFilter

void unsetFilter()

Internal Use Only.