com.plumtree.remote.search
Interface ISearchUser

public interface ISearchUser

An interface that provides user-related information to enable the retrieval of results authorized and personalized for the user.

Method Summary

java.lang.String	getLoginToken() Gets the user's login token for authenticating with other portals through the PRC package (com.plumtree.remote.prc).
int	getUserID() Gets the portal user ID.
java.util.Locale	getUserLocale() Gets the user's locale.

Method Detail

getLoginToken

public java.lang.String getLoginToken()

Gets the user's login token for authenticating with other portals through the PRC package (com.plumtree.remote.prc). The endpoint required to create a remote session can be obtained from ISearchContext#getSoapURI. The login token will not be sent unless the checkbox "Send Login token to Portlets" is set on the Advanced Settings page of the Search Web Service Editor. The login token timeout is set on the same editor page.

Returns:

login token

See Also:

RemoteSessionFactory.getTokenContext(java.net.URL endpoint, String loginToken)

getUserID

public int getUserID()

Gets the portal user ID.

Returns:

int user ID

getUserLocale

public java.util.Locale getUserLocale()

Gets the user's locale.

Returns:

user's locale