Package ch.tocco.nice2.businessunit.api

Interface BusinessUnitManager

All Known Implementing Classes:

BusinessUnitManagerImpl

public interface BusinessUnitManager

Method Summary

Modifier and Type	Method	Description
List<BusinessUnit>	getAllBusinessUnits()
BusinessUnit	getBusinessUnit(Entity entity)	Returns the business unit of the provided entity.
@Nullable BusinessUnit	getBusinessUnitById(String buId)	Returns the business unit of the specified unique_id.
@Nullable BusinessUnitHolder	getBusinessUnitContext()
Optional<Entity>	getBusinessUnitEntity(BusinessUnit businessUnit)	Returns the Business_unit entity that is corresponding to a given BusinessUnit object if it contains a PrimaryKey
Iterable<BusinessUnit>	getBusinessUnits(Principal principal)	Returns all business units that the principal is associated to.
Iterable<BusinessUnit>	getBusinessUnits(Principal principal, String roleId)	Returns all business units that the principal is associated to by the specified roleId.
BusinessUnit	getCurrentBusinessUnit()	Returns the business unit of the current thread or BusinessUnit.NULL_BUSINESS_UNIT if none exists.
Optional<Entity>	getCurrentBusinessUnitEntity()	Returns the Business_unit entity that is corresponding to the current BusinessUnit if the current BusinessUnit contains a PrimaryKey.
boolean	hasBusinessUnit(Entity entity)
void	setBusinessUnit(BusinessUnit bu)	Deprecated. use withBusinessUnit(BusinessUnitChange) instead, enabling the `noLogin` option
void	setBusinessUnitContext(BusinessUnitHolder holder)
void	setDefaultBusinessUnit(String principal, @Nullable BusinessUnit preferredBusinessUnit)	Sets the default business unit for the specified principal only if no current business unit is found.
void	switchBusinessUnit(BusinessUnit bu, boolean saveChange)	Sets the specified business unit to the current thread and triggers all necessary updates (re-login).
Invoker	withBusinessUnit(BusinessUnitChange bu)	Get an invoker to execute something with a certain business unit.
Invoker	withBusinessUnitOfEntity(Entity entity)	Get an invoker to execute something with the business unit of the given entity.
<A, B> PersistTask<A,B>	withinBusinessUnit(BusinessUnit bu, PersistTask<A,B> delegate)	Returns a new task that executes the given task within the given business unit.
Invoker	withNullBusinessUnit()	Get an invoker to execute something with the BusinessUnit.NULL_BUSINESS_UNIT.
Invoker	withoutBusinessUnitInterceptor()

Method Details

setDefaultBusinessUnit

void setDefaultBusinessUnit(String principal,
 @Nullable
 @Nullable BusinessUnit preferredBusinessUnit)

Sets the default business unit for the specified principal only if no current business unit is found.

The business unit is retrieved from the user settings. If not available some business-unit for the principal is set. The default implementation sets the business unit with the lowest primary key.

Used after login to apply an initial business unit.

Parameters:

principal - the username of the principal

withBusinessUnit

Invoker withBusinessUnit(BusinessUnitChange bu)

Get an invoker to execute something with a certain business unit.

Parameters:

bu - the desired business unit.

Returns:

the invoker.

See Also:

• withBusinessUnitOfEntity(Entity)
• withNullBusinessUnit()

withBusinessUnitOfEntity

Invoker withBusinessUnitOfEntity(Entity entity)

Get an invoker to execute something with the business unit of the given entity.

Parameters:

entity - the business unit dependent entity.

Returns:

the invoker.

withNullBusinessUnit

Invoker withNullBusinessUnit()

Get an invoker to execute something with the BusinessUnit.NULL_BUSINESS_UNIT.

Returns:

the invoker.

withoutBusinessUnitInterceptor

Invoker withoutBusinessUnitInterceptor()

Returns:

an invoker that disables the business unit query interceptor. This means that results from queries always contain results from all business units.

See Also:

• This does *not* cause a login (and thus does not apply any roles) and should only be used in privileged mode (because roles are not relevant for queries in privileged mode)! Note that BusinessUnitManager#getCurrentBusinessUnit() returns the previously set business unit and not necessarily the null business unit. This invoker can be faster than BusinessUnitManager#withNullBusinessUnit() because the login is avoided (which also causes the conditions cache to be cleared).

withinBusinessUnit

<A,
B> PersistTask<A,B> withinBusinessUnit(BusinessUnit bu,
 PersistTask<A,B> delegate)

Returns a new task that executes the given task within the given business unit.

switchBusinessUnit

void switchBusinessUnit(BusinessUnit bu,
 boolean saveChange)

Sets the specified business unit to the current thread and triggers all necessary updates (re-login). This is a permanent change to the given business unit. The `saveChange` parameter controls whether the new business unit is saved in the usersettings.

hasBusinessUnit

boolean hasBusinessUnit(Entity entity)

Parameters:

entity - entity

Returns:

true if the entity-model has a business unit

getBusinessUnit

BusinessUnit getBusinessUnit(Entity entity)

Returns the business unit of the provided entity. Throws a IllegalArgumentException if the provided entity is not business-unit dependent.

Parameters:

entity - a entity

Returns:

the business unit of the provided entity

getBusinessUnits

Iterable<BusinessUnit> getBusinessUnits(Principal principal)

Returns all business units that the principal is associated to.

getBusinessUnits

Iterable<BusinessUnit> getBusinessUnits(Principal principal,
 String roleId)

Returns all business units that the principal is associated to by the specified roleId.

Parameters:

principal - the Principal

roleId - the unique_id of the role

getAllBusinessUnits

List<BusinessUnit> getAllBusinessUnits()

Returns:

all business units (except the BusinessUnit.NULL_BUSINESS_UNIT)

getBusinessUnitById

@Nullable
@Nullable BusinessUnit getBusinessUnitById(String buId)

Returns the business unit of the specified unique_id.

setBusinessUnit

@Deprecated
void setBusinessUnit(BusinessUnit bu)

Deprecated.

use withBusinessUnit(BusinessUnitChange) instead, enabling the `noLogin` option

Sets the specified business unit to the current thread overwriting any existing one! It does NOT re-login the principal.

Parameters:

bu - new business unit to set

getCurrentBusinessUnit

BusinessUnit getCurrentBusinessUnit()

Returns the business unit of the current thread or BusinessUnit.NULL_BUSINESS_UNIT if none exists.

getBusinessUnitEntity

Optional<Entity> getBusinessUnitEntity(BusinessUnit businessUnit)

Returns the Business_unit entity that is corresponding to a given BusinessUnit object if it contains a PrimaryKey

Returns:

Business_unit entity

getCurrentBusinessUnitEntity

Optional<Entity> getCurrentBusinessUnitEntity()

Returns the Business_unit entity that is corresponding to the current BusinessUnit if the current BusinessUnit contains a PrimaryKey.

Returns:

Business_unit entity

setBusinessUnitContext

void setBusinessUnitContext(BusinessUnitHolder holder)

getBusinessUnitContext

@Nullable
@Nullable BusinessUnitHolder getBusinessUnitContext()