de.unikassel.android.sdcframework.preferences.facade
Interface ServiceConfiguration

Package class diagram package ServiceConfiguration
All Superinterfaces:
Configuration, UpdatableConfiguration<ServiceConfiguration>
All Known Implementing Classes:
ServiceConfigurationImpl

public interface ServiceConfiguration
extends UpdatableConfiguration<ServiceConfiguration>

The configuration for the framework service and persistence module.


Method Summary
 long getBroadcastFrequency()
          Getter for the broadcast frequency
 int getDBFullDeletionRecordCount()
          Getter for the record count to be deleted in case of a full database ( used by the sample deletion strategy )
 DBFullStrategyDescription getDBFullStrategy()
          Getter for the configured Database full strategy chain
 long getDBFullWaitTime()
          Getter for the wait time used by the wait strategy in case of a full database
 TransmissionProtocolConfiguration getLogTransferConfiguration()
          Getter for the log transfer configuration
 long getMaximumDatabaseSize()
          Getter for the maximum database size in bytes
 TransmissionConfiguration getTransmissionConfiguration()
          Getter for the transmission configuration
 WeeklySchedule getWeeklySchedule()
          Getter for the weekly runtime schedule.
 boolean isAddingSampleLocation()
          Getter for the flag for adding a location fix to each sample
 boolean isBroadcastingSamples()
          Getter for the flag for sample broadcasts behavior
 boolean isDBFullDeletionPriorityBased()
          Getter for the flag database deletion strategy priority flag
 boolean isSamplingEnabled()
          Getter for the sampling enabled state
 boolean isStoringSamples()
          Getter for the flag for persistent storage behavior
 boolean isTransmittingSamples()
          Getter for the transmission behavior flag
 void setBroadcastFrequency(Long frequency)
          Setter for the broadcast frequency
 void setBroadcastingSamples(Boolean isBroadcastingSamples)
          Setter for the flag for sample broadcasts behavior
 void setDBFullDeletionPriorityBased(Boolean dbFullDeletionIsPriorityBased)
          Setter for the flag database deletion strategy priority flag
 void setDBFullDeletionRecordCount(Integer dbFullDeletionRecordCount)
          Setter for the record count to be deleted in case of a full database ( used by the sample deletion strategy )
 void setDBFullStrategy(DBFullStrategyDescription dbFullStrategy)
          Setter for the configured database full strategy chain
 void setDBFullWaitTime(Long dbFullWaitTime)
          Setter for the wait time used by the wait strategy in case of a full database
 void setIsAddingSampleLocation(Boolean isAddingSampleLocation)
          Setter for the flag for adding a location fix to each sample
 void setLogTransferConfiguration(TransmissionProtocolConfiguration config)
          Setter for the log transfer configuration
 void setMaximumDatabaseSize(Long maxDBSize)
          Setter for the maximum database size in bytes
 void setSamplingEnabled(Boolean isSamplingEnabled)
          Setter for the sampling enabled state
 void setStoringSamples(Boolean isStoringSamples)
          Setter for flag for persistent storage behavior
 void setTransmissionConfiguration(TransmissionConfiguration config)
          Setter for the transmission configuration
 void setTransmittingSamples(Boolean isTransmittingSamples)
          Setter for the transmission behavior flag
 void setWeeklySchedule(WeeklySchedule schedule)
          Setter for the weekly runtime schedule.
 void update(SDCConfiguration config)
          Does update this configuration by a serializable configuration
 
Methods inherited from interface de.unikassel.android.sdcframework.preferences.facade.UpdatableConfiguration
update
 

Method Detail

update

void update(SDCConfiguration config)
Does update this configuration by a serializable configuration

Parameters:
config - the serializable configuration to update from

isBroadcastingSamples

boolean isBroadcastingSamples()
Getter for the flag for sample broadcasts behavior

Returns:
true if samples shall be broadcasted, false otherwise

setBroadcastingSamples

void setBroadcastingSamples(Boolean isBroadcastingSamples)
Setter for the flag for sample broadcasts behavior

Parameters:
isBroadcastingSamples - the flag for sample broadcasts to set

getBroadcastFrequency

long getBroadcastFrequency()
Getter for the broadcast frequency

Returns:
the broadcast frequency

setBroadcastFrequency

void setBroadcastFrequency(Long frequency)
Setter for the broadcast frequency

Parameters:
frequency - the broadcast frequency to set

isSamplingEnabled

boolean isSamplingEnabled()
Getter for the sampling enabled state

