Package com.adobe.granite.timeline

Interface Timeline

public interface Timeline

A Timeline provides a collection of TimelineEvents specific to a Resource. The type of events provided is dependent on the available TimelineEventProviders registered in the system. By default the following events are provided:

• Versioning Events
• Workflow Events
• Annotation Events

A Timeline can be retrieved by adapting a resource as follows: resource.adaptTo(Timeline.class). Any resource can be adapted. Whether events are provided for a resource is decided by the event providers.

Method Summary

Modifier and Type	Method	Description
List<TimelineEvent>	getEvents()	Returns a List of all TimelineEvents available for the resource backing the timeline.
List<TimelineEvent>	getEvents(TimelineEventType... types)	Returns a subset of events (as provided by getEvents()), filtered by the given types.
Resource	getResource()	Returns the Resource for which this timeline was created.

Method Details

getResource

Resource getResource()

Returns the Resource for which this timeline was created.

Returns:

The Resource.

getEvents

List<TimelineEvent> getEvents()

Returns a List of all TimelineEvents available for the resource backing the timeline. If no events are found, an empty collection is returned. The list is ordered chronologically (most recent last) as per TimelineEvent.getTime(). In order to trim the result (e.g. for pagination, use getEvents().subList(start, end).

Returns:

A List of TimelineEvents, or an empty collection if no events were found.

getEvents

List<TimelineEvent> getEvents(TimelineEventType... types)

Returns a subset of events (as provided by getEvents()), filtered by the given types. The types by which to filter are provided as an array of TimelineEventTypes. The TimelineAggregator service provides access to the available types (see TimelineAggregator.getTypes(). The list is ordered chronologically (most recent last) as per TimelineEvent.getTime(). In order to trim the result (e.g. for pagination, use getEvents(type).subList(start, end).

Parameters:

types - The array of TimelineEventTypes by which to filter events.

Returns:

A List of TimelineEvents filtered by type, or an empty list if no events or none of the given types were found.