Interface IRVObjectEncoder


  • public interface IRVObjectEncoder
    Allows the encoding of information in DataSource or DataSourceItems, before returning those objects to the client. DataSource and DataSourceItems information is typically sent from the server to the client when editing a dashboard. Decoding should be done using an IRVDataSourceProvider implementation. Only supported for Database providers.
    • Method Detail

      • encode

        RVDashboardDataSource encode​(IRVUserContext userContext,
                                     RVDashboardDataSource dataSource)
        Used to encode the information of a Datasource returned to the client. Only supported for Database providers.
        Parameters:
        userContext - User context
        dataSource - Information about the data source being used, like the host name for a database, etc.
        Returns:
        The new data source to use or null to use the original data source
      • encode

        RVDataSourceItem encode​(IRVUserContext userContext,
                                RVDataSourceItem dataSourceItem)
        Used to encode the information of a DatasourceItem returned to the client. Only supported for Database providers.
        Parameters:
        userContext - User context
        dataSourceItem - Information about the data source item being used, like the name of the table, database, etc.
        Returns:
        The new data source item to use or null to use the original data source item