com.whitestein.lsps.orgstructure.function

Interface OrgStructureFunctions

All Known Implementing Classes:

OrgStructureFunctionsImpl

public interface OrgStructureFunctions

Functions provided by this module.

Author:

rba

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.

Method Detail

children

SetHolder children(ExecutionContext context,
                   RecordHolder roleUnitHolder)
            throws ErrorException

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.

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

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

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.

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

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

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.

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

SetHolder personsWith(ExecutionContext context,
                      RecordHolder roleUnitHolder)
               throws ErrorException

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.

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

SetHolder personsStrictlyWith(ExecutionContext context,
                              RecordHolder roleHolder)
                       throws ErrorException

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 personsWith(com.whitestein.lsps.engine.lang.ExecutionContext, com.whitestein.lsps.lang.exec.RecordHolder) function (method).

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

RecordHolder getPersonWithId(ExecutionContext context,
                             String id)
                      throws ErrorException

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

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

RecordHolder getPersonWithLogin(ExecutionContext context,
                                String name)
                         throws ErrorException

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

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

getCurrentPerson

RecordHolder getCurrentPerson(ExecutionContext context)
                       throws ErrorException

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.

Parameters:

context -

Returns:

the person who has initiates the current model processing request

Throws:

ErrorException

getOrgUnit

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

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

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

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

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

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

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

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

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

NullPointerException - if moduleName or localName or parameterMap is null

IllegalArgumentException - if parameterMap does not contain only strings

getRoleRecordHolder

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

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

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

NullPointerException - if moduleName or localName or parameterMap is null

IllegalArgumentException - if parameterMap does not contain only strings

getRoleUnitByName

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

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

Parameters:

context - the execution context

module - the module name

name - the role-unit name

Returns:

a RoleUnit or OrgUnit

Throws:

ErrorException

getRoleUnitByName

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

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

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

AnyPerformerHolder anyPerformer(ExecutionContext context)
                         throws ErrorException

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.

Parameters:

context -

Returns:

a special performer representing any known process performer

Throws:

ErrorException

getPersonFullName

String getPersonFullName(ExecutionContext context,
                         RecordHolder person)
                  throws ErrorException

Returns the full name of the specified person.

Parameters:

context -

person -

Returns:

the full name of the specified person

Throws:

ErrorException

getPersonProperties

MapHolder getPersonProperties(ExecutionContext context,
                              RecordHolder person)
                       throws ErrorException

Returns the additional properties of the specified person.

Parameters:

context -

person -

Returns:

the additional properties of the specified person

Throws:

ErrorException

getPersonRoles

SetHolder getPersonRoles(ExecutionContext context,
                         RecordHolder person)
                  throws ErrorException

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

Parameters:

context -

person -

Returns:

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

Throws:

ErrorException

getPersonPicture

RecordHolder getPersonPicture(ExecutionContext context,
                              RecordHolder person)
                       throws ErrorException

Returns file with photo for the person.

Parameters:

context -

person -

Returns:

file with photo for the person

Throws:

ErrorException

setPersonPicture

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

Sets file with photo to the person.

Parameters:

context -

person -

file -

Throws:

ErrorException

addPersonToRole

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

Assign role to person.

Parameters:

context -

personRecord -

roleRecord -

Throws:

ErrorException

removePersonFromRole

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

Remove person from role.

Parameters:

context -

personRecord -

roleRecord -

Throws:

ErrorException