Package de.xima.fc.api.entity

Class MaintenanceAPI

java.lang.Object

de.xima.fc.api.ASubAPI

de.xima.fc.api.entity.AEntityAPI<Maintenance>

de.xima.fc.api.entity.MaintenanceAPI

public class MaintenanceAPI
extends AEntityAPI<Maintenance>

Maintenance API.

Author:

Hannes John

Field Summary

Fields inherited from class de.xima.fc.api.entity.AEntityAPI

entityClass

Constructor Summary

Constructors

Constructor	Description
MaintenanceAPI()

Method Summary

Modifier and Type	Method	Description
List<TenantMaintenance>	getActiveTenantMaintenance(UserContext uc, Mandant tenant)	Retrieves all active tenant maintenance items for the given tenant.
IMaintenanceHandler.MaintenanceModeActivationInfo	getMaintenanceModeActivationInfo(UserContext uc, Mandant tenant)	Retrieves information on activation of tenant maintenance mode.

Methods inherited from class de.xima.fc.api.entity.AEntityAPI

create, create, delete, delete, deleteAllBy, deleteById, deleteById, getAll, getAllBy, getAttributes, getAttributes, getBy, getById, getById, getEntityRefs, getPagedResult, getSingleAttributes, getSingleAttributes, resultTotalCount, resultTotalCount, update, update

Methods inherited from class de.xima.fc.api.ASubAPI

getHandlerProvider

Methods inherited from class java.lang.Object

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

Constructor Detail

MaintenanceAPI

public MaintenanceAPI()

Method Detail

getActiveTenantMaintenance

public List<TenantMaintenance> getActiveTenantMaintenance(UserContext uc,
                                                          Mandant tenant)

Retrieves all active tenant maintenance items for the given tenant.

Parameters:

uc - user context

tenant - tenant

Returns:

all active tenant maintenance items for the given tenant

getMaintenanceModeActivationInfo

public IMaintenanceHandler.MaintenanceModeActivationInfo getMaintenanceModeActivationInfo(UserContext uc,
                                                                                          Mandant tenant)

Retrieves information on activation of tenant maintenance mode.

Parameters:

uc - user context

tenant - tenant

Returns:

maintenance mode activation info