Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.forum.proxy
Class WatchSettingsManagerProxy

java.lang.Object
  extended by com.jivesoftware.forum.proxy.WatchSettingsManagerProxy
All Implemented Interfaces:
WatchSettingsManager

public class WatchSettingsManagerProxy
extends java.lang.Object
implements WatchSettingsManager

A protection proxy for the WatchSettingsManager class. A proxy has a set of permissions that are specified at creation time of the proxy. Subsequently, those permissions are use to restrict access to protected methods. If a user does not have the right to execute a particular method, an UnauthorizedException is thrown.

See Also:
Permissions, UnauthorizedException

Constructor Summary
WatchSettingsManagerProxy(WatchSettingsManager manager, AuthToken authToken, Permissions permissions)
          Creates a new WatchSettingsManagerProxy object.
 
Method Summary
 void deleteSettings(User user)
          Delete the watch settings for a user
 WatchSettings getSettings(User user)
          Retrieve a watch settings for the given user
 void saveSettings(User user, WatchSettings settings)
          Save the watch settings for a user
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WatchSettingsManagerProxy

public WatchSettingsManagerProxy(WatchSettingsManager manager,
                                 AuthToken authToken,
                                 Permissions permissions)
Creates a new WatchSettingsManagerProxy object.

Parameters:
manager - the watchsettingsmanager to protect by proxy.
authToken - the user's authorization token.
permissions - the permissions to use with this proxy.
Method Detail

getSettings

public WatchSettings getSettings(User user)
Description copied from interface: WatchSettingsManager
Retrieve a watch settings for the given user

Specified by:
getSettings in interface WatchSettingsManager
Parameters:
user - the user to return a watch settings object for
Returns:
a WatchSettings object for the given user

saveSettings

public void saveSettings(User user,
                         WatchSettings settings)
Description copied from interface: WatchSettingsManager
Save the watch settings for a user

Specified by:
saveSettings in interface WatchSettingsManager
Parameters:
user - the user to save the watch settings for
settings - the watch settings to save

deleteSettings

public void deleteSettings(User user)
Description copied from interface: WatchSettingsManager
Delete the watch settings for a user

Specified by:
deleteSettings in interface WatchSettingsManager
Parameters:
user - the user to delete the watch settings for

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.