com.plumtree.portalpages.browsing.objectselection.portlets
Class PortletInBundleSelectionModelHelper

java.lang.Object
  com.plumtree.portalpages.browsing.objectselection.portlets.PortletInBundleSelectionModelHelper

All Implemented Interfaces:

IObjectSelectionModelHelper

public class PortletInBundleSelectionModelHelper
extends java.lang.Object
implements IObjectSelectionModelHelper

Author:

michaeld

Field Summary

static int	COL_GADGET_ALIGNMENT Selected Info Array: Portlet Alignment Column
static int	COL_GADGET_MAX Selected Info Array: Number of Columns
static int	COL_HEADER_BUNDLE_MAX Header Array: Number of Columns for bundle
static int	COL_HEADER_CB Header Array: Checkbox Input Name
static int	COL_HEADER_INVITE Header Array: Invites
static int	COL_HEADER_NAME Header Array: Names
static int	COL_HEADER_PORTLET_MAX Header Array: Number of Columns for gadget
static int	COL_HEADER_SIZE Header Array: Portlet Size
protected AActivitySpace	m_asOwner

Constructor Summary

PortletInBundleSelectionModelHelper(AActivitySpace asOwner)
Creates a new PortletInBundleSelectionModelHelper object.

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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COL_GADGET_MAX

public static final int COL_GADGET_MAX

Selected Info Array: Number of Columns

See Also:

Constant Field Values

COL_GADGET_ALIGNMENT

public static final int COL_GADGET_ALIGNMENT

Selected Info Array: Portlet Alignment Column

See Also:

Constant Field Values

COL_HEADER_PORTLET_MAX

public static final int COL_HEADER_PORTLET_MAX

Header Array: Number of Columns for gadget

See Also:

Constant Field Values

COL_HEADER_BUNDLE_MAX

public static final int COL_HEADER_BUNDLE_MAX

Header Array: Number of Columns for bundle

See Also:

Constant Field Values

COL_HEADER_CB

public static final int COL_HEADER_CB

Header Array: Checkbox Input Name

See Also:

Constant Field Values

COL_HEADER_NAME

public static final int COL_HEADER_NAME

Header Array: Names

See Also:

Constant Field Values

COL_HEADER_SIZE

public static final int COL_HEADER_SIZE

Header Array: Portlet Size

See Also:

Constant Field Values

COL_HEADER_INVITE

public static final int COL_HEADER_INVITE

Header Array: Invites

See Also:

Constant Field Values

m_asOwner

protected AActivitySpace m_asOwner

Constructor Detail

PortletInBundleSelectionModelHelper

public PortletInBundleSelectionModelHelper(AActivitySpace asOwner)

Creates a new PortletInBundleSelectionModelHelper object.

Parameters:

asOwner -

Method Detail

AddFormInputsForEachObject

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

Description copied from interface: IObjectSelectionModelHelper

Add a unique input to the form input hash table.

Specified by:

AddFormInputsForEachObject in interface IObjectSelectionModelHelper

See Also:

IObjectSelectionModelHelper.AddFormInputsForEachObject(XPHashtable, IASQueryResult, int)

GetDoNotShowObjectIDs

public XPSortedDictionary GetDoNotShowObjectIDs(ObjectSelectionModel model,
                                                int nObjectViewIndex)

Description copied from interface: IObjectSelectionModelHelper

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

Specified by:

GetDoNotShowObjectIDs in interface IObjectSelectionModelHelper

Returns:

XPSortedDictionary

See Also:

IObjectSelectionModelHelper.GetDoNotShowObjectIDs(ObjectSelectionModel, int)

GetHeaders

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

Description copied from interface: IObjectSelectionModelHelper

Returns the strings for the headers.

Specified by:

GetHeaders in interface IObjectSelectionModelHelper

Returns:

String[]

See Also:

IObjectSelectionModelHelper.GetHeaders(int)

GetNumObjectViews

public int GetNumObjectViews()

Description copied from interface: IObjectSelectionModelHelper

Returns the number of object views this model must display.

Specified by:

GetNumObjectViews in interface IObjectSelectionModelHelper

Returns:

int

See Also:

IObjectSelectionModelHelper.GetNumObjectViews()

GetObjectBannerTitle

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

Description copied from interface: IObjectSelectionModelHelper

Get the banner title for the object banner.

Specified by:

GetObjectBannerTitle in interface IObjectSelectionModelHelper

Returns:

String

See Also:

IObjectSelectionModelHelper.GetObjectBannerTitle(String, int)

GetObjectInputName

public java.lang.String GetObjectInputName(int nObjectViewIndex)

Description copied from interface: IObjectSelectionModelHelper

Gets the object input name

Specified by:

GetObjectInputName in interface IObjectSelectionModelHelper

Returns:

String strObjectInputName

