atg.userprofiling.endeca

Class ProfileUserState

java.lang.Object

UserState

atg.endeca.assembler.navigation.LiveUserState

atg.userprofiling.endeca.ProfileUserState

public class ProfileUserState
extends LiveUserState

Extends Endeca UserState to populate its userSegments list with profile segments, the current site, and all site groups that contain the current site.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	CLASS_VERSION Class version string

Constructor Summary

Constructors

Constructor and Description
ProfileUserState()

Method Summary

Methods

Modifier and Type	Method and Description
Profile	getProfile()
java.util.Set<java.lang.String>	getProfileGroups() Override that computes and fills in the set of profile groups for the current profile if it hasn't been computed yet.
boolean	getProfileGroupsNeeded()
java.lang.String	getUserSegmentPrefix() Deprecated. value ignored
void	setProfile(Profile pProfile) Sets the Profile for the current user.
void	setProfileGroupsNeeded(boolean pProfileGroupsNeeded) Sets a flag to say whether the set of profile groups needs to be computed.
void	setUserSegmentPrefix(java.lang.String pUserSegmentPrefix) Deprecated. value ignored

Methods inherited from class atg.endeca.assembler.navigation.LiveUserState

computeSegments, getPrefixDelimiter, getSegmentsNeeded, getSiteGroupManager, getSiteGroupPrefix, getSitePrefix, getUserSegments, setPrefixDelimiter, setSegmentsNeeded, setSiteGroupManager, setSiteGroupPrefix, setSitePrefix

Methods inherited from class java.lang.Object

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

Field Detail

CLASS_VERSION

protected static final java.lang.String CLASS_VERSION

Class version string

See Also:

Constant Field Values

Constructor Detail

ProfileUserState

public ProfileUserState()

Method Detail

setProfile

public void setProfile(Profile pProfile)

Sets the Profile for the current user.

getProfile

public Profile getProfile()

Returns:

the Profile for the current user

setUserSegmentPrefix

public void setUserSegmentPrefix(java.lang.String pUserSegmentPrefix)

Deprecated. value ignored

The userSegmentPrefix property is no longer supported for profile groups due to its replacement with a well-known mandatory key prefixed to profile groupd strings by Workbench. This key is defined on the server side as a constant in MdexContentRequestBroker. Sets the prefix to use with each segment name.

getUserSegmentPrefix

public java.lang.String getUserSegmentPrefix()

Deprecated. value ignored

No longer supported for profile groups.

Returns:

the prefix to use with each segment name.

setProfileGroupsNeeded

public void setProfileGroupsNeeded(boolean pProfileGroupsNeeded)

Sets a flag to say whether the set of profile groups needs to be computed.

getProfileGroupsNeeded

public boolean getProfileGroupsNeeded()

Returns:

the flag that says whether the set of profile groups needs to be computed.

getProfileGroups

public java.util.Set<java.lang.String> getProfileGroups()

Override that computes and fills in the set of profile groups for the current profile if it hasn't been computed yet.

Returns:

the profile groups for the current Assembler invocation