com.plumtree.portalpages.browsing.objectselection
Interface IObjectSelectionModelRO

All Superinterfaces:
IModelRO, IMVCObject, IObjectModelRO
All Known Implementing Classes:
ObjectSelectionModel, PortletInBundleObjectSelectionModel

public interface IObjectSelectionModelRO
extends IObjectModelRO

Author:
michaeld

Method Summary
 boolean CheckEditorAccessAndStart(XPHashtable htFormData)
          Initializes the model.
 boolean DoNotShowObjectWithID(int nObjectID)
          Get whether or not to show an object given the objectID
 IASQueryResult GetBreadCrumbPath()
          This method returns a 2d query result with folder level, id, and name.
 boolean GetDisplaySearch()
          Returns true if we need to display the search results view.
 int GetFirstDisplayableItem()
          Get the first displayable item for pagination in the object selection model if pagination is used.
 java.lang.String GetInputValue(java.lang.String strInput)
          Returns the value of the given input.
 int GetItemsPerPage()
          Get the number of items per page for pagination in the object selection model if pagination is used.
 boolean GetMultipleSelect()
          Get wether we can select multiple or single.
 java.lang.String GetParentFormName()
          Get the name of the parent window's form.
 java.lang.String GetParentFormSelectedItems()
          Get the name of the form element for selected items.
 java.lang.String GetParentFormSpaceID()
          Get the string that is the parent form space ID.
 java.lang.String GetParentFormSubmitFunction()
          Get the string that is the parent form submit function.
 SearchSettingCollection GetSearchSettingCollection()
          Returns the Search Setting Collection.
 boolean GetSearchStarted()
          Returns true if a search has been initialized.
 java.lang.String GetSelectedNamesAsString()
          Get the selected names as a string.
 int GetSelectorClassID()
          Get the selector's class ID.
 int GetSelectorCommunityFolderID()
          Get the selector's community folder ID.
 int GetSelectorCommunityID()
          Get the selector's community ID.
 int GetSelectorObjectID()
          Get the selector's object ID.
 int GetSelectorPageID()
          Get the selector's page ID.
 int GetSortPropertyId()
          Gets the current property id that the model is ordered by.
 int GetTemporaryInvitationID()
          Get the id for object in the invitation pop-up.
 java.lang.String GetTemporaryInvitationName()
          Get the name for object in the invitation pop-up.
 int GetTotalItems()
          Get the total number of items for pagination in the object selection model if pagination is used.
 boolean IsCommunityPage()
           
 boolean IsHomeMyPage()
           
 boolean IsMyPage()
           
 boolean IsPageTemplate()
           
 
Methods inherited from interface com.plumtree.portalpages.common.objects.IObjectModelRO
DoNotShowObject, GetDisplayPaginationHiddenInputs, GetDisplaySortHiddenInputs, GetHeaderCount, GetHeaderHasCheckbox, GetHeaderRow, GetHeaderText, GetIsCollapsable, GetIsObjectSelected, GetObjectBannerTitle, GetObjectColumnCount, GetObjectCount, GetObjectFields, GetObjectSubType, GetObjectType, GetObjectViewIsCollapsed, GetShowPagination, GetSortable, GetSpaceID, ShowObjectBanner
 
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject
GetName
 

Method Detail

GetBreadCrumbPath

IASQueryResult GetBreadCrumbPath()
This method returns a 2d query result with folder level, id, and name.

Returns:
IASQueryResult

GetDisplaySearch

boolean GetDisplaySearch()
Returns true if we need to display the search results view.

Returns:
boolean

GetInputValue

java.lang.String GetInputValue(java.lang.String strInput)
Returns the value of the given input.

Parameters:
String - strInput
Returns:
String strValue

GetMultipleSelect

boolean GetMultipleSelect()
Get wether we can select multiple or single.

Returns:
boolean

GetParentFormName

java.lang.String GetParentFormName()
Get the name of the parent window's form.

Returns:
String

GetParentFormSelectedItems

java.lang.String GetParentFormSelectedItems()
Get the name of the form element for selected items.

Returns:
String

GetParentFormSpaceID

java.lang.String GetParentFormSpaceID()
Get the string that is the parent form space ID.

Returns:
String

GetParentFormSubmitFunction

java.lang.String GetParentFormSubmitFunction()
Get the string that is the parent form submit function.

Returns:
String

GetSearchStarted

boolean GetSearchStarted()
Returns true if a search has been initialized.

Returns:
boolean

GetSearchSettingCollection

SearchSettingCollection GetSearchSettingCollection()
Returns the Search Setting Collection.

Returns:
SearchSettingCollection

GetSelectedNamesAsString

java.lang.String GetSelectedNamesAsString()
Get the selected names as a string.

Returns:
String strSelectedNames

GetSelectorClassID

int GetSelectorClassID()
Get the selector's class ID.

Returns:
int nSelectorClassID

GetSelectorCommunityFolderID

int GetSelectorCommunityFolderID()
Get the selector's community folder ID.

Returns:
int nSelectorCommunityFolderID

GetSelectorCommunityID

int GetSelectorCommunityID()
Get the selector's community ID.

Returns:
int nSelectorCommunityID or 0 if not in a community

GetSelectorObjectID

int GetSelectorObjectID()
Get the selector's object ID.

Returns:
int nSelectorObjectID

GetSelectorPageID

int GetSelectorPageID()
Get the selector's page ID.

Returns:
int nSelectorPageID

GetTemporaryInvitationID

int GetTemporaryInvitationID()
Get the id for object in the invitation pop-up.

Returns:
int

GetTemporaryInvitationName

java.lang.String GetTemporaryInvitationName()
Get the name for object in the invitation pop-up.

Returns:
String

DoNotShowObjectWithID

boolean DoNotShowObjectWithID(int nObjectID)
Get whether or not to show an object given the objectID

Parameters:
nObjectID -
Returns:
boolean

CheckEditorAccessAndStart

boolean CheckEditorAccessAndStart(XPHashtable htFormData)
Initializes the model. Normally just called by the Interpreter, but used by the PortletDataTag when this model is run in delayed initialization mode.

Parameters:
htFormData -
Returns:

GetSortPropertyId

int GetSortPropertyId()
Gets the current property id that the model is ordered by.

Returns:

IsHomeMyPage

boolean IsHomeMyPage()

IsMyPage

boolean IsMyPage()

IsCommunityPage

boolean IsCommunityPage()

IsPageTemplate

boolean IsPageTemplate()

GetFirstDisplayableItem

int GetFirstDisplayableItem()
Get the first displayable item for pagination in the object selection model if pagination is used.

Returns:
the first displayable item.

GetItemsPerPage

int GetItemsPerPage()
Get the number of items per page for pagination in the object selection model if pagination is used.

Returns:
the number of items per page.

GetTotalItems

int GetTotalItems()
Get the total number of items for pagination in the object selection model if pagination is used. This includes all object types currently being displayed.

Returns:
the total number of items.



Copyright 2002,2003,2004,2005 Plumtree Software, Inc., All Rights Reserved.