com.plumtree.portalpages.portlets.userprofile.infrastructure
Interface IProfileTable

public interface IProfileTable

Describes the methods required to be an Introspective User Profile Portlet. Examples of these portlets may include "Documents Submitted," "Folders Created," "Gadgets Created," etc.

Author:

chrisb

Method Summary

java.lang.String	GetDescription() Returns the portlet's description.
IProfileRow	GetHeaderRow() Optionally returns a "header" row.
int	GetNumProfileRows() Returns the number of ProfileRow objects in the ProfileTable.
IXPEnumerator	GetProfileRows(int profileUserID, java.lang.String profileLogOnToken, int viewingUserID) Returns the ProfileItem objects corresponding to the profile username.
java.lang.String	GetTitle() Returns the portlet's title.
boolean	hasBeenUpdatedSince(XPDateTime lastUpdatedDate) Indicates whether the source content has been updated since the supplied date.

Method Detail

GetDescription

java.lang.String GetDescription()

Returns the portlet's description.

Returns:

The portlet's description.

GetHeaderRow

IProfileRow GetHeaderRow()

Optionally returns a "header" row. This row will be formatted like a header for your ProfileTable. If you don't want to have a ProfileRow that looks like a header, return null.

Returns:

A ProfileRow object to represent the header row of the ProfileTable or null if you don't want a header row.

GetNumProfileRows

int GetNumProfileRows()

Returns the number of ProfileRow objects in the ProfileTable.

Returns:

The number of ProfileRow objects in the ProfileTable.

GetProfileRows

IXPEnumerator GetProfileRows(int profileUserID,
                             java.lang.String profileLogOnToken,
                             int viewingUserID)

Returns the ProfileItem objects corresponding to the profile username. Each ProfileItem represents one row of content (e.g. the name and description of a folder or document created by the profile user).

Parameters:

profileUserID - The ID of the user who's profile is currently being viewed.

profileLogOnToken - The log on token of the user that is being viewed. This is used to search on Plumtree specific information

viewingUserID - The ID of the user who is currently viewing the profile.

Returns:

An XPEnumerator of ProfileItem objects.

GetTitle

java.lang.String GetTitle()

Returns the portlet's title.

Returns:

The Portlet's title.

hasBeenUpdatedSince

boolean hasBeenUpdatedSince(XPDateTime lastUpdatedDate)

Indicates whether the source content has been updated since the supplied date. This method enables the UI to cache the content until it changes. To turn off caching, implement this method always to return true. To use caching, implement this method as a fast way to tell if the content you're supplying has changed since the date passed into this method.

Parameters:

lastUpdatedDate - Indicates the date/time at which the content was last updated.

Returns:

true if the content has been updated; false otherwise.