org.intellimate.izou.sdk.frameworks.music.events

Class StartMusicRequest

java.lang.Object

org.intellimate.izou.sdk.events.Event

org.intellimate.izou.sdk.frameworks.music.events.StartMusicRequest

All Implemented Interfaces:

EventModel<Event>, Identifiable

public class StartMusicRequest
extends Event

this events request the start of the music-playing

Version:

1.0

Author:

LeanderK

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StartMusicRequest(Identification source, boolean isUsingJava) Creates a new Event Object

Method Summary

Modifier and Type	Method and Description
static Optional<StartMusicRequest>	createStartMusicRequest(Identification source, Identification target) creates a new StartRequest
static Optional<StartMusicRequest>	createStartMusicRequest(Identification source, Identification target, Playlist playlist) creates a new StartRequest
static Optional<StartMusicRequest>	createStartMusicRequest(Identification source, Identification target, Playlist playlist, boolean isUsingJava) creates a new StartRequest
static Optional<StartMusicRequest>	createStartMusicRequest(Identification source, Identification target, TrackInfo trackInfo) creates a new StartRequest
static Optional<StartMusicRequest>	createStartMusicRequest(Identification source, Identification target, TrackInfo trackInfo, boolean isUsingJava) creates a new StartRequest
static boolean	verify(EventModel eventModel, Capabilities capabilities, Identifiable player, List<Identifiable> activators) verifies that the StartMusicRequest is correct and checks whether the you are meant to react to it

Methods inherited from class org.intellimate.izou.sdk.events.Event

addDescriptor, addEventLifeCycleListener, addResource, addResources, containsDescriptor, createEvent, createEvent, getAllInformations, getDescriptors, getEventBehaviourController, getID, getListResourceContainer, getSource, getType, lifecycleCallback, replaceDescriptors, setDescriptors, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

isOwner

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

StartMusicRequest

protected StartMusicRequest(Identification source,
                            boolean isUsingJava)
                     throws IllegalArgumentException

Creates a new Event Object

Parameters:

source - the source of the Event, most likely a this reference.

isUsingJava - true if the player is using java

Throws:

IllegalArgumentException - if one of the Arguments is null or empty

Method Detail

createStartMusicRequest

public static Optional<StartMusicRequest> createStartMusicRequest(Identification source,
                                                                  Identification target)

creates a new StartRequest

Parameters:

source - the caller

target - the target who should start playing

Returns:

the optional StartMusicRequest

createStartMusicRequest

public static Optional<StartMusicRequest> createStartMusicRequest(Identification source,
                                                                  Identification target,
                                                                  TrackInfo trackInfo)

creates a new StartRequest

Parameters:

source - the caller

target - the target who should start playing

trackInfo - the track to play

Returns:

the optional StartMusicRequest

createStartMusicRequest

public static Optional<StartMusicRequest> createStartMusicRequest(Identification source,
                                                                  Identification target,
                                                                  TrackInfo trackInfo,
                                                                  boolean isUsingJava)

creates a new StartRequest

Parameters:

source - the caller

target - the target who should start playing

trackInfo - the track to play

isUsingJava - true if the player is using java

Returns:

the optional StartMusicRequest

createStartMusicRequest

public static Optional<StartMusicRequest> createStartMusicRequest(Identification source,
                                                                  Identification target,
                                                                  Playlist playlist)

creates a new StartRequest

Parameters:

source - the caller

target - the target who should start playing

playlist - the playlist to play

Returns:

the optional StartMusicRequest

createStartMusicRequest

public static Optional<StartMusicRequest> createStartMusicRequest(Identification source,
                                                                  Identification target,
                                                                  Playlist playlist,
                                                                  boolean isUsingJava)

creates a new StartRequest

Parameters:

source - the caller

target - the target who should start playing

playlist - the playlist to play

isUsingJava - true if the player is using java

Returns:

the optional StartMusicRequest

verify

public static boolean verify(EventModel eventModel,
                             Capabilities capabilities,
                             Identifiable player,
                             List<Identifiable> activators)

verifies that the StartMusicRequest is correct and checks whether the you are meant to react to it

Parameters:

eventModel - the EventModel to check against

player - the identifiable

capabilities - the capabilities

activators - the activators which are able to start the player if it is not able to start from outside commands

Returns:

true if verified, false if not