|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
This object caches the user specific items on the IPTSession (specifically, on its InternalSession). The methods on this interface access cached information that might otherwise be expensive to query from the database every time.
| Method Summary | |
void |
AddPersonalSetting(java.lang.String strPersonalSetting,
double dValue)
Adds a preference for the current user. |
void |
AddPersonalSetting(java.lang.String strPersonalSetting,
float fValue)
Adds a preference for the current user. |
void |
AddPersonalSetting(java.lang.String strPersonalSetting,
int iValue)
Adds a preference for the current user. |
void |
AddPersonalSetting(java.lang.String strPersonalSetting,
java.lang.Object oValue)
Adds a preference for the current user. |
void |
AddPersonalSetting(java.lang.String strPersonalSetting,
java.lang.String strValue)
Adds a preference for the current user. |
void |
AddPersonalSetting(java.lang.String strPersonalSetting,
com.plumtree.openfoundation.util.XPDateTime ptdtValue)
Adds a preference for the current user. |
boolean |
CheckCurrentUserIsAdmin()
Checks whether the current user is a member of the built-in Administrators group. |
boolean |
CheckForActivityRight(int iActivityID)
Checks whether the current user has the specified activity right. |
boolean |
CheckForActivityRight(java.lang.String strActivityURI)
Checks whether the current user has the specified activity right. |
int |
CheckGadgetAccess(int nGadgetID)
Retrieves the current user's access level to the specified Gadget (Portlet). |
boolean |
CheckPropertySearchRight(int nPropertyID)
Checks whether the current user has rights to search the indicated property. |
int |
CheckWebServiceAccess(int nWebServiceID)
Retrieves the current user's access level to the specified Web Service. |
void |
ClearCurrentActivityRightsCache()
Purges the cache specifying the current user's activity rights. |
void |
ClearCurrentCommunityMembershipCache()
Purges the cache containing current user's community memberships. |
void |
ClearCurrentMyPagesCache()
Purges the cache of the current user's MyPages. |
void |
ClearSearchablePropertyCache()
Purges the cache of searchable properties for the current user. |
java.lang.String |
GetCurrentAuthUniqueName()
Retrieves the current user's auth unique name. |
java.lang.Object |
GetCurrentCollabRoleMemberships()
Retrieves the current user's Collab role memberships. |
IPTQueryResult |
GetCurrentCommunityMembership()
Retrieves the current user's community memberships. |
IPTQueryResult |
GetCurrentMyPages()
Retrieves the MyPages for the current user. |
int |
GetCurrentUserAdminFolderID()
Retrieves the admin folder ID where the current user's User object resides. |
IPTQueryResult |
GetCurrentUserCachedPluggablePages()
Retrieves a cached IPTQueryResult of web services visible to the current user that support one or more of the 3 types of pluggable pages (personal, community, or admin). |
IPTSubPortalInfo |
GetCurrentUserCachedSubPortalInfo()
Retrieves the IPTSubPortalInfo for the current user. |
java.lang.Object |
GetCurrentUserGroupIDs()
Retrieves the current user's group memberships as an array of group IDs. |
int |
GetCurrentUserID()
Retrieves the current user's ID. |
java.lang.String |
GetCurrentUserLoginName()
Retrieves the current user's login name. |
java.lang.String |
GetCurrentUserName()
Retrieves the current user's display name. |
java.lang.Object[][] |
LookupPersonalSettings()
Retrieves the preferences for the current user. |
IPTQueryResult |
QueryActivityRights()
Retrieves the activity rights held by the current user. |
IPTMyPortalGadgetContent |
QueryHeaderAndFooter(java.lang.Object AppDataStateObject,
java.lang.String strUserInterfaceID,
int iMode,
boolean bReturnAllGadgets)
Queries for the header and footer for the current user. |
void |
RemovePersonalSetting(java.lang.String strPersonalSetting)
Removes a preference for the current user. |
| Method Detail |
public int GetCurrentUserID()
public java.lang.String GetCurrentUserName()
public java.lang.Object GetCurrentUserGroupIDs()
public IPTQueryResult GetCurrentCommunityMembership()
public void ClearCurrentCommunityMembershipCache()
public IPTQueryResult GetCurrentMyPages()
public void ClearCurrentMyPagesCache()
public int CheckGadgetAccess(int nGadgetID)
nGadgetID - - The ID of the gadget.public java.lang.String GetCurrentAuthUniqueName()
public java.lang.Object[][] LookupPersonalSettings()
public void AddPersonalSetting(java.lang.String strPersonalSetting,
int iValue)
strPersonalSetting - - The name of the preference to set.iValue - - The value to associated with the above preference.
public void AddPersonalSetting(java.lang.String strPersonalSetting,
java.lang.String strValue)
strPersonalSetting - - The name of the preference to set.strValue - - The value to associated with the above preference.
public void AddPersonalSetting(java.lang.String strPersonalSetting,
com.plumtree.openfoundation.util.XPDateTime ptdtValue)
strPersonalSetting - - The name of the preference to set.ptdtValue - - The value to associated with the above preference.
public void AddPersonalSetting(java.lang.String strPersonalSetting,
float fValue)
strPersonalSetting - - The name of the preference to set.fValue - - The value to associated with the above preference.
public void AddPersonalSetting(java.lang.String strPersonalSetting,
double dValue)
strPersonalSetting - - The name of the preference to set.dValue - - The value to associated with the above preference.
public void AddPersonalSetting(java.lang.String strPersonalSetting,
java.lang.Object oValue)
strPersonalSetting - - The name of the preference to set.oValue - - The value to associated with the above preference.public void RemovePersonalSetting(java.lang.String strPersonalSetting)
public IPTQueryResult QueryActivityRights()
public boolean CheckForActivityRight(int iActivityID)
iActivityID - - The ID of the activity right to check for.public boolean CheckForActivityRight(java.lang.String strActivityURI)
strActivityURI - - The URI of the activity right to check for.
public IPTMyPortalGadgetContent QueryHeaderAndFooter(java.lang.Object AppDataStateObject,
java.lang.String strUserInterfaceID,
int iMode,
boolean bReturnAllGadgets)
AppDataStateObject - - The AppData passed in by the UI.strUserInterfaceID - - The User Interface identifier, can pass null for default user interface.iMode - - The mode, from the PT_GADGET_MODES enumeration.bReturnAllGadgets - - True to return all gadgets, false to return only header and footer.public IPTSubPortalInfo GetCurrentUserCachedSubPortalInfo()
public java.lang.String GetCurrentUserLoginName()
public void ClearCurrentActivityRightsCache()
public int CheckWebServiceAccess(int nWebServiceID)
nWebServiceID - - The ID of the Web Service to check.public IPTQueryResult GetCurrentUserCachedPluggablePages()
public boolean CheckPropertySearchRight(int nPropertyID)
nPropertyID - - The ID of the property for which access is being checked.public void ClearSearchablePropertyCache()
public java.lang.Object GetCurrentCollabRoleMemberships()
public int GetCurrentUserAdminFolderID()
public boolean CheckCurrentUserIsAdmin()
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||