com.businessobjects.dsws.reportengine
Class DrillDetail

java.lang.Object
  com.businessobjects.dsws.reportengine.DrillDetail

All Implemented Interfaces:

java.io.Serializable

public class DrillDetail

extends java.lang.Object

implements java.io.Serializable

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

Example: Get the drill details from the drill dimension.

 RetrieveDrillInfo boDrillInfo = new RetrieveDrillInfo();
 RetrieveData retBOData = new RetrieveData();
 retBOData.setRetrieveDrillInfo(boDrillInfo);
 // Switch to drill mode if document is not already in drill mode.

 Action[] actions = new Action[1];
 Drill objDrill = new Drill();
 objDrill.setActiveDrill(true);
 actions[0] = objDrill;
 DocumentInformation boDocInfo = RepEng.getDocumentInformation( docid, null, actions, null, retBOData);
 DrillInfo boDocDrill = boDocInfo.getDrillInfo();
 DrillDetail[] boDrDets = boDocDrill.getFreeDrillDetails();
 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, Serialized Form

Constructor Summary

DrillDetail()
Instantiate a new blank DrillDetail object.

Method Summary

boolean	equals(java.lang.Object obj) Internal Use Only.
java.lang.String	getDescription() Get a description of the DrillDetail.
static org.apache.axis.encoding.Deserializer	getDeserializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
java.lang.String	getFilter() Return 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() Return the DrillDetail name.
static org.apache.axis.encoding.Serializer	getSerializer(java.lang.String mechType, java.lang.Class _javaType, javax.xml.namespace.QName _xmlType) Internal Use Only.
static org.apache.axis.description.TypeDesc	getTypeDesc() Internal Use Only.
int	hashCode() Internal Use Only.
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.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DrillDetail

public DrillDetail()

Instantiate a new blank DrillDetail object.

Method Detail

getLOV

public LOV getLOV()

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

Returns:

A List Of Values.

See Also:

LOV

setLOV

public void setLOV(LOV LOV)

Internal Use Only.

getDescription

public java.lang.String getDescription()

Get a description of the DrillDetail.

Returns:

A string containing a description.

setDescription

public void setDescription(java.lang.String description)

Internal Use Only.

getName

public java.lang.String getName()

Return the DrillDetail name.

Returns:

A string containing the name of the DrillDetail.

setName

public void setName(java.lang.String name)

Internal Use Only.

getID

public java.lang.String getID()

Return the DrillDetail unique ID.

Returns:

A string containing the DrillDetail unique ID.

setID

public void setID(java.lang.String ID)

Internal Use Only.

getFilter

public java.lang.String getFilter()

Return 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.

setFilter

public void setFilter(java.lang.String filter)

Internal Use Only.

equals

public boolean equals(java.lang.Object obj)

Internal Use Only.

hashCode

public int hashCode()

Internal Use Only.

getTypeDesc

public static org.apache.axis.description.TypeDesc getTypeDesc()

Internal Use Only.

getSerializer

public static org.apache.axis.encoding.Serializer getSerializer(java.lang.String mechType,
                                                                java.lang.Class _javaType,
                                                                javax.xml.namespace.QName _xmlType)

Internal Use Only.

getDeserializer

public static org.apache.axis.encoding.Deserializer getDeserializer(java.lang.String mechType,
                                                                    java.lang.Class _javaType,
                                                                    javax.xml.namespace.QName _xmlType)

Internal Use Only.