Returns:
true if sampling is activated, false otherwise

setSamplingEnabled

void setSamplingEnabled(Boolean isSamplingEnabled)
Setter for the sampling enabled state

Parameters:
isSamplingEnabled - the the sampling enabled state to set

isAddingSampleLocation

boolean isAddingSampleLocation()
Getter for the flag for adding a location fix to each sample

Returns:
true if a location fix is added to each sample, false otherwise

setIsAddingSampleLocation

void setIsAddingSampleLocation(Boolean isAddingSampleLocation)
Setter for the flag for adding a location fix to each sample

Parameters:
isAddingSampleLocation - the flag for adding a location fix to each sample

isStoringSamples

boolean isStoringSamples()
Getter for the flag for persistent storage behavior

Returns:
true if samples will be stored persistent, false otherwise

setStoringSamples

void setStoringSamples(Boolean isStoringSamples)
Setter for flag for persistent storage behavior

Parameters:
isStoringSamples - the flag for persistent storage behavior to set

isTransmittingSamples

boolean isTransmittingSamples()
Getter for the transmission behavior flag

Returns:
true if samples will be transferred to a remote host, false otherwise

setTransmittingSamples

void setTransmittingSamples(Boolean isTransmittingSamples)
Setter for the transmission behavior flag

Parameters:
isTransmittingSamples - the transmission behavior flag to set

setMaximumDatabaseSize

void setMaximumDatabaseSize(Long maxDBSize)
Setter for the maximum database size in bytes

Parameters:
maxDBSize - the maximum database size in bytes

getMaximumDatabaseSize

long getMaximumDatabaseSize()
Getter for the maximum database size in bytes

Returns:
the maximum database size in bytes

setDBFullWaitTime

void setDBFullWaitTime(Long dbFullWaitTime)
Setter for the wait time used by the wait strategy in case of a full database

Parameters:
dbFullWaitTime - the wait time in milliseconds to set

getDBFullWaitTime

long getDBFullWaitTime()
Getter for the wait time used by the wait strategy in case of a full database

Returns:
the wait time in milliseconds

setDBFullDeletionRecordCount

void setDBFullDeletionRecordCount(Integer dbFullDeletionRecordCount)
Setter for the record count to be deleted in case of a full database ( used by the sample deletion strategy )

Parameters:
dbFullDeletionRecordCount - the deletion record count to set

getDBFullDeletionRecordCount

int getDBFullDeletionRecordCount()
Getter for the record count to be deleted in case of a full database ( used by the sample deletion strategy )

Returns:
the deletion record count

setDBFullDeletionPriorityBased

void setDBFullDeletionPriorityBased(Boolean dbFullDeletionIsPriorityBased)
Setter for the flag database deletion strategy priority flag

Parameters:
dbFullDeletionIsPriorityBased - true if the database deletion strategy shall delete lower priorities first, false otherwise

isDBFullDeletionPriorityBased

boolean isDBFullDeletionPriorityBased()
Getter for the flag database deletion strategy priority flag

Returns:
true if the database deletion strategy shall delete lower priorities first, false otherwise

setDBFullStrategy

void setDBFullStrategy(DBFullStrategyDescription dbFullStrategy)
Setter for the configured database full strategy chain

Parameters:
dbFullStrategy - the configured database full strategy chain

getDBFullStrategy

DBFullStrategyDescription getDBFullStrategy()
Getter for the configured Database full strategy chain

Returns:
the configured Database full strategy chain

setTransmissionConfiguration

void setTransmissionConfiguration(TransmissionConfiguration config)
Setter for the transmission configuration

Parameters:
config - the transmission configuration to set

getTransmissionConfiguration

TransmissionConfiguration getTransmissionConfiguration()
Getter for the transmission configuration

Returns:
the transmission configuration

setLogTransferConfiguration

void setLogTransferConfiguration(TransmissionProtocolConfiguration config)
Setter for the log transfer configuration

Parameters:
config - the log transfer configuration to set

getLogTransferConfiguration

TransmissionProtocolConfiguration getLogTransferConfiguration()
Getter for the log transfer configuration

Returns:
the log transfer configuration, or null if not configured

setWeeklySchedule

void setWeeklySchedule(WeeklySchedule schedule)
Setter for the weekly runtime schedule.

Parameters:
schedule - the weekly schedule configuration to set.

getWeeklySchedule

WeeklySchedule getWeeklySchedule()
Getter for the weekly runtime schedule.

Returns:
the weekly schedule configuration, or null if not configured