com.plumtree.server
Interface IPTGadgetInfo


public interface IPTGadgetInfo

IPTGadgetInfo


Method Summary
 void AddCommunitySetting(java.lang.String strCommunitySetting, double dValue)
          Add a community setting (preference) to the community that the current page is part of.
 void AddCommunitySetting(java.lang.String strCommunitySetting, int nValue)
          Add a community setting (preference) to the community that the current page is part of.
 void AddCommunitySetting(java.lang.String strCommunitySetting, java.lang.Object objValue)
          Add a community setting (preference) to the community that the current page is part of.
 void AddCommunitySetting(java.lang.String strCommunitySetting, java.lang.String strValue)
          Add a community setting (preference) to the community that the current page is part of.
 void AddCommunitySetting(java.lang.String strCommunitySetting, com.plumtree.openfoundation.util.XPDateTime dtValue)
          Add a community setting (preference) to the community that the current page is part of.
 void AddPersonalSetting(java.lang.String strPersonalSetting, double dValue)
          Add a personal setting (preference) for the current user.
 void AddPersonalSetting(java.lang.String strPersonalSetting, int nValue)
          Add a personal setting (preference) for the current user.
 void AddPersonalSetting(java.lang.String strPersonalSetting, java.lang.Object objValue)
          Add a personal setting (preference) for the current user.
 void AddPersonalSetting(java.lang.String strPersonalSetting, java.lang.String strValue)
          Add a personal setting (preference) for the current user.
 void AddPersonalSetting(java.lang.String strPersonalSetting, com.plumtree.openfoundation.util.XPDateTime dtValue)
          Add a personal setting (preference) for the current user.
 void AssignCommunityGadgetSettings(java.lang.Object[][] arrSettings)
          Assign a list of community-gadget settings (preferences) to the combination of the community that the current page is part of the gadget represented.
 void AssignCommunityGadgetSettingsEx(java.lang.Object[][] arrSettings, boolean bDeletePrefs)
          Assign a list of community-gadget settings (preferences) to the combination of the community that the current page is part of and gadget represented.
 void AssignGadgetSettings(java.lang.Object[][] arrSettings)
          Assign a list of user-gadget settings (preferences) to the combination the gadget represented and the current user.
 void AssignGadgetSettingsEx(java.lang.Object[][] arrSettings, boolean bDeletePrefs)
          Assign a list of user-gadget settings (preferences) to the combination of the gadget represented and the current user.
 int GetClassID()
          Get the class id for the gadget represented
 int GetCommunityID()
          Get the community id of the community that the current gadget is from.
 int GetObjectID()
          Get the object id of the gadget represented
 int GetPageID()
          Get the Page ID of the page that this IPTGadgetInfo is from.
 java.lang.Object GetPlumtreeSetting(int nSettingID)
          Get Plumtree setting for the gadget represented.
 java.lang.Object[][] LookupAdminGadgetSettings(java.lang.Object arrSettings)
          Look up admin-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented.
 java.lang.Object[][] LookupAdminGadgetSettings(java.lang.String strSetting)
          Look up an admin-gadget setting (preference) for the combination of the community that the current page is part of and the gadget represented.
 java.lang.Object[][] LookupAdminGadgetSettings(java.lang.String[] arrSettings)
          Look up admin-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented.
 java.lang.Object[][] LookupCommunityGadgetSettings(java.lang.Object arrSettings)
          Look up community-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented.
 java.lang.Object[][] LookupCommunityGadgetSettings(java.lang.String strSetting)
          Look up a community-gadget setting (preference) for the combination of the community that the current page is part of and the gadget represented.
 java.lang.Object[][] LookupCommunityGadgetSettings(java.lang.String[] arrSettings)
          Look up community-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented.
 java.lang.Object[][] LookupCommunitySettings(java.lang.Object arrSettings)
          Look up community settings (preferences) for the community that the current page is part of.
 java.lang.Object[][] LookupCommunitySettings(java.lang.String strSetting)
          Look up one community setting (preference) for the community that the current page is part of.
 java.lang.Object[][] LookupCommunitySettings(java.lang.String[] arrSettings)
          Look up community settings (preferences) for the community that the current page belongs to.
 java.lang.Object[][] LookupGadgetSettings(java.lang.Object arrSettings)
          Look up a list of user-gadget settings (preferences) for the combination the gadget represented and the current user.
 java.lang.Object[][] LookupGadgetSettings(java.lang.String strSetting)
          Look up one user-gadget setting (preference) for the combination of a particular gadget and the current user.
 java.lang.Object[][] LookupGadgetSettings(java.lang.String[] arrSettings)
          Look up a list of user-gadget settings (preferences) for the combination of the gadget represented and the current user.
 java.lang.Object[][] LookupPersonalSettings(java.lang.Object arrSettings)
          Look up a list of personal settings (preferences) for the current user.
 java.lang.Object[][] LookupPersonalSettings(java.lang.String strSetting)
          Look up one personal setting (preference) for the current user.
 java.lang.Object[][] LookupPersonalSettings(java.lang.String[] arrSettings)
          Look up a list of personal settings (preferences) for the current user.
 void RemoveCommunityGadgetSetting(java.lang.String strCommunitySetting)
          Remove a community-gadget setting (preference) from the combination of the community that the current page is part of and the gadget represented.
 void RemoveCommunitySetting(java.lang.String strCommunitySetting)
          Remove a community setting (preference) for the community that the current page is part of.
 void RemoveGadgetSetting(java.lang.String strSetting)
          Remove a user-gadget setting (preference) for the combination of a the gadget represented and the current user.
 void RemovePersonalSetting(java.lang.String strPersonalSetting)
          Remove a personal setting (preference) for the current user.
 