See Also:

IObjectSelectionModelHelper.GetObjectInputName(int)

GetObjectMan

public IPTObjectManager GetObjectMan(IPTSession ptSession,
                                     int nObjectViewIndex)

Description copied from interface: IObjectSelectionModelHelper

Gets the an object manager.

Specified by:

GetObjectMan in interface IObjectSelectionModelHelper

Returns:

IPTObjectManager

See Also:

IObjectSelectionModelHelper.GetObjectMan(IPTSession, int)

GetObjectType

public int GetObjectType(int nObjectViewIndex)

Description copied from interface: IObjectSelectionModelHelper

Gets the object type.

Specified by:

GetObjectType in interface IObjectSelectionModelHelper

Returns:

int nObjectType

See Also:

IObjectSelectionModelHelper.GetObjectType(int)

GetObjects

public IASQueryResult GetObjects(IPTSession ptSession,
                                 IPTAdminFolder ptFolder)

Description copied from interface: IObjectSelectionModelHelper

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

Specified by:

GetObjects in interface IObjectSelectionModelHelper

Returns:

ASQueryResult

See Also:

IObjectSelectionModelHelper.GetObjects(IPTSession, IPTAdminFolder)

GetPropIDsToQuery

public int GetPropIDsToQuery(int nObjectViewIndex)

Description copied from interface: IObjectSelectionModelHelper

Gets the property IDs to query for.

Specified by:

GetPropIDsToQuery in interface IObjectSelectionModelHelper

Returns:

int nPropIDs

See Also:

IObjectSelectionModelHelper.GetPropIDsToQuery(int)

GetQueryFilter

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

Description copied from interface: IObjectSelectionModelHelper

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].

Specified by:

GetQueryFilter in interface IObjectSelectionModelHelper

Returns:

Object[][] oQueryFilter

See Also:

IObjectSelectionModelHelper.GetQueryFilter(ObjectSelectionModel, int)

GetRedirectAfterFinish

public Redirect GetRedirectAfterFinish(ObjectSelectionModel model)

Description copied from interface: IObjectSelectionModelHelper

Get the redirect for after the editor has finished.

Specified by:

GetRedirectAfterFinish in interface IObjectSelectionModelHelper

Returns:

Redirect

See Also:

IObjectSelectionModelHelper.GetRedirectAfterFinish(ObjectSelectionModel)

GetSelectedInfo

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

Description copied from interface: IObjectSelectionModelHelper

Gets the information to store in the selected dictionary.

Specified by:

GetSelectedInfo in interface IObjectSelectionModelHelper

Returns:

Object[]

See Also:

IObjectSelectionModelHelper.GetSelectedInfo(int, IASQueryResult)

GetSelectedObjects

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

Description copied from interface: IObjectSelectionModelHelper

Get the selected objects

Specified by:

GetSelectedObjects in interface IObjectSelectionModelHelper

Returns:

Object[][]

See Also:

IObjectSelectionModelHelper.GetSelectedObjects(ObjectSelectionModel)

GetShouldSavePage

public boolean GetShouldSavePage()

Description copied from interface: IObjectSelectionModelHelper

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

Specified by:

GetShouldSavePage in interface IObjectSelectionModelHelper

Returns:

boolean

See Also:

IObjectSelectionModelHelper.GetShouldSavePage()

InitializeFormInputs

public void InitializeFormInputs(XPHashtable htFormData)

Description copied from interface: IObjectSelectionModelHelper

Initialize the form input hash table.

Specified by:

InitializeFormInputs in interface IObjectSelectionModelHelper

See Also:

IObjectSelectionModelHelper.InitializeFormInputs(XPHashtable)

SetSelectedObjects

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

Description copied from interface: IObjectSelectionModelHelper

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

Specified by:

SetSelectedObjects in interface IObjectSelectionModelHelper

xpsdOldSelectedObjects - xpsdOldSelectedObjects

xpsdNewSelectedObjects - xpsdNewSelectedObjects

See Also:

IObjectSelectionModelHelper.SetSelectedObjects(ObjectSelectionModel, XPSortedDictionary, XPSortedDictionary)

GetStartInSearch

public boolean GetStartInSearch()

Description copied from interface: IObjectSelectionModelHelper

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

Specified by:

GetStartInSearch in interface IObjectSelectionModelHelper

Returns:

boolean

GetSearchHeaderTitle

public java.lang.String GetSearchHeaderTitle()

Description copied from interface: IObjectSelectionModelHelper

Get the title for the search header.

Specified by:

GetSearchHeaderTitle in interface IObjectSelectionModelHelper

Returns:

String

Get508SearchStringMsgIndex

public int Get508SearchStringMsgIndex(int nSearch508StringIndex)

Specified by:

Get508SearchStringMsgIndex in interface IObjectSelectionModelHelper

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