com.plumtree.portalpages.browsing.objectselection
Interface IObjectSelectionModelHelper

All Known Implementing Classes:

CommunitySelectionModelHelper, PortletInBundleSelectionModelHelper, PortletSelectionModelHelper

public interface IObjectSelectionModelHelper

Author:

michaeld

Method Summary

void	AddFormInputsForEachObject(XPHashtable htFormData, IASQueryResult asqr, int nObjectViewIndex) Add a unique input to the form input hash table.
int	Get508SearchStringMsgIndex(int nSearch508StringIndex)
XPSortedDictionary	GetDoNotShowObjectIDs(ObjectSelectionModel model, int nObjectViewIndex) Get object IDs of object not to show in the object selection.
java.lang.String[]	GetHeaders(int nObjectViewIndex) Returns the strings for the headers.
int	GetNumObjectViews() Returns the number of object views this model must display.
java.lang.String	GetObjectBannerTitle(java.lang.String strCurrentFolderName, int nObjectViewIndex) Get the banner title for the object banner.
java.lang.String	GetObjectInputName(int nObjectViewIndex) Gets the object input name
IPTObjectManager	GetObjectMan(IPTSession ptSession, int nObjectViewIndex) Gets the an object manager.
IASQueryResult	GetObjects(IPTSession ptSession, IPTAdminFolder ptFolder) Gets a queryresult of the objects to display.
int	GetObjectType(int nObjectViewIndex) Gets the object type.
int	GetPropIDsToQuery(int nObjectViewIndex) Gets the property IDs to query for.
java.lang.Object[][]	GetQueryFilter(ObjectSelectionModel model, int nObjectViewIndex) Get query filter to use when query for selectable objects.
Redirect	GetRedirectAfterFinish(ObjectSelectionModel model) Get the redirect for after the editor has finished.
java.lang.String	GetSearchHeaderTitle() Get the title for the search header.
java.lang.Object[]	GetSelectedInfo(int nIndex, IASQueryResult asqr) Gets the information to store in the selected dictionary.
java.lang.Object[][]	GetSelectedObjects(ObjectSelectionModel model) Get the selected objects
boolean	GetShouldSavePage() Returns whether the model should save the page on repost.
boolean	GetStartInSearch() Returns whether the object selection page should start in search mode.
void	InitializeFormInputs(XPHashtable htFormData) Initialize the form input hash table.
void	SetSelectedObjects(ObjectSelectionModel model, XPSortedDictionary xpsdOldSelectedObjects, XPSortedDictionary xpsdNewSelectedObjects) Set the selected objects.

Method Detail

AddFormInputsForEachObject

void AddFormInputsForEachObject(XPHashtable htFormData,
                                IASQueryResult asqr,
                                int nObjectViewIndex)

Add a unique input to the form input hash table.

Parameters:

htFormData -

IASQueryResult - asqr

itn - nObjectViewIndex

GetDoNotShowObjectIDs

XPSortedDictionary GetDoNotShowObjectIDs(ObjectSelectionModel model,
                                         int nObjectViewIndex)

Get object IDs of object not to show in the object selection.

Parameters:

ObjectSelectionModel - model

int - nObjectViewIndex

Returns:

XPSortedDictionary

GetHeaders

java.lang.String[] GetHeaders(int nObjectViewIndex)

Returns the strings for the headers.

Parameters:

int - nObjectViewIndex

Returns:

String[]

GetNumObjectViews

int GetNumObjectViews()

Returns the number of object views this model must display.

Returns:

int

GetObjectBannerTitle

java.lang.String GetObjectBannerTitle(java.lang.String strCurrentFolderName,
                                      int nObjectViewIndex)

Get the banner title for the object banner.

Parameters:

String - strCurrentFolderName

int - nObjectViewIndex

Returns:

String

GetObjectInputName

java.lang.String GetObjectInputName(int nObjectViewIndex)

Gets the object input name

Parameters:

int - nObjectViewIndex

Returns:

String strObjectInputName

GetObjectMan

IPTObjectManager GetObjectMan(IPTSession ptSession,
                              int nObjectViewIndex)

Gets the an object manager.

Parameters:

IPTSession - ptSession

int - nObjectViewIndex

Returns:

IPTObjectManager

GetObjectType

int GetObjectType(int nObjectViewIndex)

Gets the object type.

Parameters:

int - nObjectViewIndex

Returns:

int nObjectType

GetObjects

IASQueryResult GetObjects(IPTSession ptSession,
                          IPTAdminFolder ptFolder)

Gets a queryresult of the objects to display. Used instead of IPTObjectManager GetObjects when displaying non managed objects.

Parameters:

IPTSession - ptSession

IPTAdminFolder - ptFolder

Returns:

ASQueryResult

GetPropIDsToQuery

int GetPropIDsToQuery(int nObjectViewIndex)

Gets the property IDs to query for.

Parameters:

int - nObjectViewIndex

Returns:

int nPropIDs

GetQueryFilter

java.lang.Object[][] GetQueryFilter(ObjectSelectionModel model,
                                    int nObjectViewIndex)

Get query filter to use when query for selectable objects. The use of the first column of thise array, [0][0] - [2][0], is reserved for use by ObjectSelectionModel. Start adding filters to the array at [0][1] - [2][1].

Parameters:

ObjectSelectionModel - model

int - nObjectViewIndex

Returns:

Object[][] oQueryFilter

GetRedirectAfterFinish

Redirect GetRedirectAfterFinish(ObjectSelectionModel model)

Get the redirect for after the editor has finished.

Parameters:

ObjectSelectionModel - model

int - nObjectViewIndex

Returns:

Redirect

GetSearchHeaderTitle

java.lang.String GetSearchHeaderTitle()

Get the title for the search header.

Returns:

String

GetSelectedInfo

java.lang.Object[] GetSelectedInfo(int nIndex,
                                   IASQueryResult asqr)

Gets the information to store in the selected dictionary.

Parameters:

nIndex -

ASQueryResult -

Returns:

Object[]

GetSelectedObjects

java.lang.Object[][] GetSelectedObjects(ObjectSelectionModel model)

Get the selected objects

Parameters:

ObjectSelectionModel - model

Returns:

Object[][]

GetShouldSavePage

boolean GetShouldSavePage()

Returns whether the model should save the page on repost. Currently only community pages returns false.

Returns:

boolean

GetStartInSearch

boolean GetStartInSearch()

Returns whether the object selection page should start in search mode.

Returns:

boolean

InitializeFormInputs

void InitializeFormInputs(XPHashtable htFormData)

Initialize the form input hash table.

Parameters:

htFormData -

SetSelectedObjects

void SetSelectedObjects(ObjectSelectionModel model,
                        XPSortedDictionary xpsdOldSelectedObjects,
                        XPSortedDictionary xpsdNewSelectedObjects)

Set the selected objects. This may involve in sending them to a parent editor to be set, or actually setting them here.

Parameters:

ObjectSelectionModel - model

xpsdOldSelectedObjects - xpsdOldSelectedObjects

xpsdNewSelectedObjects - xpsdNewSelectedObjects

Get508SearchStringMsgIndex

int Get508SearchStringMsgIndex(int nSearch508StringIndex)

Parameters:

nSearch508StringIndex - is the index of the message files index

Returns:

the index of the string in the message file from the index passed in