|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.activityspace.AClearModel com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletModel com.plumtree.portalpages.portlets.savedsearch.SavedSearchPortletModel
public class SavedSearchPortletModel
Field Summary | |
---|---|
static java.lang.String |
ADMIN_PREF_DISPLAY_FIELDS
|
static java.lang.String |
ADMIN_PREF_PARAMETERIC_PROPS
|
static int |
DATA_INDEX_DISPLAY_FIELDS
Index of search ID in data array |
static int |
DATA_INDEX_PARAMETERICIDS
Index of search ID in data array |
static int |
DATA_INDEX_SEARCHID
Index of search ID in data array |
static int |
DATA_INDEX_SEARCHTITLE
Index of search title in data array |
static int |
DATA_INDEX_SIMPLE
Index of simple flag in data array |
static int |
PROPINFO_INDEX_ID
Index of Property ID in property info array |
static int |
PROPINFO_INDEX_NAME
Index of Property Name in property info array |
static int |
PROPINFO_INDEX_ORIENT
Index of UI Orientation (column or row) in property info array |
static int |
PROPINFO_INDEX_TYPE
Index of Property Type in property info array |
static java.lang.String |
PROPINFO_ORIENT_COL
orientation values - column |
static java.lang.String |
PROPINFO_ORIENT_ROW
orientation values - row |
static java.lang.String |
STR_MVC_CLASS_NAME
Class name for the model |
static java.lang.String |
strTitleKey
|
Fields inherited from class com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletModel |
---|
m_asOwner, m_nContainerClassID, m_nContainerObjectID, m_nPageID, m_nPortletID, m_nPrefType, m_ptAppDataState, m_ptPortlet, m_ptSession, PREF_TYPE_ADMIN, PREF_TYPE_COMMUNITY, PREF_TYPE_PERSONAL, SETTINGSTYPE_ADMIN, SETTINGSTYPE_COMMUNITY, SETTINGSTYPE_COMMUNITYPORTLET, SETTINGSTYPE_PORTLET, SETTINGSTYPE_USER |
Constructor Summary | |
---|---|
SavedSearchPortletModel()
|
Method Summary | |
---|---|
void |
ClearParametericResults()
|
boolean |
ControlExists()
Returns true if the portlet has a control associated with it. |
Redirect |
ConvertSearchToQueryString()
|
java.lang.Object |
Create()
This method is used by the ASManager to return new instances of managed objects. |
void |
Finish()
Implement some code to execute when the user clicks on "Finish". |
JSDateTimePickerMgr |
GetDatePickerMgr()
|
int |
GetFirstDisplayableItem()
Returns the index of the first displayable item. |
IPTSearchResponse |
GetFollowupResponse()
|
int |
GetItemsPerPage()
Returns the user's desired results per page. |
java.lang.String |
GetName()
Returns the Class name. |
java.lang.Object |
GetNewTempData()
This method returns a new temporary data object. |
int |
GetNumDisplayableItems()
Returns the number of results actually returned. |
PageMgr |
GetPageMgr()
|
FilterIterator |
GetParametericFilterIterator()
|
java.lang.String |
GetPortletName()
Returns the portlet name |
Redirect |
GetRedirectAfterFinish()
Returns the Redirect object (this is were we need to go at the end of the Editor). |
java.lang.Object[][] |
GetReturnedPropertyInfo()
|
IPTSearchResponse |
GetSearchResponseObject()
|
java.lang.Object[] |
GetSearchSettings()
|
java.lang.String |
GetSortOrder()
Returns the current sort order. |
int |
GetTotalItems()
Returns the total number of items, some of which may not currently be displayable. |
int |
GetTotalMatches()
|
void |
GoToPage(java.lang.String sortOrder,
int firstItemOnPage,
int pageSize,
java.lang.Object additionalInfo)
Go to another page. |
boolean |
HasParametericResults()
|
void |
InitPortlet(IPTPageInfo _ptPageInfo,
IPTState _ptAppDataState,
IPTGadget _ptPortlet,
int _nPortletID)
Initializes the member variables of the portlet. |
boolean |
IsPaginationEnabled()
|
boolean |
IsParameterized()
|
boolean |
IsSubscriptionEnabled()
|
boolean |
IsUserSubscribed()
|
int |
SavePage(java.lang.String _sPageName,
XPHashtable _htFormData)
Calls the right save function according to the page name passed in argument. |
void |
SetParametericFilter(XPHashtable _htFormData)
|
void |
SetSortOrder(int _nSortID)
|
void |
SetSubscribe(int nValue)
|
Methods inherited from class com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletModel |
---|
CleanupAllData, CleanupTempData, GetPortletID, GetSettingValue, GetSettingValues, Init, IsIntrinsicPortlet |
Methods inherited from class com.plumtree.uiinfrastructure.activityspace.AClearModel |
---|
GetTempData |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.plumtree.portaluiinfrastructure.intrinsicportlets.IIntrinsicPortletModelRO |
---|
GetPortletID |
Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IModel |
---|
CleanupAllData, CleanupTempData, Init |
Field Detail |
---|
public static final java.lang.String STR_MVC_CLASS_NAME
public static final java.lang.String strTitleKey
public static final java.lang.String ADMIN_PREF_DISPLAY_FIELDS
public static final java.lang.String ADMIN_PREF_PARAMETERIC_PROPS
public static final int DATA_INDEX_SEARCHTITLE
public static final int DATA_INDEX_SIMPLE
public static final int DATA_INDEX_SEARCHID
public static final int DATA_INDEX_PARAMETERICIDS
public static final int DATA_INDEX_DISPLAY_FIELDS
public static final int PROPINFO_INDEX_ID
public static final int PROPINFO_INDEX_NAME
public static final int PROPINFO_INDEX_TYPE
public static final int PROPINFO_INDEX_ORIENT
public static final java.lang.String PROPINFO_ORIENT_COL
public static final java.lang.String PROPINFO_ORIENT_ROW
Constructor Detail |
---|
public SavedSearchPortletModel()
Method Detail |
---|
public boolean ControlExists()
IntrinsicPortletModel
ControlExists
in interface IIntrinsicPortletModelRO
ControlExists
in class IntrinsicPortletModel
IIntrinsicPortletModelRO.ControlExists()
public java.lang.Object Create()
AClearModel
Create
in interface IManagedObject
Create
in class AClearModel
IManagedObject.Create()
public void Finish()
Finish
in interface IRepostModel
public void InitPortlet(IPTPageInfo _ptPageInfo, IPTState _ptAppDataState, IPTGadget _ptPortlet, int _nPortletID)
IntrinsicPortletModel
InitPortlet
in class IntrinsicPortletModel
_ptAppDataState
- AppDataState object_ptPortlet
- Portlet object_nPortletID
- Portlet IDpublic java.lang.Object[] GetSearchSettings()
GetSearchSettings
in interface ISavedSearchPortletModelRO
public java.lang.String GetName()
GetName
in interface IMVCObject
GetName
in class IntrinsicPortletModel
IMVCObject.GetName()
public java.lang.Object GetNewTempData()
AClearModel
GetNewTempData
in class AClearModel
public java.lang.String GetPortletName()
GetPortletName
in interface ISavedSearchPortletModelRO
public Redirect GetRedirectAfterFinish()
GetRedirectAfterFinish
in interface IRepostModel
public IPTSearchResponse GetSearchResponseObject()
GetSearchResponseObject
in interface ISavedSearchPortletModelRO
public boolean IsSubscriptionEnabled()
IsSubscriptionEnabled
in interface ISavedSearchPortletModelRO
public boolean IsUserSubscribed()
IsUserSubscribed
in interface ISavedSearchPortletModelRO
public int SavePage(java.lang.String _sPageName, XPHashtable _htFormData)
SavePage
in interface IRepostModel
_sPageName
- _htFormData
-
public void SetSubscribe(int nValue)
nValue
- public void SetParametericFilter(XPHashtable _htFormData)
public void SetSortOrder(int _nSortID)
public java.lang.String GetSortOrder()
IPaginationRO
GetSortOrder
in interface ISavedSearchPortletModelRO
GetSortOrder
in interface IPaginationRO
public IPTSearchResponse GetFollowupResponse()
GetFollowupResponse
in interface ISavedSearchPortletModelRO
public int GetTotalMatches()
GetTotalMatches
in interface ISavedSearchPortletModelRO
public boolean HasParametericResults()
HasParametericResults
in interface ISavedSearchPortletModelRO
public void ClearParametericResults()
public java.lang.Object[][] GetReturnedPropertyInfo()
GetReturnedPropertyInfo
in interface ISavedSearchPortletModelRO
public Redirect ConvertSearchToQueryString()
ConvertSearchToQueryString
in interface ISavedSearchPortletModelRO
public FilterIterator GetParametericFilterIterator()
GetParametericFilterIterator
in interface ISavedSearchPortletModelRO
public PageMgr GetPageMgr()
GetPageMgr
in interface ISavedSearchPortletModelRO
public JSDateTimePickerMgr GetDatePickerMgr()
GetDatePickerMgr
in interface ISavedSearchPortletModelRO
public boolean IsParameterized()
IsParameterized
in interface ISavedSearchPortletModelRO
public boolean IsPaginationEnabled()
IsPaginationEnabled
in interface ISavedSearchPortletModelRO
public void GoToPage(java.lang.String sortOrder, int firstItemOnPage, int pageSize, java.lang.Object additionalInfo)
IPagination
GoToPage
in interface IPagination
sortOrder
- Sort order in which firstItemOnPage should be interpretedfirstItemOnPage
- First item to appear on page (1-based)pageSize
- Desired number of items on pageadditionalInfo
- Additional application-specific info, if neededpublic int GetFirstDisplayableItem()
IPaginationRO
GetFirstDisplayableItem
in interface IPaginationRO
public int GetItemsPerPage()
IPaginationRO
GetItemsPerPage
in interface IPaginationRO
public int GetNumDisplayableItems()
IPaginationRO
GetNumDisplayableItems
in interface IPaginationRO
public int GetTotalItems()
IPaginationRO
GetTotalItems
in interface IPaginationRO
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |