org.cyclos.services.access

Interface InitializationService

All Superinterfaces:

Service

public interface InitializationService
extends Service

Used to retrieve data used by Cyclos client application

Author:

luis

Method Summary

Modifier and Type	Method and Description
BasicInitializationData	getBasicInitializationData() Returns basic data to bootstrap the client application
BasicInitializationWithContentData	getBasicInitializationWithContentData() Returns basic data to bootstrap the client application, together with some additional content
HomeData	getHomeData() Returns data for the home page
InitializationData	getInitializationData() Returns all data which is used when the application is loaded
MobileGuestInitializationData	getMobileGuestInitializationData(MobileGuestDTO guestVersionData) Returns all data which is used after the mobile application connect to a Cyclos but before the user log in.
BaseMobileUserInitializationData	getMobileUserInitializationData(MobileUserDTO dto) Returns all data needed to initialize the mobile app according to the current channel.
void	ping() May be invoked just to make sure the server is up

Method Detail

getBasicInitializationData

BasicInitializationData getBasicInitializationData()
                                            throws FrameworkException

Returns basic data to bootstrap the client application

Throws:

FrameworkException

getBasicInitializationWithContentData

BasicInitializationWithContentData getBasicInitializationWithContentData()
                                                                  throws FrameworkException

Returns basic data to bootstrap the client application, together with some additional content

Throws:

FrameworkException

getHomeData

HomeData getHomeData()
              throws FrameworkException

Returns data for the home page

Throws:

FrameworkException

getInitializationData

InitializationData getInitializationData()
                                  throws FrameworkException

Returns all data which is used when the application is loaded

Throws:

FrameworkException

getMobileGuestInitializationData

MobileGuestInitializationData getMobileGuestInitializationData(MobileGuestDTO guestVersionData)
                                                        throws FrameworkException

Returns all data which is used after the mobile application connect to a Cyclos but before the user log in. The MobileGuestVersionData parameter contains the versions stored in the mobile application.

Throws:

FrameworkException

getMobileUserInitializationData

BaseMobileUserInitializationData getMobileUserInitializationData(MobileUserDTO dto)
                                                          throws FrameworkException

Returns all data needed to initialize the mobile app according to the current channel. If it's access client then returns the data for the mobile app in POS mode. Otherwise return data for the mobile app in normal mode.

Parameters:

dto - contains the versions stored in the mobile application.

Throws:

FrameworkException

ping

void ping()
   throws FrameworkException

May be invoked just to make sure the server is up

Throws:

FrameworkException