Method Detail

LookupGadgetSettings

public java.lang.Object[][] LookupGadgetSettings(java.lang.String[] arrSettings)
Look up a list of user-gadget settings (preferences) for the combination of the gadget represented and the current user.
Parameters:
arrSettings - - array of setting names that are desired
Returns:
Object[][] - array of names and corresponding values Object[name(0) or value{1)][index]

LookupGadgetSettings

public java.lang.Object[][] LookupGadgetSettings(java.lang.String strSetting)
Look up one user-gadget setting (preference) for the combination of a particular gadget and the current user.
Parameters:
strSetting - - setting name that is desired
Returns:
Object[][] - array of name and corresponding value Object[0][0] = setting name Object[1][0] = setting value

LookupGadgetSettings

public java.lang.Object[][] LookupGadgetSettings(java.lang.Object arrSettings)
Look up a list of user-gadget settings (preferences) for the combination the gadget represented and the current user.
Parameters:
arrSettings - - array of setting names that are desired
Returns:
Object[][] - array of names and corresponding values Object[name(0) or value{1)][index] This function is being considered for removal.

AssignGadgetSettings

public void AssignGadgetSettings(java.lang.Object[][] arrSettings)
Assign a list of user-gadget settings (preferences) to the combination the gadget represented and the current user. Calling this function will delete all the old settings for this gadget and user.
Parameters:
arrSettings - - array of names and corresponding values to be set on the gadget. Object[name(0) or value(1)][index]

LookupPersonalSettings

public java.lang.Object[][] LookupPersonalSettings(java.lang.String[] arrSettings)
Look up a list of personal settings (preferences) for the current user.
Parameters:
arrSettings - - array of setting names that are desired
Returns:
Object[][] - array of names and corresponding values Object[name(0) or value(1)][index]

LookupPersonalSettings

public java.lang.Object[][] LookupPersonalSettings(java.lang.String strSetting)
Look up one personal setting (preference) for the current user.
Parameters:
strSetting - - setting name that is desired
Returns:
Object[][] - array of name and corresponding value Object[0][0] = setting name Object[1][0] = setting value

LookupPersonalSettings

public java.lang.Object[][] LookupPersonalSettings(java.lang.Object arrSettings)
Look up a list of personal settings (preferences) for the current user.
Parameters:
arrSettings - - array of setting names that are desired
Returns:
Object[][] - array of names and corresponding values Object[name(0) or value(1)][index]\ This function is being considered for removal.

AddPersonalSetting

public void AddPersonalSetting(java.lang.String strPersonalSetting,
                               int nValue)
Add a personal setting (preference) for the current user.
Parameters:
strPersonalSetting - - name of the setting
nValue - - int value of the setting

AddPersonalSetting

public void AddPersonalSetting(java.lang.String strPersonalSetting,
                               java.lang.String strValue)
Add a personal setting (preference) for the current user.
Parameters:
strPersonalSetting - - name of the setting
strValue - - string value of the setting

AddPersonalSetting

public void AddPersonalSetting(java.lang.String strPersonalSetting,
                               com.plumtree.openfoundation.util.XPDateTime dtValue)
