senselogic.sitevision.api.personalization

Interface TargetAudienceUtil

@Requireable(value="TargetAudienceUtil")
public interface TargetAudienceUtil

Target audience utility interface.

An instance of the Sitevision class implementing this interface can be obtained via Utils.getTargetAudienceUtil(). See Utils for how to obtain an instance of the Utils interface.

Since:

Sitevision 2024.09.2

Author:

Robin Lagren

Method Summary

Modifier and Type	Method and Description
List<Node>	resolve() Resolves target audiences (sv:targetAudience) for the current user.
List<Node>	resolveForUser(Node aUser) Resolves target audiences (sv:targetAudience) for the provided user.
List<Node>	resolveForUserFrom(Node aUser, List<Node> aTargetAudiences) Resolves specific target audiences (sv:targetAudience) for the provided user.
List<Node>	resolveFrom(List<Node> aTargetAudiences) Resolves specific target audiences (sv:targetAudience) for the current user.

Method Detail

resolve

List<Node> resolve()

Resolves target audiences (sv:targetAudience) for the current user. This method determines which target audiences the current user belongs to by evaluating all available target audiences of the site.

Returns:

the list of target audiences that the current user belongs to

resolveForUser

List<Node> resolveForUser(Node aUser)

Resolves target audiences (sv:targetAudience) for the provided user. This method determines which target audiences the provided user belongs to by evaluating all available target audiences of the site.

Parameters:

aUser - the user to evaluate target audiences for

Returns:

the list of target audiences that the provided user belongs to

resolveFrom

List<Node> resolveFrom(List<Node> aTargetAudiences)

Resolves specific target audiences (sv:targetAudience) for the current user. This method determines which target audiences from the provided list the current user belongs to.

Parameters:

aTargetAudiences - the list of target audiences to evaluate against the current user

Returns:

the list of target audiences from the provided list that the current user belongs to

Throws:

IllegalArgumentException - if aTargetAudiences is null or contains other than sv:targetAudience Nodes

resolveForUserFrom

List<Node> resolveForUserFrom(Node aUser,
                              List<Node> aTargetAudiences)

Resolves specific target audiences (sv:targetAudience) for the provided user. This method determines which target audiences from the provided list the provided user belongs to.

Parameters:

aUser - the user to evaluate target audiences for

aTargetAudiences - the list of target audiences to evaluate against the provided user

Returns:

the list of target audiences from the provided list that the provided user belongs to

Throws:

IllegalArgumentException - if aTargetAudiences is null or contains other than sv:targetAudience Nodes