senselogic.sitevision.api.user

Interface UserFactory

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

Factory for creating user-related instances.

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

Since:

Sitevision 3.6

Author:

Magnus Lövgren

Method Summary

Modifier and Type	Method and Description
SimpleUserUtil	getSimpleUserUtil() Gets an instance of a simple user utility class.
SystemUserUtil	getSystemUserUtil() Gets an instance of a system user utility class.
UserDataUtil	getUserDataUtil() Gets an instance of a user data utility class.
UserIdentityUtil	getUserIdentityUtil() Gets an instance of a user identity utility class.
UserIdentityWrapper	getUserIdentityWrapper(Node aUserIdentity) Gets an instance of a user identity wrapper.
UserUtil	getUserUtil() Gets an instance of a user utility class.

Method Detail

getUserIdentityUtil

UserIdentityUtil getUserIdentityUtil()

Gets an instance of a user identity utility class.

Returns:

an instance of a user identity utility class

getUserIdentityWrapper

UserIdentityWrapper getUserIdentityWrapper(Node aUserIdentity)

Gets an instance of a user identity wrapper.

Parameters:

aUserIdentity - a user identity (or user)

Returns:

an instance of a user identity wrapper, or null if indeterminable (e.g. aUserIdentity is null or aUserIdentity is not available)

getSystemUserUtil

SystemUserUtil getSystemUserUtil()

Gets an instance of a system user utility class.

Returns:

an instance of a system user utility class

getUserUtil

UserUtil getUserUtil()

Gets an instance of a user utility class.

Returns:

an instance of a user utility class

Since:

Sitevision 4.0.1

getSimpleUserUtil

SimpleUserUtil getSimpleUserUtil()

Gets an instance of a simple user utility class.

Returns:

an instance of a simple user utility class

Since:

Sitevision 4.0.1

getUserDataUtil

UserDataUtil getUserDataUtil()

Gets an instance of a user data utility class.

Returns:

an instance of a user data utility class

Since:

Sitevision 4.1