com.plumtree.portalpages.common.objects
Interface IObjectModelRO

All Superinterfaces:

IModelRO, IMVCObject

All Known Subinterfaces:

IDirModel, IDirModelRO, IObjectSelectionModelRO, ISiteMapModelRO

All Known Implementing Classes:

DirModel, ObjectSelectionModel, ObjMgrModel, PortletInBundleObjectSelectionModel, SiteMapModel

public interface IObjectModelRO
extends IModelRO

Author:

michaeld

Method Summary

boolean	DoNotShowObject(int nIndex) Get whether to show this object or not.
boolean	GetDisplayPaginationHiddenInputs() Get whether or not to display the hidden inputs needed by the PaginationControl.
boolean	GetDisplaySortHiddenInputs() Get whether or not to display the hidden inputs needed by the SortControl.
int	GetHeaderCount() Gets the count of the object headers.
boolean	GetHeaderHasCheckbox() Returns whether the header has a checkbox or not.
HTMLTableRow	GetHeaderRow() Returns the header row
java.lang.String	GetHeaderText(int nHeaderIndex) Gets the text of the header at the given index.
boolean	GetIsCollapsable() Gets whether or not the object banner should be collapsable.
boolean	GetIsObjectSelected(int nObjectID) This method returns whether or not the requested object ID is currently selected.
java.lang.String	GetObjectBannerTitle() Gets the name of the current folder.
int	GetObjectColumnCount() Gets the number of columns of objects
int	GetObjectCount() Gets the count of the objects in the query result.
java.lang.Object	GetObjectFields(int nIndex, int nPropID) Gets the fields from the query result.
int	GetObjectSubType(int nIndex) Get the subtype of the object at the given index.
int	GetObjectType() Get the Object Class ID of the type of objects we are currently viewing.
boolean	GetObjectViewIsCollapsed() Get whether the object view is collapsed.
boolean	GetShowPagination() Get whether these objects should use pagination or not.
boolean	GetSortable() Get whether these objects are sortable or not.
java.lang.String	GetSpaceID() Get the Space ID of this models AS
boolean	ShowObjectBanner() Get whether to show the banner or not.

Methods inherited from interface com.plumtree.uiinfrastructure.activityspace.IMVCObject

GetName

Method Detail

DoNotShowObject

boolean DoNotShowObject(int nIndex)

Get whether to show this object or not.

Parameters:

int - nIndex

Returns:

boolean true implies object is hidden, false implies show object

GetDisplayPaginationHiddenInputs

boolean GetDisplayPaginationHiddenInputs()

Get whether or not to display the hidden inputs needed by the PaginationControl. This is only useful if GetShowPagination() returns true.

Returns:

boolean true implies display hidden inputs

See Also:

com.plumtree.uiinfrastructure.form.pagination.PaginationControl.

GetDisplaySortHiddenInputs

boolean GetDisplaySortHiddenInputs()

Get whether or not to display the hidden inputs needed by the SortControl. This is only useful if GetSortable() returns true.

Returns:

boolean true implies display hidden inputs

See Also:

com.plumtree.uiinfrastructure.form.sort.SortControl.

GetHeaderCount

int GetHeaderCount()

Gets the count of the object headers. Returns 0 if the array is null.

Returns:

int nHeaderCount

GetHeaderHasCheckbox

boolean GetHeaderHasCheckbox()

Returns whether the header has a checkbox or not.

Returns:

boolean

GetHeaderRow

HTMLTableRow GetHeaderRow()

Returns the header row

Returns:

int nHeaderCount

GetHeaderText

java.lang.String GetHeaderText(int nHeaderIndex)

Gets the text of the header at the given index.

Parameters:

nHeaderIndex - nHeaderIndex

Returns:

String strHeaderText

GetIsCollapsable

boolean GetIsCollapsable()

Gets whether or not the object banner should be collapsable.

Returns:

boolean true implies collapsible.

GetIsObjectSelected

boolean GetIsObjectSelected(int nObjectID)

This method returns whether or not the requested object ID is currently selected.

Returns:

boolean true implies selected, false implies not selected

GetObjectBannerTitle

java.lang.String GetObjectBannerTitle()

Gets the name of the current folder.

Returns:

String strCurrentFolderName

GetObjectColumnCount

int GetObjectColumnCount()

Gets the number of columns of objects

Returns:

int nColumnCount

GetObjectCount

int GetObjectCount()

Gets the count of the objects in the query result.

Returns:

int nObjectCount

GetObjectFields

java.lang.Object GetObjectFields(int nIndex,
                                 int nPropID)

Gets the fields from the query result.

Parameters:

nIndex - nIndex

nPropID - nPropID

Returns:

Object oFields

GetObjectType

int GetObjectType()

Get the Object Class ID of the type of objects we are currently viewing.

Returns:

int the class ID of the object

GetObjectSubType

int GetObjectSubType(int nIndex)

Get the subtype of the object at the given index.

Parameters:

nIndex - index of the object in the list.

Returns:

the subtype of the object, or -1 if the object has no subtype.

GetObjectViewIsCollapsed

boolean GetObjectViewIsCollapsed()

Get whether the object view is collapsed. This is only relevant if GetIsCollapsable() returns true.

Returns:

bObjectViewIsCollapsed

GetShowPagination

boolean GetShowPagination()

Get whether these objects should use pagination or not. If this is true, the header will have a pagination bar. If this is true, the AActivitySpace will need to include the pagination framework (pass-thru repost control & implement pagination model interface).

Returns:

boolean true implies show pagination bar

See Also:

IPaginationModel, ObjectView

GetSortable

boolean GetSortable()

Get whether these objects are sortable or not. If this is true, the headers will be sortable. If this is true, the AActivitySpace will need to include the sortable framework (pass-thru repost control & implement sortable model interface).

Returns:

boolean true implies sortable

See Also:

ISortModel, ObjectView

GetSpaceID

java.lang.String GetSpaceID()

Get the Space ID of this models AS

Returns:

String m_asOwner.GetSpaceID()

ShowObjectBanner

boolean ShowObjectBanner()

Get whether to show the banner or not.

Returns:

boolean true implies show banner