org.bonitasoft.engine.external.permission

Class IsAllowedToSeeOverviewForm

java.lang.Object

org.bonitasoft.engine.command.TenantCommand

org.bonitasoft.engine.external.permission.IsAllowedToSeeOverviewForm

All Implemented Interfaces:

Command<TenantServiceAccessor>

public class IsAllowedToSeeOverviewForm
extends TenantCommand

Specific Command to ckeck if the user given can see a overview form of a ProcesInstance with the processInstanceId given.

Author:

Zhao Na

Constructor Summary

Constructors

Constructor and Description
IsAllowedToSeeOverviewForm()

Method Summary

Methods

Modifier and Type	Method and Description
Serializable	execute(Map<String,Serializable> parameters, TenantServiceAccessor tenantAccessor) Method that is called by the engine on the server side when the client calls CommandAPI.execute(String, Map) with the name or id of this command.

Methods inherited from class java.lang.Object

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

Constructor Detail

IsAllowedToSeeOverviewForm

public IsAllowedToSeeOverviewForm()

Method Detail

execute

public Serializable execute(Map<String,Serializable> parameters,
                   TenantServiceAccessor tenantAccessor)
                     throws SCommandParameterizationException,
                            SCommandExecutionException

Description copied from interface: Command

Method that is called by the engine on the server side when the client calls CommandAPI.execute(String, Map) with the name or id of this command. Implementors of commands must put here the code to be executed on the server side

Parameters:

parameters - a map of parameters that can be used by the command and that is given by the client when executing the command

tenantAccessor - the TenantServiceAccessor or PlatformServiceAccessor that provides access to the engine's server-side services

Returns:

a boolean representing if the user has the permission to see a overview form of the processInstance

Throws:

SCommandParameterizationException - can be thrown if insufficient or wrong parameters are given by the client

SCommandExecutionException - can be thrown when something unexpected happens while executing the command