Add a personal setting (preference) for the current user.
Parameters:
strPersonalSetting - - name of the setting
dtValue - - XPDateTime value of the setting

AddPersonalSetting

public void AddPersonalSetting(java.lang.String strPersonalSetting,
                               double dValue)
Add a personal setting (preference) for the current user.
Parameters:
strPersonalSetting - - name of the setting
dValue - - double value of the setting

AddPersonalSetting

public void AddPersonalSetting(java.lang.String strPersonalSetting,
                               java.lang.Object objValue)
Add a personal setting (preference) for the current user.
Parameters:
strPersonalSetting - - name of the setting
objValue - - object value of the setting This function is being considered for removal.

RemovePersonalSetting

public void RemovePersonalSetting(java.lang.String strPersonalSetting)
Remove a personal setting (preference) for the current user.
Parameters:
strPersonalSetting - - name of the setting to be removed

LookupCommunitySettings

public java.lang.Object[][] LookupCommunitySettings(java.lang.String[] arrSettings)
Look up community settings (preferences) for the community that the current page belongs to. Throws an exception if the current page is a my page.
Parameters:
arrSettings - - array of setting names that are desired
Returns:
Object[][] - array of names and corresponding values Object[name(0) or value{1)][index]

LookupCommunitySettings

public java.lang.Object[][] LookupCommunitySettings(java.lang.String strSetting)
Look up one community setting (preference) for the community that the current page is part of. Throws an exception if the current page is a my page.
Parameters:
strSetting - - setting name that is desired
Returns:
Object[][] - array of name and corresponding value Object[0][0] = setting name Object[1][0] = setting value

LookupCommunitySettings

public java.lang.Object[][] LookupCommunitySettings(java.lang.Object arrSettings)
Look up community settings (preferences) for the community that the current page is part of. Throws an exception if the current page is a my page.
Parameters:
arrSettings - - array of setting names that are desired
Returns:
Object[][] - array of names and corresponding values Object[name(0) or value{1)][index] This function is being considered for removal.

AddCommunitySetting

public void AddCommunitySetting(java.lang.String strCommunitySetting,
                                int nValue)
Add a community setting (preference) to the community that the current page is part of. Throws an exception if the current page is a my page.
Parameters:
strCommunitySetting - - name of the setting
nValue - - string value of the setting

AddCommunitySetting

public void AddCommunitySetting(java.lang.String strCommunitySetting,
                                java.lang.String strValue)
Add a community setting (preference) to the community that the current page is part of. Throws an exception if the current page is a my page.
Parameters:
strCommunitySetting - - name of the setting
strValue - - string value of the setting

AddCommunitySetting

public void AddCommunitySetting(java.lang.String strCommunitySetting,
                                com.plumtree.openfoundation.util.XPDateTime dtValue)
Add a community setting (preference) to the community that the current page is part of. Throws an exception if the current page is a my page.
Parameters:
strCommunitySetting - - name of the setting
dtValue - - XPDateTime value of the setting

AddCommunitySetting

public void AddCommunitySetting(java.lang.String strCommunitySetting,
                                double dValue)
Add a community setting (preference) to the community that the current page is part of. Throws an exception if the current page is a my page.
Parameters:
strCommunitySetting - - name of the setting
dValue - - double value of the setting

AddCommunitySetting

public void AddCommunitySetting(java.lang.String strCommunitySetting,
                                java.lang.Object objValue)
Add a community setting (preference) to the community that the current page is part of. Throws an exception if the current page is a my page.
Parameters:
strCommunitySetting - - name of the setting
objValue - - object value of the setting This function is being considered for removal.

RemoveCommunitySetting

public void RemoveCommunitySetting(java.lang.String strCommunitySetting)
Remove a community setting (preference) for the community that the current page is part of. Throws an exception if the current page is a my page.
Parameters:
strCommunitySetting - - name of the setting to be removed

LookupCommunityGadgetSettings

public java.lang.Object[][] LookupCommunityGadgetSettings(java.lang.String[] arrSettings)
Look up community-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented. Throws an exception if the current page is a my page.
Parameters:
arrSettings - - array of setting names that are desired
Returns:
Object[][] - array of names and corresponding values Object[name(0) or value{1)][index]

LookupCommunityGadgetSettings

public java.lang.Object[][] LookupCommunityGadgetSettings(java.lang.String strSetting)
Look up a community-gadget setting (preference) for the combination of the community that the current page is part of and the gadget represented. Throws an exception if the current page is a my page.
Parameters:
strSetting - - name of the setting name that is desired
Returns:
Object[][] - array of name and corresponding value Object[0][0] = setting name Object[1][0] = setting value

