Package org.bonitasoft.engine.platform

Interface PlatformService

All Known Implementing Classes:

PlatformServiceImpl

public interface PlatformService

Author:

Charles Souillard, Matthieu Chaffotte, Celine Souchet

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PLATFORM

Method Summary

Modifier and Type	Method	Description
SPlatform	getPlatform()	Retrieve the platform from the cache No need to be in a transaction
SPlatformProperties	getSPlatformProperties()	Return the platform properties
boolean	isPlatformCreated()	Return true if the platform is created, else return false.
void	pauseServices()	update status of tenant object to PAUSED
void	resumeServices()	Set status of the tenant into activated
void	updatePlatform(EntityUpdateDescriptor descriptor)

Field Details

PLATFORM

static final String PLATFORM

See Also:

• Constant Field Values

Method Details

getPlatform

SPlatform getPlatform()
               throws SPlatformNotFoundException

Retrieve the platform from the cache No need to be in a transaction

Returns:

sPlatform

Throws:

SPlatformNotFoundException - occurs when the identifier does not refer to an existing sPlatform

Since:

6.0

resumeServices

void resumeServices()
             throws STenantNotFoundException,
STenantActivationException,
SPlatformNotFoundException,
SPlatformUpdateException

Set status of the tenant into activated

Throws:

STenantNotFoundException - occurs when the identifier does not refer to an existing sTenant

STenantActivationException - occurs when an exception is thrown during activating sTenant

SPlatformNotFoundException

SPlatformUpdateException

Since:

6.0

pauseServices

void pauseServices()
            throws STenantUpdateException,
STenantNotFoundException,
SPlatformNotFoundException,
SPlatformUpdateException

update status of tenant object to PAUSED

Throws:

STenantUpdateException

STenantNotFoundException

SPlatformNotFoundException

SPlatformUpdateException

isPlatformCreated

boolean isPlatformCreated()

Return true if the platform is created, else return false.

Returns:

true or false

Since:

6.0

getSPlatformProperties

SPlatformProperties getSPlatformProperties()

Return the platform properties

Returns:

The platform properties

Since:

6.1

updatePlatform

void updatePlatform(EntityUpdateDescriptor descriptor)
             throws SPlatformUpdateException

Throws:

SPlatformUpdateException