com.whitestein.lsps.orgstructure.function

Class OrgStructureFunctionsImpl

java.lang.Object

com.whitestein.lsps.orgstructure.function.OrgStructureFunctionsImpl

All Implemented Interfaces:

OrgStructureFunctions

@PermitAll
public class OrgStructureFunctionsImpl
extends Object
implements OrgStructureFunctions

Functions for Organizational Structure module.

Author:

vgr, mko

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERSON_NOT_FOUND_ERROR Error code for person not found

Constructor Summary

Constructors

Constructor and Description
OrgStructureFunctionsImpl() Creates new instance.
OrgStructureFunctionsImpl(PersonServiceLocal personService, OrgTypeFactory orgTypeFactory, SecurityManagerServiceLocal securityManagerService) Creates new instance.

Method Summary

Modifier and Type	Method and Description
void	addPersonToRole(ExecutionContext context, RecordHolder personRecord, RecordHolder roleRecord) Assign role to person.
AnyPerformerHolder	anyPerformer(ExecutionContext context) Returns a special performer representing any known process performer.
SetHolder	children(ExecutionContext context, RecordHolder roleUnitHolder) Returns a SetHolder of children of the roleUnitHolder.
RecordHolder	getCurrentPerson(ExecutionContext context) Returns the person who has initiates the current model processing request.
RecordHolder	getOrgUnit(ExecutionContext context, String moduleName, String localName, MapHolder parameterMap) Returns an organization unit given the module name and the organization unit name, or null, if there is no such organization unit.
RecordHolder	getOrgUnitRecordHolder(ExecutionContext context, String moduleName, String localName, Map<?,?> parameterMap) Returns an organization unit given the module name and the organization unit name, or null, if there is no such organization unit.
String	getPersonFullName(ExecutionContext context, RecordHolder person) Returns the full name of the specified person.
RecordHolder	getPersonPicture(ExecutionContext context, RecordHolder person) Returns file with photo for the person.
MapHolder	getPersonProperties(ExecutionContext context, RecordHolder person) Returns the additional properties of the specified person.
SetHolder	getPersonRoles(ExecutionContext context, RecordHolder person) Returns a set of organization roles from the current model directly as signed to the specified person.
RecordHolder	getPersonWithId(ExecutionContext context, String id) Returns a person given the id of the process performer or ErrorExcetion, if there is no such person.
RecordHolder	getPersonWithLogin(ExecutionContext context, String name) Returns a person given the unique name of the process performer or ErrorExcetion, if there is no such person.
RecordHolder	getRole(ExecutionContext context, String moduleName, String localName, MapHolder parameterMap) Returns a role given the module name and the local role name, or null, if there is no such role.
RecordHolder	getRoleRecordHolder(ExecutionContext context, String moduleName, String localName, Map<?,?> parameterMap) Returns a role given the module name and the local role name, or null, if there is no such role.
RoleUnitHolder	getRoleUnitByName(ExecutionContext context, String module, String name) Returns a RoleUnit or OrgUnit specified by module name and RoleUnitName in the given module.
RoleUnitHolder	getRoleUnitByName(ExecutionContext context, String module, String name, MapHolder parameters) Returns a RoleUnit or OrgUnit specified by module name , RoleUnitName and parameters defined in the given module.
boolean	isPersonIn(ExecutionContext context, RecordHolder personHolder, RecordHolder roleUnitHolder) Returns true, if the given person belongs in the given organizational structure to the given role or unit.
boolean	isPersonStrictlyIn(ExecutionContext context, RecordHolder personHolder, RecordHolder roleHolder) Returns true, if the given person belongs in the given organizational structure strictly to the given role or unit, not to their sub-roles or sub-units.
SetHolder	personsStrictlyWith(ExecutionContext context, RecordHolder roleHolder) Returns a set of all persons that belong in the given organizational structure strictly to the given role or unit, not to their sub-roles or sub-units.
SetHolder	personsWith(ExecutionContext context, RecordHolder roleUnitHolder) Returns a set of all persons that belong in the given organizational structure to the given role or unit.
void	removePersonFromRole(ExecutionContext context, RecordHolder personRecord, RecordHolder roleRecord) Remove person from role.
void	setPersonPicture(ExecutionContext context, RecordHolder person, RecordHolder file) Sets file with photo to the person.

Methods inherited from class java.lang.Object

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

Field Detail

PERSON_NOT_FOUND_ERROR

public static final String PERSON_NOT_FOUND_ERROR

Error code for person not found

See Also:

Constant Field Values

Constructor Detail

OrgStructureFunctionsImpl

public OrgStructureFunctionsImpl()

Creates new instance.

OrgStructureFunctionsImpl

public OrgStructureFunctionsImpl(PersonServiceLocal personService,
                                 OrgTypeFactory orgTypeFactory,
                                 SecurityManagerServiceLocal securityManagerService)

Creates new instance.

Parameters:

personService -

orgTypeFactory -

securityManagerService -

Throws:

NullPointerException - if any of the arguments is null

Method Detail

children

