com.plumtree.portalpages.rest.user
Class UserRESTModel

java.lang.Object
  com.plumtree.portalpages.rest.ARESTModel
      com.plumtree.portalpages.rest.user.UserRESTModel

All Implemented Interfaces:

IUserRestModel, IUserRestModelRO, IManagedObject, IModel, IModelRO, IMVCObject

public class UserRESTModel
extends ARESTModel
implements IModel, IUserRestModel

This model manages the user REST API logic.

Field Summary

protected AActivitySpace	m_asOwner
protected int	m_nJoinedCommunityID
protected int	m_nLeftCommunityID
static java.lang.String	STR_MVC_CLASS_NAME

Fields inherited from class com.plumtree.portalpages.rest.ARESTModel

m_error

Constructor Summary

UserRESTModel()

Method Summary

void	CleanupAllData() This method is called when an ActivitySpace is removed from the cache.
void	CleanupTempData() This method is called at the end of every HTTP request by the Interpreter.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
int	GetJoinedCommunityID()
int	GetLeftCommunityID()
java.lang.String	GetName() Return the name of the MVC object.
void	Init(AActivitySpace parent) This method initializes the model.
void	JoinCommunity(int _nCommunityID) Join the specified community.
void	LeaveCommunity(int _nCommunityID) Leave the specified community.

Methods inherited from class com.plumtree.portalpages.rest.ARESTModel

GetError, SetError

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.plumtree.portalpages.rest.user.IUserRestModel

SetError

Methods inherited from interface com.plumtree.portalpages.rest.user.IUserRestModelRO

GetError

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

m_asOwner

protected AActivitySpace m_asOwner

m_nJoinedCommunityID

protected int m_nJoinedCommunityID

m_nLeftCommunityID

protected int m_nLeftCommunityID

Constructor Detail

UserRESTModel

public UserRESTModel()

Method Detail

Init

public void Init(AActivitySpace parent)

Description copied from interface: IModel

This method initializes the model. This is called automatically when AActivitySpace.RegisterModel() is called.

Specified by:

Init in interface IModel

Parameters:

parent - the parent Activity Space

GetName

public java.lang.String GetName()

Description copied from interface: IMVCObject

Return the name of the MVC object.

Specified by:

GetName in interface IMVCObject

Returns:

the name of the object.

Create

public java.lang.Object Create()

Description copied from interface: IManagedObject

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Returns:

A new instance of the managed class (i.e. return new Foo();)

CleanupAllData

public void CleanupAllData()

Description copied from interface: IModel

This method is called when an ActivitySpace is removed from the cache. The Interpreter calls AActivitySpace.CleanupAllData(), which calls this method on all IModels registered using AActivitySpace.RegisterModel(). This method is intended for releasing data stored in the server when the activity space is no longer needed, such as search objects that need to be maintained as long as the user is clicking through the search, but should be freed when the space can no longer be used. This can be used to prevent Java references to COM memory from hanging around in the long lived Java heap without cleaning up the underlying COM memory. The Java reference will still stay in the long lived heap until it gets garbage collected (which could be a while), but the COM memory should get released here. This method will not be called if an HTTPSession times out. CleanupTempData will be called before CleanupAllData.

Specified by:

CleanupAllData in interface IModel

CleanupTempData

public void CleanupTempData()

Description copied from interface: IModel

This method is called at the end of every HTTP request by the Interpreter. The Interpreter calls AActivitySpace.CleanupTempData(), which calls this method on all IModels registered using AActivitySpace.RegisterModel(). This method is intended for cleaning up temporary data that is only used for the lifetime of a single request, like DB query results.

Specified by:

CleanupTempData in interface IModel

JoinCommunity

public void JoinCommunity(int _nCommunityID)

Description copied from interface: IUserRestModel

Join the specified community.

Specified by:

JoinCommunity in interface IUserRestModel

Parameters:

_nCommunityID - the community to join.

LeaveCommunity

public void LeaveCommunity(int _nCommunityID)

Description copied from interface: IUserRestModel

Leave the specified community.

Specified by:

LeaveCommunity in interface IUserRestModel

Parameters:

_nCommunityID - the community to leave.

GetJoinedCommunityID

public int GetJoinedCommunityID()

Specified by:

GetJoinedCommunityID in interface IUserRestModelRO

Returns:

the ID of the community that was joined. -1 if no community was joined.

GetLeftCommunityID

public int GetLeftCommunityID()

Specified by:

GetLeftCommunityID in interface IUserRestModelRO

Returns:

the ID of the community that was left. -1 if no community was left.