# TimelineRecord.java

    /*
     * Copyright (c) 2010-2012, Paul Merlin.
     * Copyright (c) 2012, Niclas Hedhman.
     *
     * Licensed  under the  Apache License,  Version 2.0  (the "License");
     * you may not use  this file  except in  compliance with the License.
     * You may obtain a copy of the License at
     *
     *   http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed  under the  License is distributed on an "AS IS" BASIS,
     * WITHOUT  WARRANTIES OR CONDITIONS  OF ANY KIND, either  express  or
     * implied.
     *
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */
    package org.qi4j.library.scheduler.timeline;

    import java.util.List;
    import org.qi4j.api.common.UseDefaults;
    import org.qi4j.api.entity.Queryable;
    import org.qi4j.api.mixin.Mixins;
    import org.qi4j.api.property.Property;
    import org.qi4j.api.value.ValueComposite;
    import org.qi4j.library.scheduler.Scheduler;

    /**
     * Record in {@link Scheduler}'s {@link Timeline}.
     *
     * {@link TimelineRecord}s are {@link Comparable} regarding their {@link TimelineRecord#timestamp()}.
     */
    @Mixins( TimelineRecord.Mixin.class )
    public interface TimelineRecord
        extends Comparable<TimelineRecord>, ValueComposite
    {
        /**
         * @return Identity of the associated {@link Scheduler}
         */
        Property<String> scheduleIdentity();

        /**
         * @return Timestamp of this record
         */
        Property<Long> timestamp();

        /**
         * @return Name of the associated {@link org.qi4j.library.scheduler.Task}
         */
        Property<String> taskName();

        /**
         * @return Tags of the associated {@link org.qi4j.library.scheduler.Task}
         */
        @UseDefaults
        Property<List<String>> taskTags();

        Property<TimelineRecordStep> step();

        /**
         * @return Details text of this record
         */
        @Queryable( false )
        @UseDefaults
        Property<String> details();

        abstract class Mixin
            implements TimelineRecord
        {

            @Override
            public int compareTo( TimelineRecord o )
            {
                return timestamp().get().compareTo( o.timestamp().get() );
            }
        }

    }