public SetHolder children(ExecutionContext context,
                          RecordHolder roleUnitHolder)
                   throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns a SetHolder of children of the roleUnitHolder. In the case of parametric RoleUnit the values of children's parameters are derived from the parameters of this RoleUnit, i.e., the value of a child's parameter is given by the value of the parent's parameter with their parent.

Specified by:

children in interface OrgStructureFunctions

Parameters:

context - the execution context

roleUnitHolder - The holder of RoleUnit of interest.

Returns:

SetHolder of children, wrapped in RecordHolder. If RoleUnit of interest has no children, the empty SetHolder is returned.

Throws:

ErrorException

isPersonIn

public boolean isPersonIn(ExecutionContext context,
                          RecordHolder personHolder,
                          RecordHolder roleUnitHolder)
                   throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns true, if the given person belongs in the given organizational structure to the given role or unit. The person "belongs" to the given role or unit if it belongs to it directly or belongs to a child (recursively evaluated) of the given role or unit.

Specified by:

isPersonIn in interface OrgStructureFunctions

Parameters:

context - the execution context

personHolder - The holder representing a Person record.

roleUnitHolder - The holder representing a RoleUnit record.

Returns:

true if the given person belongs in the given organizational structure to the given role or unit, otherwise false.

Throws:

ErrorException

isPersonStrictlyIn

public boolean isPersonStrictlyIn(ExecutionContext context,
                                  RecordHolder personHolder,
                                  RecordHolder roleHolder)
                           throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns true, if the given person belongs in the given organizational structure strictly to the given role or unit, not to their sub-roles or sub-units. Therefore, this is a non-recursive version of the isPersonIn() function.

Specified by:

isPersonStrictlyIn in interface OrgStructureFunctions

Parameters:

context - the execution context

personHolder - The holder representing a Person record.

roleHolder - The holder representing a RoleUnit record.

Returns:

true, if the given person belongs in the given organizational structure strictly to the given role or unit, otherwise false.

Throws:

ErrorException

personsWith

public SetHolder personsWith(ExecutionContext context,
                             RecordHolder roleUnitHolder)
                      throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns a set of all persons that belong in the given organizational structure to the given role or unit. The person "belongs" to the given role or unit if it belongs to it directly or belongs to a child (recursively evaluated) of the given role or unit.

Specified by:

personsWith in interface OrgStructureFunctions

Parameters:

context - the execution context

roleUnitHolder - The holder representing a RoleUnit record.

Returns:

A set of all persons that belong in the given organizational structure to the given role or unit.

Throws:

ErrorException

personsStrictlyWith

public SetHolder personsStrictlyWith(ExecutionContext context,
                                     RecordHolder roleHolder)
                              throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns a set of all persons that belong in the given organizational structure strictly to the given role or unit, not to their sub-roles or sub-units. Therefore, this is a non-recursive version of the OrgStructureFunctions.personsWith(com.whitestein.lsps.engine.lang.ExecutionContext, com.whitestein.lsps.lang.exec.RecordHolder) function (method).

Specified by:

personsStrictlyWith in interface OrgStructureFunctions

Parameters:

context - the execution context

roleHolder - The holder representing a RoleUnit record.

Returns:

A set of all persons that belong in the given organizational structure strictly to the given role or unit.

Throws:

ErrorException

getPersonWithId

public RecordHolder getPersonWithId(ExecutionContext context,
                                    String id)
                             throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns a person given the id of the process performer or ErrorExcetion, if there is no such person.

Specified by:

getPersonWithId in interface OrgStructureFunctions

Parameters:

context - the execution context

id - The id of the person to look for.

Returns:

A person given the unique name of the process performer or ErrorExcetion, if there is no such person.

Throws:

ErrorException

getPersonWithLogin

public RecordHolder getPersonWithLogin(ExecutionContext context,
                                       String name)
                                throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns a person given the unique name of the process performer or ErrorExcetion, if there is no such person.

Specified by:

getPersonWithLogin in interface OrgStructureFunctions

Parameters:

context - the execution context

name - The unique name of the person to look for.

Returns:

A person given the unique name of the process performer or ErrorExcetion, if there is no such person.

Throws:

ErrorException

getPersonPicture

public RecordHolder getPersonPicture(ExecutionContext context,
                                     RecordHolder person)
                              throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns file with photo for the person.

Specified by:

getPersonPicture in interface OrgStructureFunctions

Returns:

file with photo for the person

Throws:

ErrorException

setPersonPicture

public void setPersonPicture(ExecutionContext context,
                             RecordHolder person,
                             RecordHolder file)
                      throws ErrorException

Description copied from interface: OrgStructureFunctions

Sets file with photo to the person.

Specified by:

setPersonPicture in interface OrgStructureFunctions

Throws:

ErrorException

getCurrentPerson

public RecordHolder getCurrentPerson(ExecutionContext context)
                              throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns the person who has initiates the current model processing request. For instance, the person who has submitted a to-do or called a web service. In cases of receiving time events or signals the technical person "ProcessAgent" is returned.

Specified by:

getCurrentPerson in interface OrgStructureFunctions

Returns:

the person who has initiates the current model processing request

Throws:

ErrorException

getOrgUnit

