org.intellimate.izou.events

Interface EventModel<X extends EventModel>

All Superinterfaces:

Identifiable

All Known Implementing Classes:

EventMinimalImpl

public interface EventModel<X extends EventModel>
extends Identifiable

This class represents an Event, the main communication form for the AddOns.

Version:

1.0

Author:

Leander Kurscheidt

Method Summary

Modifier and Type	Method and Description
X	addResource(ResourceModel resource) adds a resource to the container
X	addResources(List<ResourceModel> resources) adds a list of resources to the container
boolean	containsDescriptor(String descriptor) returns whether the event contains the specific descriptor.
List<String>	getAllInformations() returns a List containing all the Descriptors and the type.
List<String>	getDescriptors() returns a list containing all the descriptors.
EventBehaviourControllerModel	getEventBehaviourController() returns the associated EventBehaviourController
ListResourceProvider	getListResourceContainer() Returns all the resources the event currently has
Identification	getSource() Returns the source of the event, e.g.
String	getType() The type of the Event.
void	lifecycleCallback(EventLifeCycle eventLifeCycle) this method gets called when the different lifecycle-stages got reached.

Methods inherited from interface org.intellimate.izou.identification.Identifiable

getID, isOwner

Method Detail

getType

String getType()

The type of the Event. It describes the Type of the Event.

Returns:

A String containing an ID

getSource

Identification getSource()

Returns the source of the event, e.g. the object who fired it.

Returns:

an identifiable

getListResourceContainer

ListResourceProvider getListResourceContainer()

Returns all the resources the event currently has

Returns:

an instance of ListResourceContainer

addResource

X addResource(ResourceModel resource)

adds a resource to the container

Parameters:

resource - an instance of the resource to add

Returns:

the resulting Event (which is the same instance)

addResources

X addResources(List<ResourceModel> resources)

adds a list of resources to the container

Parameters:

resources - a list containing all the resources

Returns:

the resulting Event (which is the same instance)

getDescriptors

List<String> getDescriptors()

returns a list containing all the descriptors.

Returns:

a list containing the descriptors

getAllInformations

List<String> getAllInformations()

returns a List containing all the Descriptors and the type.

Returns:

a List containing the Descriptors

containsDescriptor

boolean containsDescriptor(String descriptor)

returns whether the event contains the specific descriptor. this method also checks whether it matches the type.

Parameters:

descriptor - a string with the ID of the descriptor

Returns:

boolean when the event contains the descriptor, false when not.

getEventBehaviourController

EventBehaviourControllerModel getEventBehaviourController()

returns the associated EventBehaviourController

Returns:

an instance of EventBehaviourController

lifecycleCallback

void lifecycleCallback(EventLifeCycle eventLifeCycle)

this method gets called when the different lifecycle-stages got reached. It is not blocking!

Parameters:

eventLifeCycle - the lifecycle reached.