Package ch.tocco.nice2.businessunit.api

Class BusinessUnitChange

java.lang.Object

ch.tocco.nice2.businessunit.api.BusinessUnitChange

public final class BusinessUnitChange
extends Object

Describes changing the business unit. The business unit is changed using BusinessUnitManager.withBusinessUnit(BusinessUnitChange). The code executed by the invoker is running in the given business unit. By default, the principal is logged into the new business unit since now the policy may have changed. If the code is known to be executed in privileged mode, this is not necessary and can be skipped (the policy of the current user does not matter when running privileged). This is possible to specify using noLogin(). If this is used with persistence related code, consider using PersistTasks, see TaskModes.BUSINESS_UNIT which detects automatically when in privileged mode and uses the invoker accordingly.

Method Summary

Modifier and Type	Method	Description
BusinessUnitChange	allowResetting()	allows the setting and removal of business unit relations with type BusinessUnitType.SINGLE or BusinessUnitType.OPTIONAL
boolean	equals(Object o)
BusinessUnitChange	forbidResetting()	forbids the setting and removal of business unit relations with type BusinessUnitType.SINGLE or BusinessUnitType.OPTIONAL
BusinessUnit	getBusinessUnit()
int	hashCode()
boolean	isReloginPrincipal()
boolean	isResettingAllowed()
BusinessUnitChange	noLogin()	The principal is **not** logged into the new business unit, leaving the policy corresponding to the old business unit in place.
BusinessUnitChange	performLogin()	After changing the business unit, but before the invoker executes the given code, the principal is logged in again, to reflect the different policy that is linked to the business unit.
static BusinessUnitChange	to(BusinessUnit unit)
static BusinessUnitChange	to(String businessUnitId)
static BusinessUnitChange	toNullBusinessUnit()

Methods inherited from class java.lang.Object

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

Method Details

to

public static BusinessUnitChange to(BusinessUnit unit)

to

public static BusinessUnitChange to(String businessUnitId)

toNullBusinessUnit

public static BusinessUnitChange toNullBusinessUnit()

performLogin

public BusinessUnitChange performLogin()

After changing the business unit, but before the invoker executes the given code, the principal is logged in again, to reflect the different policy that is linked to the business unit. This is the default.

Returns:

a new BusinessUnitChange

noLogin

public BusinessUnitChange noLogin()

The principal is **not** logged into the new business unit, leaving the policy corresponding to the old business unit in place. Use this only, if the whole code is known to run in privileged mode.

Returns:

a new BusinessUnitChange

getBusinessUnit

public BusinessUnit getBusinessUnit()

isReloginPrincipal

public boolean isReloginPrincipal()

allowResetting

public BusinessUnitChange allowResetting()

allows the setting and removal of business unit relations with type BusinessUnitType.SINGLE or BusinessUnitType.OPTIONAL

Returns:

copy of this with resettingAllowed set to true

forbidResetting

public BusinessUnitChange forbidResetting()

forbids the setting and removal of business unit relations with type BusinessUnitType.SINGLE or BusinessUnitType.OPTIONAL

Returns:

copy of this with resettingAllowed set to false

isResettingAllowed

public boolean isResettingAllowed()

Returns:

whether the setting and removal of business unit relations with type BusinessUnitType.SINGLE or BusinessUnitType.OPTIONAL should be allowed

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object