LookupCommunityGadgetSettings

public java.lang.Object[][] LookupCommunityGadgetSettings(java.lang.Object arrSettings)
Look up community-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented. Throws an exception if the current page is a my page.
Parameters:
arrSettings - - array of the setting names that are desired
Returns:
Object[][] - array of names and corresponding values Object[name(0) or value{1)][index] This function is being considered for removal.

AssignCommunityGadgetSettings

public void AssignCommunityGadgetSettings(java.lang.Object[][] arrSettings)
Assign a list of community-gadget settings (preferences) to the combination of the community that the current page is part of the gadget represented. Calling this function will delete all the old settings for this community-gadget combination. Throws an exception if the current page is a my page.
Parameters:
arrSettings - - array of the names and corresponding values to be assigned to the community-gadget combination.

LookupAdminGadgetSettings

public java.lang.Object[][] LookupAdminGadgetSettings(java.lang.String[] arrSettings)
Look up admin-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented.
Parameters:
arrSettings - - array of the names and corresponding values to be assigned to the community-gadget combination.
Returns:
Object[][] - array of names and corresponding values Object[name(0) or value{1)][index]

LookupAdminGadgetSettings

public java.lang.Object[][] LookupAdminGadgetSettings(java.lang.String strSetting)
Look up an admin-gadget setting (preference) for the combination of the community that the current page is part of and the gadget represented.
Parameters:
strSetting - - name of the setting name that is desired
Returns:
Object[][] - array of name and corresponding value Object[0][0] = setting name Object[1][0] = setting value

LookupAdminGadgetSettings

public java.lang.Object[][] LookupAdminGadgetSettings(java.lang.Object arrSettings)
Look up admin-gadget settings (preferences) for the combination of the community that the current page is part of and the gadget represented.
Parameters:
arrSettings - - array of the names and corresponding values to be assigned to the community-gadget combination.
Returns:
Object[][] - array of names and corresponding values Object[name(0) or value{1)][index]

AssignCommunityGadgetSettingsEx

public void AssignCommunityGadgetSettingsEx(java.lang.Object[][] arrSettings,
                                            boolean bDeletePrefs)
Assign a list of community-gadget settings (preferences) to the combination of the community that the current page is part of and gadget represented. Throws an exception if the current page is a my page.
Parameters:
arrSettings - - array of the names and corresponding values to be assigned to the community-gadget combination.
bDeletePrefs - - boolean that will delete the old settings for this community-gadget combination or append the new list to the old settings

RemoveCommunityGadgetSetting

public void RemoveCommunityGadgetSetting(java.lang.String strCommunitySetting)
Remove a community-gadget setting (preference) from the combination of the community that the current page is part of and the gadget represented. Throws an exception if the current page is a my page.
Parameters:
strCommunitySetting - - name of the setting to be removed

AssignGadgetSettingsEx

public void AssignGadgetSettingsEx(java.lang.Object[][] arrSettings,
                                   boolean bDeletePrefs)
Assign a list of user-gadget settings (preferences) to the combination of the gadget represented and the current user.
Parameters:
arrSettings - - array of names and corresponding values to be set on the gadget. Object[name(0) or value(1)][index]
bDeletePrefs - - boolean that will delete the old settings for this user-gadget combination or append the new list to the old settings

RemoveGadgetSetting

public void RemoveGadgetSetting(java.lang.String strSetting)
Remove a user-gadget setting (preference) for the combination of a the gadget represented and the current user.
Parameters:
strSetting - - name of the setting to be removed

GetObjectID

public int GetObjectID()
Get the object id of the gadget represented
Returns:
int - object id

GetClassID

public int GetClassID()
Get the class id for the gadget represented
Returns:
int - class id

GetPageID

public int GetPageID()
Get the Page ID of the page that this IPTGadgetInfo is from.
Returns:
int - page id

GetCommunityID

public int GetCommunityID()
Get the community id of the community that the current gadget is from. Returns 0 if the current page is a my page.
Returns:
int - community id

GetPlumtreeSetting

public java.lang.Object GetPlumtreeSetting(int nSettingID)
Get Plumtree setting for the gadget represented.
Parameters:
nSettingID - - setting id, from PT_GADGETINFO_SETTINGS
Returns:
Object - object value of the setting


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.