org.bonitasoft.engine.business.application

Class ApplicationCreator

java.lang.Object

org.bonitasoft.engine.business.application.ApplicationCreator

All Implemented Interfaces:

Serializable

public class ApplicationCreator
extends Object
implements Serializable

Describes the information about an Application to be created

Since:

7.0.0

Author:

Elias Ricken de Medeiros

See Also:

Application, Serialized Form

Constructor Summary

Constructors

Constructor and Description
ApplicationCreator(String token, String displayName, String version) Creates an instance of ApplicationCreator containing mandatory information.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Map<ApplicationField,Serializable>	getFields() Retrieves all fields defined in this ApplicationCreator
String	getToken() Retrieves the Application token
int	hashCode()
ApplicationCreator	setDescription(String description) Defines the Application description and returns the current ApplicationCreator
ApplicationCreator	setIconPath(String iconPath) Defines the Application icon path and returns the current ApplicationCreator
ApplicationCreator	setProfileId(Long profileId) Defines the identifier of the Profile related to this Application and returns the current ApplicationCreator

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationCreator

public ApplicationCreator(String token,
                          String displayName,
                          String version)

Creates an instance of ApplicationCreator containing mandatory information.

The created Application will used the default layout.

Parameters:

token - the Application token. The token will be part of application URL. It cannot be null or empty and should contain only alpha numeric characters and the following special characters '-', '.', '_' or '~'. In addition, the following words are reserved key words and cannot be used as token: 'api', 'content', 'theme'.

displayName - the Application display name. It cannot be null or empty

version - the Application version

See Also:

Application

Method Detail

getToken

public String getToken()

Retrieves the Application token

Returns:

the Application token

See Also:

Application

setDescription

public ApplicationCreator setDescription(String description)

Defines the Application description and returns the current ApplicationCreator

Parameters:

description - the Application description

Returns:

the current ApplicationCreator

See Also:

Application

setIconPath

public ApplicationCreator setIconPath(String iconPath)

Defines the Application icon path and returns the current ApplicationCreator

Parameters:

iconPath - the Application icon path

Returns:

the current ApplicationCreator

See Also:

Application

setProfileId

public ApplicationCreator setProfileId(Long profileId)

Defines the identifier of the Profile related to this Application and returns the current ApplicationCreator

Parameters:

profileId - the Profile identifier

Returns:

the current ApplicationCreator

See Also:

Application, Profile

getFields

public Map<ApplicationField,Serializable> getFields()

Retrieves all fields defined in this ApplicationCreator

Returns:

a Map<ApplicationField, Serializable> containing all fields defined in this ApplicationCreator

See Also:

ApplicationField

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object