Package org.pentaho.platform.api.engine

Interface IActionSequenceResource

public interface IActionSequenceResource
The ActionResource interface represents one resource in an ActionSequence. Resources are elements in a solution that exist outside of the action sequence document, such as images, icons, additional definition documents, etc.

  • Field Details

    • SOLUTION_FILE_RESOURCE

      static final int SOLUTION_FILE_RESOURCE
      The Resource is a solution file
      See Also:

    • URL_RESOURCE

      static final int URL_RESOURCE
      The resource is a URL
      See Also:

    • FILE_RESOURCE

      static final int FILE_RESOURCE
      The resource is an arbitrary file
      See Also:

    • UNKNOWN_RESOURCE

      static final int UNKNOWN_RESOURCE
      The resource type is unknown
      See Also:

    • STRING

      static final int STRING
      The resource type is an embedded string
      See Also:

    • XML

      static final int XML
      The resource type is embedded xml
      See Also:

  • Method Details

    • getName

      String getName()
      Return the xml node name of the resource
      Returns:
      name of the resource

    • getMimeType

      String getMimeType()
      Returns the mime type of the resource. Since resources are external, they can take on many different formats ie., text/xml, image/jpg, etc.
      Returns:
      the mime type of the resource

    • getSourceType

      int getSourceType()
      Get the type of external resource that this ActionResource is derived from.

      Valid source types are SOLUTION_FILE_RESOURCE, URL_RESOURCE, FILE_RESOURCE and UNKNOWN_RESOURCE

      Returns:
      the resource source type

    • getAddress

      String getAddress()
      Depending on the resource source type, returns the address to the resource as a path or a URL.
      Returns:
      address of resource

    • getInputStream

      InputStream getInputStream(RepositoryFilePermission actionOperation, Locale locale)

    • getInputStream

      InputStream getInputStream(RepositoryFilePermission actionOperation)