com.activitystream.model.interfaces.BaseStreamItem Maven / Gradle / Ivy

Go to download
package com.activitystream.model.interfaces;

import com.activitystream.model.analytics.TimeSeriesEntry;
import com.activitystream.model.security.ProcessSettings;
import org.joda.time.DateTime;

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

public interface BaseStreamItem extends BaseStreamElement, EnrichableElement {

    /************ Stream Item Services ************/

    void setMessageKey(String messageKey);

    String getMessageKey();

    ProcessSettings getProcessSettings();

    String getPartition();

    UUID getStreamId();

    String getFootprint();

    String getElementType();

    DateTime getOccurredAt();

    DateTime getReceivedAt();

    default BaseStreamItem getParentStreamItem() {
        BaseStreamElement element = getRoot();
        while (element != null && element != this) {
            if (element instanceof BaseStreamItem)
                return (BaseStreamItem) element;
            if (element.getRoot() == element)
                break;
            element = element.getRoot();
        }
        return null;
    }

    boolean isUnSavable();

    void setUnSavable(boolean unSavable);

    boolean isRedundant();

    void setRedundant(boolean redundant);

    void prepareForFederation();

    /**
     * Retrieves an initialized list of time series entries created for this element
     */
    List getAllTimeSeriesEntries();

    default void addAllTimeSeriesEntries(List entries, boolean checkNested) {
        entries.addAll(getAllTimeSeriesEntries());
    }
}