org.bonitasoft.engine.business.application

Class ApplicationUpdater

java.lang.Object

org.bonitasoft.engine.business.application.ApplicationUpdater

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ApplicationUpdaterExt

public class ApplicationUpdater
extends Object
implements Serializable

Allows to define which Application fields will be updated

Since:

7.0.0

Author:

Elias Ricken de Medeiros

See Also:

Application, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApplicationUpdater() Creates an instance of ApplicationUpdater

Method Summary

Methods

Modifier and Type	Method and Description
Map<ApplicationField,Serializable>	getFields() Retrieves all fields to be updated
boolean	hasFields() Determines if this updater has at least one field to update
ApplicationUpdater	setDescription(String description) Defines the new value for the Application description
ApplicationUpdater	setDisplayName(String displayName) Defines the new value for the Application display name.
ApplicationUpdater	setHomePageId(Long applicationPageId) Defines the identifier of the new ApplicationPage defined as the Application home page
ApplicationUpdater	setIconPath(String iconPath) Defines the new value for the Application icon path
ApplicationUpdater	setProfileId(Long profileId) Defines the identifier of the new Profile associated to the Application
ApplicationUpdater	setState(String state) Defines the new value for the Application state
ApplicationUpdater	setToken(String token) Defines the new value for the Application token.
ApplicationUpdater	setVersion(String version) Defines the new value for the Application version

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationUpdater

public ApplicationUpdater()

Creates an instance of ApplicationUpdater

Method Detail

getFields

public Map<ApplicationField,Serializable> getFields()

Retrieves all fields to be updated

Returns:

a Map<ApplicationField, Serializable> containing all fields to be updated

See Also:

ApplicationField

setToken

public ApplicationUpdater setToken(String token)

Defines the new value for the Application token. It cannot be empty or null and should contain only alpha numeric characters and the following special characters '-', '.', '_' or '~'.

Parameters:

token - the new value for the Application token

Returns:

the current ApplicationUpdater

See Also:

Application

setDisplayName

public ApplicationUpdater setDisplayName(String displayName)

Defines the new value for the Application display name. It cannot be empty or null.

Parameters:

displayName - the new value for the Application display name

Returns:

the current ApplicationUpdater

See Also:

Application

setVersion

public ApplicationUpdater setVersion(String version)

Defines the new value for the Application version

Parameters:

version - the new value for the Application version

Returns:

the current ApplicationUpdater

See Also:

Application

setDescription

public ApplicationUpdater setDescription(String description)

Defines the new value for the Application description

Parameters:

description - the new value for the Application description

Returns:

the current ApplicationUpdater

See Also:

Application

setIconPath

public ApplicationUpdater setIconPath(String iconPath)

Defines the new value for the Application icon path

Parameters:

iconPath - the new value for the Application icon path

Returns:

the current ApplicationUpdater

See Also:

Application

setState

public ApplicationUpdater setState(String state)

Defines the new value for the Application state

Parameters:

state - the new value for the Application state

Returns:

the current ApplicationUpdater

See Also:

Application

setProfileId

public ApplicationUpdater setProfileId(Long profileId)

Defines the identifier of the new Profile associated to the Application

Parameters:

profileId - the identifier of Profile associated to the Application

Returns:

the current ApplicationUpdater

See Also:

Application, Profile

setHomePageId

public ApplicationUpdater setHomePageId(Long applicationPageId)

Defines the identifier of the new ApplicationPage defined as the Application home page

Parameters:

applicationPageId - the identifier of ApplicationPage associated to the Application

Returns:

the current ApplicationUpdater

See Also:

Application, ApplicationPage

hasFields

public boolean hasFields()

Determines if this updater has at least one field to update

Returns:

true if there is at least one field to update; false otherwise