com.taboola.backstage.internal.BackstageInternalTools Maven / Gradle / Ivy

package com.taboola.backstage.internal;

import com.taboola.backstage.internal.factories.BackstageEndpointsFactory;
import com.taboola.backstage.model.Report;
import com.taboola.backstage.model.dynamic.DynamicRow;

/**
 * 
 *   Backstage internal tools
 * 
 * @author vladi
 * @since 1.0.2
 */
public interface BackstageInternalTools {

    /**
     * 
     *   Backstage endpoints factory, creates interface implementations
     * 
     * @return {@link BackstageEndpointsFactory}
     */
    BackstageEndpointsFactory endpointFactory();

    /**
     * 
     *   Backstage {@link Report} helper function. Goes over dynamic fields in the given report object
     *   and attach to each dynamic field its metadata.
     *   Side effect: supplied object is changed by reference
     * 
     * @param report {@link Report}
     * @param  represents dynamic row model
     */
     void attachDynamicFieldMetadataToFields(Report report);
}