Package com.appliedolap.essbase

Interface EssUtility

All Superinterfaces:
EssObject
All Known Implementing Classes:
EssUtilityImpl
public interface EssUtility extends EssObject

  • Nested Class Summary

    Nested classes/interfaces inherited from interface com.appliedolap.essbase.EssObject

    EssObject.Type

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    download()
     
    String
    getName()
    Gets the name of this object.
    EssObject.Type
    getType()
    Gets the type of this object.
    boolean
    isDownloadable()
    Checks if the utility is downloadable, as opposed to being a direct link.

  • Method Details

    • getName

      String getName()
      Description copied from interface: EssObject
      Gets the name of this object. This will generally be the "nice" and "unique" name of this object, such as the application name, cube, member, variable, or whatever.
      Specified by:
      getName in interface EssObject
      Returns:
      the simple name of this object

    • getType

      EssObject.Type getType()
      Description copied from interface: EssObject
      Gets the type of this object.
      Specified by:
      getType in interface EssObject
      Returns:
      the object type

    • isDownloadable

      boolean isDownloadable()
      Checks if the utility is downloadable, as opposed to being a direct link. In reviewing the current response format, the list of utilities includes, for example, a link to the index.html page in the url variable when it's a link to a web page (and no links item), and in the case of an actually downloadable utility, the links item will exist and may look like the following: 
       "links": [
   {
     "rel": "download",
     "href": "https://129.159.71.17:443/essbase/rest/v1/utilities/cli",
     "method": "get",
     "type": "application/zip"
   }
      Returns:
      true if the resource is a downloadable file, false if not (such as in the case of a generic link)

    • download

      void download()