org.yamcs.timeline.ItemProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of yamcs-core Show documentation
There is a newer version: 5.10.9
package org.yamcs.timeline;

import java.util.List;
import java.util.UUID;

import org.yamcs.filetransfer.InvalidRequestException;
import org.yamcs.http.BadRequestException;
import org.yamcs.protobuf.ItemFilter;
import org.yamcs.protobuf.LogEntry;
import org.yamcs.protobuf.TimelineItemLog;
import org.yamcs.protobuf.TimelineSourceCapabilities;

public interface ItemProvider {

    public TimelineItem getItem(String id);

    public void getItems(int limit, String next, RetrievalFilter filter, ItemReceiver consumer);

    /**
     * Add an item and return the added item.
     * 
     * The returned value should have defaults (if any) filled in, also if the item has a relative time, the start time
     * of the returned value will be computed from the relative time and the start of
     * {@link TimelineItem#relativeItemUuid}
     */
    public TimelineItem addItem(TimelineItem item);

    /**
     * Update an item and return the updated item.
     * 

     * The item parameter should have the uuid set and at least the start time or relative time
     * 
     * @return the updated item
     * @throws InvalidRequestException
     *             if the item does not exist, if the groupUuuid or relatimeTimeUuid properties create a circular
     *             dependency or other source specific error conditions
     */
    public TimelineItem updateItem(TimelineItem item);

    /**
     * Delete the item with the given uuid and return the deleted item.
     * 
     * If the item does not exist, return null
     */
    public TimelineItem deleteItem(UUID id);

    public TimelineItem deleteTimelineGroup(UUID id);

    public TimelineSourceCapabilities getCapabilities();

    /**
     * Checks that the source can filter based on the criteria specified
     */
    public void validateFilters(List filters) throws BadRequestException;

    /**
     * Returns the item log or null if the item does not exist
     */
    default TimelineItemLog getItemLog(String id) {
        return TimelineItemLog.newBuilder().setId(id).build();
    }

    /**
     * Adds an entry to the log table
     */
    default LogEntry addItemLog(String id, LogEntry entry) {
        throw new UnsupportedOperationException();
    }
}