org.jrebirth.af.api.service

Interface Service

All Superinterfaces:

BehavioredComponent<Service>, CommandReady, Component<Service>, FacadeReady<Service>, ModelReady, ServiceReady

public interface Service
extends BehavioredComponent<Service>

The interface Service. The contract for the service layer.

Author:

Sébastien Bordes

Property Summary

Type	Property and Description
ObservableMap<String,ServiceTask<?>>	pendingTasks Return The Pending tasks map.

Method Summary

Modifier and Type	Method and Description
ServiceTask<?>	getPendingTask(String taskKey) Retrieve a task from the pending list.
Collection<ServiceTask<?>>	getPendingTaskList() Get pending task list.
ObservableMap<String,ServiceTask<?>>	pendingTasksProperty() Return The Pending tasks map.
void	removePendingTask(String taskKey) Remove a task from the pending list.
<T> ServiceTask<T>	returnData(Wave wave) Do a specific action by processing the wave.

Methods inherited from interface org.jrebirth.af.api.component.behavior.BehavioredComponent

addBehavior, addBehavior, getBehavior, getBehaviorData, hasBehavior

Methods inherited from interface org.jrebirth.af.api.component.basic.Component

addInnerComponent, getInnerComponent, getRootComponent, listen, listen, listen, sendWave, sendWave, sendWave, setRootComponent, unlisten

Methods inherited from interface org.jrebirth.af.api.facade.FacadeReady

getKey, getLocalFacade, release, setKey, setLocalFacade, setup

Methods inherited from interface org.jrebirth.af.api.link.ModelReady

attachUi, getModel, getModel

Methods inherited from interface org.jrebirth.af.api.link.ServiceReady

getService, getService, returnData

Methods inherited from interface org.jrebirth.af.api.link.CommandReady

callCommand, callCommand, getCommand, getCommand

Property Detail

pendingTasks

ObservableMap<String,ServiceTask<?>> pendingTasksProperty

Return The Pending tasks map.
Key is the wave UID, value is the ServiceTask

Method Detail

returnData

<T> ServiceTask<T> returnData(Wave wave)

Do a specific action by processing the wave.

Type Parameters:

T - The type of the object to return must be compatible with the WaveType contract that call this service

Parameters:

wave - the wave that hold all related data

Returns:

the service task created that will perform the job

pendingTasksProperty

ObservableMap<String,ServiceTask<?>> pendingTasksProperty()

Return The Pending tasks map.
Key is the wave UID, value is the ServiceTask

getPendingTaskList

Collection<ServiceTask<?>> getPendingTaskList()

Get pending task list.

Returns:

the list of pending tasks

removePendingTask

void removePendingTask(String taskKey)

Remove a task from the pending list.

Parameters:

taskKey - the key of the task, commonly the WaveUID

getPendingTask

ServiceTask<?> getPendingTask(String taskKey)

Retrieve a task from the pending list.

Parameters:

taskKey - the key of the task, commonly the WaveUID

Returns:

the pending task for the given key (basically the Wave UID)