com.plumtree.portalpages.portlets.userprofile.eoddisplay
Class EODPortletModel

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

public class EODPortletModel
extends IntrinsicPortletModel
implements IEODPortletModelRO

Author:
jennifersu

Field Summary
static int DATA_INDEX_PROFILEPAGEID
           
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
EODPortletModel()
           
 
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.Object[] GetData()
           
 java.lang.String GetName()
          Return the name of the MVC object.
 java.lang.String GetNameFromObjectID(int nClassID, int nObjectID)
          Returns the name for an object
 java.lang.Object GetNewTempData()
          This method returns a new temporary data object.
protected  IASQueryResult GetObjectPropData(IPTObjectProperties _ptObjProp)
          Return object property non-reference data
protected  IASQueryResult GetObjectPropRefData(IPTObjectProperties _ptObjProp)
          Return object property reference data
 java.lang.String GetPortletDescription()
           
 java.lang.String GetPortletName()
           
 int GetProfileID()
           
 IPTProfilePage GetProfilePage()
           
 java.lang.String GetTitle()
           
 boolean OnCommunityPage()
          Check if the portlet is located in a community.
 XPHashtable PutUserPropertiesIntoHashtable(int _profileUserID)
           
 
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

DATA_INDEX_PROFILEPAGEID

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

EODPortletModel

public EODPortletModel()
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

GetData

public java.lang.Object[] GetData()
Specified by:
GetData in interface IEODPortletModelRO
Returns:
Throws:
XPException

PutUserPropertiesIntoHashtable

public XPHashtable PutUserPropertiesIntoHashtable(int _profileUserID)
Specified by:
PutUserPropertiesIntoHashtable in interface IEODPortletModelRO
Returns:

GetObjectPropData

protected IASQueryResult GetObjectPropData(IPTObjectProperties _ptObjProp)
Return object property non-reference data

Parameters:
_ptObjProp - IPTObjectProperties
Returns:
Data in query result
Throws:
XPException

GetObjectPropRefData

protected IASQueryResult GetObjectPropRefData(IPTObjectProperties _ptObjProp)
Return object property reference data

Parameters:
_ptObjProp - IPTObjectProperties
Returns:
Data in query result
Throws:
XPException

GetProfilePage

public IPTProfilePage GetProfilePage()
Specified by:
GetProfilePage in interface IEODPortletModelRO
Returns:

GetProfileID

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

GetCurrentUser

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

GetPortletName

public java.lang.String GetPortletName()
Specified by:
GetPortletName in interface IEODPortletModelRO
Returns:

GetPortletDescription

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

GetTitle

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

OnCommunityPage

public boolean OnCommunityPage()
Check if the portlet is located in a community. If not, it should display an error message.

Specified by:
OnCommunityPage in interface IEODPortletModelRO
Returns:

GetNameFromObjectID

public java.lang.String GetNameFromObjectID(int nClassID,
                                            int nObjectID)
Returns the name for an object

Specified by:
GetNameFromObjectID in interface IEODPortletModelRO
Parameters:
nClassID - Class ID of object
nObjectID - Object ID of object
Returns:
Name of object.



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