de.innovationgate.webgate.api

Interface WGPersonalisationDatabaseCore

All Superinterfaces:

WGDatabaseCore

All Known Implementing Classes:

WGFakeContentStore, WGFakeDatabase

public interface WGPersonalisationDatabaseCore
extends WGDatabaseCore

This is a mixin interface for WGDatabaseCore implementations that also provide storage of user profiles for personalisation. WGDatabase wraps implementations of this interface and uses them to communicate with WGA personalisation databases for user profile stores. WGDatabaseCore implementations should be "thread-safe", so they should expect that they will be concurrently used by multiple threads.

Method Summary

Methods

Modifier and Type	Method and Description
WGDocumentCore	createUserProfile(java.lang.String name, int type) Called to create a new user profile.
java.util.Iterator<java.lang.String>	getAllUserProfileNames() Returns the names of all user profiles stored inthe database
WGDocumentCore	getUserProfile(java.lang.String name) Retrieves a user profile for the given name
java.util.List<java.lang.String>	queryUserProfileNames(java.lang.String type, java.lang.String query, java.util.Map params) Queries a user profile database for stored profiles, based on their data.

Methods inherited from interface de.innovationgate.webgate.api.WGDatabaseCore

beginTransaction, beginUpdate, callBackendService, clearSessionCache, close, closeSession, commitTransaction, convertFileNameForAttaching, createContent, createCopy, createDesignDocument, createStructEntry, fastAccess, getACL, getAllContent, getAllContentKeys, getChildEntries, getContentByKey, getContentByName, getContentCount, getContentStorePatchLevel, getContentStoreVersion, getDedicatedWorkflowEngine, getDesignObject, getDesignObjects, getDummyContent, getExtensionData, getExtensionDataNames, getIncomingRelations, getNativeObject, getParentEntry, getRevision, getRevisionDate, getRoles, getRootEntries, getServerName, getStructEntryByKey, getStructEntryByName, getTitle, getTypeName, getUpdateLogs, hasFeature, isBackendServiceSupported, isContentTypeUsed, isLanguageUsed, isMemberOfUserList, moveStructEntry, open, openSession, parseStructKey, query, refresh, removeExtensionData, resultIsFalse, resultIsTrue, rollbackTransaction, setCurrentSession, writeExtensionData

Method Detail

getUserProfile

WGDocumentCore getUserProfile(java.lang.String name)
                              throws WGAPIException

Retrieves a user profile for the given name

Parameters:

name - name of the requested user profile

Returns:

The user profile of that name. Null, if there is no user profile with this name.

Throws:

WGAPIException

createUserProfile

WGDocumentCore createUserProfile(java.lang.String name,
                               int type)
                                 throws WGAPIException

Called to create a new user profile. If parameter name is given, this param should be used to name this profile. If another profile of this name is already present, this method is intended to do nothing and return null.

Parameters:

name - The name, that the caller wants for the new profile. If null, the implementation should create a name.

type - The type, that the caller wants to assign the profile. Possible values chosen by personalisation implementation

Returns:

The created user profile. null, if a name provided was already used for an existing profile.

Throws:

WGAPIException

queryUserProfileNames

java.util.List<java.lang.String> queryUserProfileNames(java.lang.String type,
                                                     java.lang.String query,
                                                     java.util.Map params)
                                                       throws WGAPIException

Queries a user profile database for stored profiles, based on their data. The query syntax is up to the profile database implementation.

Parameters:

type - Type of query. WGAPI implementations may define different profile query types.

query - Query to use for searching user profiles

params - Parameters for the query.

Returns:

A list of profile names, whose profile data match the query

Throws:

WGQueryException

WGAPIException

getAllUserProfileNames

java.util.Iterator<java.lang.String> getAllUserProfileNames()
                                                            throws WGAPIException

Returns the names of all user profiles stored inthe database

Throws:

WGAPIException