com.plumtree.portalpages.portlets.userprofile.folders
Class FoldersPortletModel

java.lang.Object
  extended by com.plumtree.uiinfrastructure.activityspace.AClearModel
      extended by com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletModel
          extended by com.plumtree.portalpages.portlets.userprofile.folders.FoldersPortletModel
All Implemented Interfaces:
IFoldersPortletModelRO, IIntrinsicPortletModelRO, IManagedObject, IModel, IModelRO, IMVCObject

public class FoldersPortletModel
extends IntrinsicPortletModel
implements IFoldersPortletModelRO

Author:
jennifersu

Field Summary
static int NO_PROFILE_USER
           
static java.lang.String STR_MVC_CLASS_NAME
          Class name for the model
 
Fields inherited from class com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletModel
m_asOwner, m_nContainerClassID, m_nContainerObjectID, m_nPageID, m_nPortletID, m_nPrefType, m_ptAppDataState, m_ptPortlet, m_ptSession, PREF_TYPE_ADMIN, PREF_TYPE_COMMUNITY, PREF_TYPE_PERSONAL, SETTINGSTYPE_ADMIN, SETTINGSTYPE_COMMUNITY, SETTINGSTYPE_COMMUNITYPORTLET, SETTINGSTYPE_PORTLET, SETTINGSTYPE_USER
 
Constructor Summary
FoldersPortletModel()
           
 
Method Summary
 boolean ControlExists()
          Returns true if the portlet has a control associated with it.
 java.lang.Object Create()
          This method is used by the ASManager to return new instances of managed objects.
 int GetCurrentUser()
           
 java.lang.String GetName()
          Return the name of the MVC object.
 java.lang.Object GetNewTempData()
          This method returns a new temporary data object.
 java.lang.String GetPortletDescription()
           
 int GetProfileID()
           
 IPTSearchResponse GetSearchResults(int profileUserID)
          This method uses the Plumtree search API and searches all folders that a user is a expert or content manager of.
 java.lang.String GetTitle()
           
 java.lang.String GetUserRoles(IPTSearchResponse searchResponse, int index, int iCurrentUser)
          This method determines what roles the user is a member of and obtains the approriate text to be displayed in the introspective portlet.
 
Methods inherited from class com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletModel
CleanupAllData, CleanupTempData, GetPortletID, GetSettingValue, GetSettingValues, Init, InitPortlet, IsIntrinsicPortlet
 
Methods inherited from class com.plumtree.uiinfrastructure.activityspace.AClearModel
GetTempData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.plumtree.portaluiinfrastructure.intrinsicportlets.IIntrinsicPortletModelRO
GetPortletID
 

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME
Class name for the model

See Also:
Constant Field Values

NO_PROFILE_USER

public static final int NO_PROFILE_USER
See Also:
Constant Field Values
Constructor Detail

FoldersPortletModel

public FoldersPortletModel()
Method Detail

ControlExists

public boolean ControlExists()
Description copied from class: IntrinsicPortletModel
Returns true if the portlet has a control associated with it. This function should be implemented by the child class.

Specified by:
ControlExists in interface IIntrinsicPortletModelRO
Specified by:
ControlExists in class IntrinsicPortletModel
Returns:
Returns true if portlet has control. Otherwise return false.
See Also:
IIntrinsicPortletModelRO.ControlExists()

GetName

public java.lang.String GetName()
Description copied from interface: IMVCObject
Return the name of the MVC object.

Specified by:
GetName in interface IMVCObject
Specified by:
GetName in class IntrinsicPortletModel
Returns:
the name of the object.
See Also:
IMVCObject.GetName()

Create

public java.lang.Object Create()
Description copied from class: AClearModel
This method is used by the ASManager to return new instances of managed objects.

Specified by:
Create in interface IManagedObject
Specified by:
Create in class AClearModel
Returns:
A new instance of the managed class (i.e. return new Foo();)

GetNewTempData

public java.lang.Object GetNewTempData()
Description copied from class: AClearModel
This method returns a new temporary data object. It is called at the beginning of a new HTTP Request. This method can perform initialization on the data object if necessary.

Specified by:
GetNewTempData in class AClearModel
Returns:
Object the new temporary data object

GetUserRoles

public java.lang.String GetUserRoles(IPTSearchResponse searchResponse,
                                     int index,
                                     int iCurrentUser)
This method determines what roles the user is a member of and obtains the approriate text to be displayed in the introspective portlet.

Specified by:
GetUserRoles in interface IFoldersPortletModelRO
Parameters:
searchResponse - the search results for the user
index - the current index in the search results
iCurrentUser - the current user id
Returns:
String the display string for the cell

GetSearchResults

public IPTSearchResponse GetSearchResults(int profileUserID)
This method uses the Plumtree search API and searches all folders that a user is a expert or content manager of.

Specified by:
GetSearchResults in interface IFoldersPortletModelRO
Parameters:
ptSession - a valid plumtree session
profileUserID - the profile user id that will be used to search information on.
Returns:
IPTSearchResponse

GetProfileID

public int GetProfileID()
Specified by:
GetProfileID in interface IFoldersPortletModelRO
Returns:

GetCurrentUser

public int GetCurrentUser()
Specified by:
GetCurrentUser in interface IFoldersPortletModelRO
Returns:

GetTitle

public java.lang.String GetTitle()
Specified by:
GetTitle in interface IFoldersPortletModelRO
Returns:
See Also:
com.plumtree.xpportlets.expatriate.ext.introspective.IProfilePortlet#getTitle()

GetPortletDescription

public java.lang.String GetPortletDescription()
Specified by:
GetPortletDescription in interface IFoldersPortletModelRO



Copyright 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.