org.intellimate.izou.sdk.frameworks.music.resources

Class MusicUsageResource

java.lang.Object

org.intellimate.izou.sdk.resource.Resource<Boolean>

org.intellimate.izou.sdk.frameworks.music.resources.MusicUsageResource

All Implemented Interfaces:

Identifiable, ResourceModel<Boolean>

public class MusicUsageResource
extends Resource<Boolean>

this resource signals that an addon requests playing.

It is mostly used for non-permanent Music-Usage which blocks the Event in the Output lifecycle.
For example if you are an alarm you can add this resource to an Event and it will play the alarm sound, blocking the execution for other outputPlugins.

Version:

1.0

Author:

LeanderK

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID

Constructor Summary

Constructors

Constructor and Description
MusicUsageResource(Identification provider, Boolean permanent) creates a new Resource.

Method Summary

Modifier and Type	Method and Description
static boolean	isPermanent(EventModel eventModel) gets whether the request is permanent (=permanent resource is available and true)
static boolean	isPermanent(ResourceModel resourceModel) returns true if the resource is true, otherwise returns false

Methods inherited from class org.intellimate.izou.sdk.resource.Resource

getConsumer, getID, getProvider, getResource, getResourceID, hasProvider, setConsumer, setProvider, setResource, toList, 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

MusicUsageResource

public MusicUsageResource(Identification provider,
                          Boolean permanent)

creates a new Resource.

Parameters:

provider - the Provider of the Resource

permanent - true if permanent, false if not

Method Detail

isPermanent

public static boolean isPermanent(EventModel eventModel)

gets whether the request is permanent (=permanent resource is available and true)

Parameters:

eventModel - the EventModel

Returns:

true if permanent

isPermanent

public static boolean isPermanent(ResourceModel resourceModel)

returns true if the resource is true, otherwise returns false

Parameters:

resourceModel - the resourceModel

Returns:

true if permanent