org.intellimate.izou.sdk.frameworks.presence.provider.template

Class PresenceConstant

java.lang.Object

org.intellimate.izou.sdk.util.AddOnModule

org.intellimate.izou.sdk.events.EventsController

org.intellimate.izou.sdk.frameworks.presence.provider.template.PresenceConstant

All Implemented Interfaces:

EventListenerModel, EventsControllerModel, Identifiable, ResourceBuilderModel, ResourcesProviderBase, PresenceHelper, PresenceProvider, PresenceResourceProvider, PresenceResourceHelper, ContextProvider, FireEvent, Loggable, LoggedExceptionCallback, ResourceUser, ExceptionCallback

public abstract class PresenceConstant
extends EventsController
implements PresenceHelper, PresenceResourceProvider

the base template class for addons able to conclude about constant presence.

If the addon is based on encounters with the user and not able to conclude constant presence from the information, it should pass not extend this class, if not (for example if it monitors wifi) it can. They can just fire the Presence-Event on encountering. It is expected that addons extending this class are pretty sure that the user is around and not a random person.

Version:

1.0

Author:

LeanderK

Field Summary

Fields inherited from interface org.intellimate.izou.sdk.util.Loggable

FQCN

Constructor Summary

Constructors

Constructor and Description
PresenceConstant(Context context, String ID, boolean strict, PresenceIndicatorLevel level)

Method Summary

Modifier and Type	Method and Description
boolean	controlEvents(EventModel eventModel) Controls whether the fired Event should be dispatched to all the listeners.
PresenceIndicatorLevel	getLevel() gets the PresenceIndicatorLevel of the addon (mainly used for communication between presence-providing addons)
boolean	isFirstEncountering() returns true if the user is first encountered in the current mode
boolean	isKnown() whether it is known that the user caused the presence
boolean	isPresent() returns true if the user might be/is present
boolean	isStrict() true if the addon can guarantee that the user is around, false if not
void	setGlobalPresent(boolean present) when this method is called the present-status was changed
void	setGlobalStrictPresent(boolean present) when this method is called, the strict-present status was changed
void	setPresence(boolean present) sets the presence

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

controlEventDispatcher

Methods inherited from class org.intellimate.izou.sdk.util.AddOnModule

getContext, getID

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.intellimate.izou.sdk.frameworks.presence.provider.PresenceHelper

fireLeaving, firePresence, firePresence

Methods inherited from interface org.intellimate.izou.sdk.util.FireEvent

fire, fire, fire, fire, fire

Methods inherited from interface org.intellimate.izou.sdk.frameworks.presence.provider.PresenceResourceProvider

announceResources, createPresenceResource, generateResource

Methods inherited from interface org.intellimate.izou.sdk.frameworks.common.resources.ResourcesProviderBase

announceEvents, provideResource, resourcesInit

Methods inherited from interface org.intellimate.izou.sdk.frameworks.presence.provider.PresenceProvider

eventFired

Methods inherited from interface org.intellimate.izou.sdk.frameworks.presence.resources.PresenceResourceHelper

getIsPresent, nonStrictAvailable

Methods inherited from interface org.intellimate.izou.sdk.util.Loggable

debug, debug, error, error, fatal, fatal, warn, warn

Methods inherited from interface org.intellimate.izou.sdk.util.LoggedExceptionCallback

exceptionThrown

Constructor Detail

PresenceConstant

public PresenceConstant(Context context,
                        String ID,
                        boolean strict,
                        PresenceIndicatorLevel level)

Parameters:

context - the context

ID - the ID

strict - whether it is strict (very high probability that the user is around)

level - the level

Method Detail

controlEvents

public boolean controlEvents(EventModel eventModel)

Controls whether the fired Event should be dispatched to all the listeners. This method should execute quickly

Specified by:

controlEvents in class EventsController

Parameters:

eventModel - the Event

Returns:

true if it should dispatch, false if not

isStrict

public boolean isStrict()

true if the addon can guarantee that the user is around, false if not

Specified by:

isStrict in interface PresenceProvider

Returns:

true if it can guarantee it, false if not

isKnown

public boolean isKnown()

whether it is known that the user caused the presence

Specified by:

isKnown in interface PresenceProvider

Returns:

true if known, false if not

getLevel

public PresenceIndicatorLevel getLevel()

gets the PresenceIndicatorLevel of the addon (mainly used for communication between presence-providing addons)

Specified by:

getLevel in interface PresenceProvider

Returns:

the Level

isPresent

public boolean isPresent()

returns true if the user might be/is present

Specified by:

isPresent in interface PresenceProvider

Returns:

true if present

setGlobalPresent

public void setGlobalPresent(boolean present)

when this method is called the present-status was changed

Specified by:

setGlobalPresent in interface PresenceProvider

Parameters:

present - true if present, false if not

isFirstEncountering

public boolean isFirstEncountering()

returns true if the user is first encountered in the current mode

Specified by:

isFirstEncountering in interface PresenceProvider

setGlobalStrictPresent

public void setGlobalStrictPresent(boolean present)

when this method is called, the strict-present status was changed

Specified by:

setGlobalStrictPresent in interface PresenceProvider

Parameters:

present - true if present, false if not

setPresence

public void setPresence(boolean present)

sets the presence

Parameters:

present - true for presence, false if not