com.microsoft.bingads.v13.internal.bulk.BulkObject Maven / Gradle / Ivy

Go to download
package com.microsoft.bingads.v13.internal.bulk;

import java.io.IOException;

import com.microsoft.bingads.v13.internal.bulk.entities.MultiRecordBulkEntity;

/**
 * A representation of a block of data (set of csv lines) provided in the
 *
 * Bulk
 * File Schema.
 *
 */
public abstract class BulkObject {

    /**
     * Reads object data from consecutive rows.
     * 
     * SingleLineBulkEntity: reads entity errors.
     * MultilineBulkEntity: reads child entities.
     * 
     *
     * @param reader
     */
    public void readRelatedData(BulkRecordReader reader) {
    }

    /**
     * Read object data from a single row.
     *
     * 
     * SingleLineBulkEntity: reads entity fields.
     * BulkError: reads error fields.
     * BulkEntityIdentifier: reads identifier fields (Id, status etc.).
     * 
     *
     * @param values
     */
    public void readFromRowValues(RowValues values) {
        throw new UnsupportedOperationException();
    }

    /**
     * Writes object data to a single row.
     *
     * 
     * SingleLineBulkEntity: writes entity fields.
     * BulkEntityIdentifier: writes identifier fields (Id, status etc.)
     * 
     *
     * @param values
     */
    public void writeToRowValues(RowValues values, boolean excludeReadonlyData) {
        throw new UnsupportedOperationException();
    }

    /**
     * Writes object data to consecutive rows.
     *
     * 
     * SingleLineBulkEntity: writes entity.
     * MultilineBulkEntity: writes child entities.
     * BulkEntityIdentifier: writes identifier information (Id, status
     * etc.)
     * 
     *
     * @param rowWriter
     * @throws IOException
     */
    public void write(BulkObjectWriter rowWriter, boolean excludeReadonlyData) throws IOException {
        throw new UnsupportedOperationException();
    }

    public boolean canEncloseInMultilineEntity() {
        return false;
    }

    public MultiRecordBulkEntity encloseInMultilineEntity() {
        throw new UnsupportedOperationException();
    }
;
}