public RecordHolder getOrgUnit(ExecutionContext context,
                               String moduleName,
                               String localName,
                               MapHolder parameterMap)
                        throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns an organization unit given the module name and the organization unit name, or null, if there is no such organization unit.

Specified by:

getOrgUnit in interface OrgStructureFunctions

Parameters:

context - the execution context

moduleName - the module name

localName - the local name

parameterMap - the parameter map

Returns:

a organization unit given the module name and the organization unit name, or null, if there is no such organization unit

Throws:

ErrorException

getOrgUnitRecordHolder

public RecordHolder getOrgUnitRecordHolder(ExecutionContext context,
                                           String moduleName,
                                           String localName,
                                           Map<?,?> parameterMap)
                                    throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns an organization unit given the module name and the organization unit name, or null, if there is no such organization unit.

Specified by:

getOrgUnitRecordHolder in interface OrgStructureFunctions

Parameters:

context - the execution context

moduleName - the module name

localName - the local name

parameterMap - the parameter map

Returns:

a organization unit given the module name and the organization unit name, or null, if there is no such organization unit

Throws:

ErrorException

getRole

public RecordHolder getRole(ExecutionContext context,
                            String moduleName,
                            String localName,
                            MapHolder parameterMap)
                     throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns a role given the module name and the local role name, or null, if there is no such role.

Specified by:

getRole in interface OrgStructureFunctions

Parameters:

context - the execution context

moduleName - the module name

localName - the local name

parameterMap - the parameter map

Returns:

a role given the module name and the local role name, or null, if there is no such role

Throws:

ErrorException

getRoleRecordHolder

public RecordHolder getRoleRecordHolder(ExecutionContext context,
                                        String moduleName,
                                        String localName,
                                        Map<?,?> parameterMap)
                                 throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns a role given the module name and the local role name, or null, if there is no such role.

Specified by:

getRoleRecordHolder in interface OrgStructureFunctions

Parameters:

context - the execution context

moduleName - the module name

localName - the local name

parameterMap - the parameter map

Returns:

a role given the module name and the local role name, or null, if there is no such role

Throws:

ErrorException

getRoleUnitByName

public RoleUnitHolder getRoleUnitByName(ExecutionContext context,
                                        String module,
                                        String name)
                                 throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns a RoleUnit or OrgUnit specified by module name and RoleUnitName in the given module.

Specified by:

getRoleUnitByName in interface OrgStructureFunctions

Parameters:

context - the execution context

module - the module name

name - the role-unit name

Returns:

a RoleUnit or OrgUnit

Throws:

ErrorException

getRoleUnitByName

public RoleUnitHolder getRoleUnitByName(ExecutionContext context,
                                        String module,
                                        String name,
                                        MapHolder parameters)
                                 throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns a RoleUnit or OrgUnit specified by module name , RoleUnitName and parameters defined in the given module.

Specified by:

getRoleUnitByName in interface OrgStructureFunctions

Parameters:

context - the execution context

module - the module name

name - the role-unit name

parameters - the parameters map

Returns:

a RoleUnit or OrgUnit

Throws:

ErrorException

anyPerformer

public AnyPerformerHolder anyPerformer(ExecutionContext context)
                                throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns a special performer representing any known process performer. This function is used to specify access to entities (e.g., to-dos, reports, or widgets) available to all known process performers.

Specified by:

anyPerformer in interface OrgStructureFunctions

Returns:

a special performer representing any known process performer

Throws:

ErrorException

getPersonFullName

public String getPersonFullName(ExecutionContext context,
                                RecordHolder person)
                         throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns the full name of the specified person.

Specified by:

getPersonFullName in interface OrgStructureFunctions

Returns:

the full name of the specified person

Throws:

ErrorException

getPersonProperties

public MapHolder getPersonProperties(ExecutionContext context,
                                     RecordHolder person)
                              throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns the additional properties of the specified person.

Specified by:

getPersonProperties in interface OrgStructureFunctions

Returns:

the additional properties of the specified person

Throws:

ErrorException

getPersonRoles

public SetHolder getPersonRoles(ExecutionContext context,
                                RecordHolder person)
                         throws ErrorException

Description copied from interface: OrgStructureFunctions

Returns a set of organization roles from the current model directly as signed to the specified person.

Specified by:

getPersonRoles in interface OrgStructureFunctions

Returns:

a set of organization roles from the current model directly as signed to the specified person

Throws:

ErrorException

addPersonToRole

public void addPersonToRole(ExecutionContext context,
                            RecordHolder personRecord,
                            RecordHolder roleRecord)
                     throws ErrorException

Description copied from interface: OrgStructureFunctions

Assign role to person.

Specified by:

addPersonToRole in interface OrgStructureFunctions

Throws:

ErrorException

removePersonFromRole

public void removePersonFromRole(ExecutionContext context,
                                 RecordHolder personRecord,
                                 RecordHolder roleRecord)
                          throws ErrorException

Description copied from interface: OrgStructureFunctions

Remove person from role.

Specified by:

removePersonFromRole in interface OrgStructureFunctions

Throws:

ErrorException