Interface IMediaManager

All Superinterfaces:
IDisposable, IEntity
public interface IMediaManager extends IEntity
Manages the medias.

  • Method Details

    • createMedia

      int createMedia(MediaCreateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException
      Creates a custom media.
      Parameters:
      request - Contains the fields that must be overwritten
      Returns:
      Identifier of the created media.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • deleteMedia

      void deleteMedia(String mediaName) throws Exception, altitude.integrationServer.exceptions.ISException
      Deletes a custom media.
      Parameters:
      mediaName - Name of the media.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getInstance

      IInstance getInstance() throws Exception, altitude.integrationServer.exceptions.ISException
      Returns the instance.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getMediaById

      MediaData getMediaById(int mediaId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets information about the media.
      Parameters:
      mediaId - Identifier of the media.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getMediaByName

      MediaData getMediaByName(String mediaName) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets information about the media.
      Parameters:
      mediaName - Name of the media.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getMediaCursor

      IMediaCursor getMediaCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a media cursor open in the instance.
      Parameters:
      cursorId - Identifier of the cursor.
      Returns:
      The IMediaCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getMediaCursors

      IMediaCursor[] getMediaCursors() throws Exception, altitude.integrationServer.exceptions.ISException
      Returns the media cursors open in the instance.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • getMediaTableSchema

      TableSchema getMediaTableSchema() throws Exception, altitude.integrationServer.exceptions.ISException
      Gets the table schema of the media.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • newMediaCursor

      IMediaCursor newMediaCursor(String[] columns, String sql) throws Exception, altitude.integrationServer.exceptions.ISException, altitude.integrationServer.exceptions.ISSqlException
      Opens a media cursor.
      Parameters:
      columns - Columns to fetch.
      sql - SQL.
      Returns:
      The IMediaCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException
      altitude.integrationServer.exceptions.ISSqlException

    • tryGetMediaCursor

      IMediaCursor tryGetMediaCursor(int cursorId) throws Exception, altitude.integrationServer.exceptions.ISException
      Gets a media cursor open in the instance or null if it doesn't exist.
      Parameters:
      cursorId - Identifier of the cursor.
      Returns:
      The IMediaCursor cursor.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException

    • updateMedia

      void updateMedia(String mediaName, MediaUpdateRequest request) throws Exception, altitude.integrationServer.exceptions.ISException
      Updates a custom media.
      Parameters:
      mediaName - Name of the media.
      request - Contains the fields to be updated.
      Throws:
      Exception
      altitude.integrationServer.exceptions.ISException