com.plumtree.portalpages.rest.dojo
Class KDFolderDataStoreModel

java.lang.Object
  com.plumtree.portalpages.rest.ARESTModel
      com.plumtree.portalpages.rest.dojo.KDFolderDataStoreModel

All Implemented Interfaces:

IManagedObject, IModel, IModelRO, IMVCObject

public class KDFolderDataStoreModel
extends ARESTModel
implements IModel

Model to retrieve subfolders in a specific KD folder

Author:

rozhang

Field Summary

static java.lang.String	COL_CHILDREN property to flag that an entry has children
static java.lang.String	COL_FOLDERLEVEL property name for kd folder level (from root level 1)
static java.lang.String	COL_ID
protected AActivitySpace	m_space
static java.lang.String	STR_MVC_CLASS_NAME

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

m_error

Constructor Summary

KDFolderDataStoreModel()

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.
IPTFilter	CreateSubFolderSearchFilter(int nCurrentLevel) Search specific code, not sure why it is needed
IXPList	GetKDSubFolders(int folderId) Returns a list of dojo datastore object representations as a hashtable with properties The property names are synchronized with clientside javascript
IXPList	GetKDSubFoldersForCurrentParentFolder() Wrapper for returning sub folders from set parent folder id
java.lang.String	GetName() Return the name of the MVC object.
int	GetParentFolderId()
void	Init(AActivitySpace parent) This method initializes the model.
void	SetParentFolderId(int folderId)

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

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

COL_FOLDERLEVEL

public static final java.lang.String COL_FOLDERLEVEL

property name for kd folder level (from root level 1)

See Also:

Constant Field Values

COL_CHILDREN

public static final java.lang.String COL_CHILDREN

property to flag that an entry has children

See Also:

Constant Field Values

COL_ID

public static final java.lang.String COL_ID

See Also:

Constant Field Values

m_space

protected AActivitySpace m_space

Constructor Detail

KDFolderDataStoreModel

public KDFolderDataStoreModel()

Method Detail

GetKDSubFoldersForCurrentParentFolder

public IXPList GetKDSubFoldersForCurrentParentFolder()

Wrapper for returning sub folders from set parent folder id

Returns:

null if invalid/no parent folder id was set

GetKDSubFolders

public IXPList GetKDSubFolders(int folderId)

Returns a list of dojo datastore object representations as a hashtable with properties The property names are synchronized with clientside javascript

Parameters:

folderId -

Returns:

CreateSubFolderSearchFilter

public IPTFilter CreateSubFolderSearchFilter(int nCurrentLevel)

Search specific code, not sure why it is needed

Parameters:

nCurrentLevel -

Returns:

SetParentFolderId

public void SetParentFolderId(int folderId)

GetParentFolderId

public int GetParentFolderId()

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

See Also:

IModel.CleanupAllData()

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

See Also:

IModel.CleanupTempData()

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

See Also:

IModel.Init(com.plumtree.uiinfrastructure.activityspace.AActivitySpace)

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.

See Also:

IMVCObject.GetName()

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();)

See Also:

IManagedObject.Create()