Skip navigation links


com.essbase.api.dataquery
Interface IEssURLDrillThrough


public interface IEssURLDrillThrough

Interface representing URL Drill through.

Author:
Amit Doshi

Method Summary
 void delete()
          Deletes this drill through URL.
 short getCountOfDrillRegions()
          Get the Count of Drill Regions.
 java.lang.String[] getDrillRegions()
          Get the list of drill regions.
 java.lang.String getURLLink()
          Get the URL Link.
 java.lang.String getURLName()
          Gets the URL Name
 boolean isLevel0()
          Gets if level0 flag is enabled.
 void setDrillRegions(java.lang.String[] dillRegions)
          Sets the drill regions.
 void setLevel0(boolean isLevel0)
          Set the Level0 flag.
 void setURLLink(java.lang.String URLLink)
          Sets the URL Link.
 void update(boolean isMerge)
          Updates this drill through URL.

 

Method Detail

getURLName

java.lang.String getURLName()
                            throws com.essbase.api.base.EssException
Gets the URL Name
Returns:
URL Name
Throws:
com.essbase.api.base.EssException - If an error occurs.

isLevel0

boolean isLevel0()
                 throws com.essbase.api.base.EssException
Gets if level0 flag is enabled.
Returns:
true if level0 flag is enabled
Throws:
com.essbase.api.base.EssException - If an error occurs.

setLevel0

void setLevel0(boolean isLevel0)
               throws com.essbase.api.base.EssException
Set the Level0 flag.
Parameters:
isLevel0 -
Throws:
com.essbase.api.base.EssException - If an error occurs.

getURLLink

java.lang.String getURLLink()
                            throws com.essbase.api.base.EssException
Get the URL Link.
Returns:
the URL XML
Throws:
com.essbase.api.base.EssException - If an error occurs.

setURLLink

void setURLLink(java.lang.String URLLink)
                throws com.essbase.api.base.EssException
Sets the URL Link.
Parameters:
URLLink -
Throws:
com.essbase.api.base.EssException - If an error occurs.

getCountOfDrillRegions

short getCountOfDrillRegions()
                             throws com.essbase.api.base.EssException
Get the Count of Drill Regions.
Returns:
the count of drill regions
Throws:
com.essbase.api.base.EssException - If an error occurs.

getDrillRegions

java.lang.String[] getDrillRegions()
                                   throws com.essbase.api.base.EssException
Get the list of drill regions.
Returns:
lists of drill regions as a String array
Throws:
com.essbase.api.base.EssException - If an error occurs.

setDrillRegions

void setDrillRegions(java.lang.String[] dillRegions)
                     throws com.essbase.api.base.EssException
Sets the drill regions.
Parameters:
dillRegions -
Throws:
com.essbase.api.base.EssException - If an error occurs.

update

void update(boolean isMerge)
            throws com.essbase.api.base.EssException
Updates this drill through URL.
Parameters:
isMerge - - True if you want to merge regions definition
Throws:
com.essbase.api.base.EssException - If an error occurs.

delete

void delete()
            throws com.essbase.api.base.EssException
Deletes this drill through URL.
Throws:
com.essbase.api.base.EssException - If an error occurs.

Skip navigation links