com.plumtree.portaluiinfrastructure.editor.commonpages.objectproperties
Interface IObjPropModelRO

All Superinterfaces:

IExpListModelRO, IExpListPropModelRO, IModelRO, IMVCObject, IPaginationModelRO

All Known Implementing Classes:

ObjPropModel, UserProfileObjEditModel

public interface IObjPropModelRO
extends IExpListPropModelRO

This interface contains all of the methods for accessing object property information in the model.

Author:

josephc

Method Summary

boolean	CheckDisplayPageIsMandatory() Returns true if the display page is mandatory because it contains mandatory properties.
boolean	CheckObjectSupportsEOD() Checks to see if the object supports EOD
boolean	CheckPickValuesAreValid(int _nRowIndex) If a property has a pick tree or pick list, check that the pick values can be successfully retrieved.
boolean	CheckRowIsHREF(int _nRowIndex) Checks to see if the property is an HREF
boolean	CheckRowIsMandatory(int _nRowIndex) Checks to see if the property is mandatory
boolean	CheckRowIsMultiValued(int _nRowIndex) Checks to see if the property is multivalued
boolean	CheckRowIsReadOnly(int _nRowIndex) Checks to see if the property is read-only
boolean	CheckRowIsVisible(int _nRowIndex) Checks to see if the property is visible
java.lang.Object[][]	GetPickListValues(int _nPropertyID) Return pick list values for the property
java.lang.Object	GetRowPropertyInfo(int _nRowIndex, int nPropID) Returns the value of the requested PROPID from the EOD query result.
java.lang.String	GetRowRefValueName(int _nRowIndex) Returns the reference value name
java.lang.String	GetSelectedReference(int _nRowIndex) Returns any previously selected reference
java.lang.String	GetStringFromObjectValue(java.lang.Object oValue, int nPropertyType) Returns string representation of property value
boolean	HasAccessToGlobalObjectPropMapEditor() Returns true if current user has access to global object property map.

Methods inherited from interface com.plumtree.portaluiinfrastructure.expandablelist.properties.IExpListPropModelRO

GetDateTimePickerControlManager, GetRowName, GetRowPropertyID, GetRowStatus, GetRowType, GetRowValue, GetUniqueDateTimePickerKey

Methods inherited from interface com.plumtree.uiinfrastructure.expandablelist.IExpListModelRO

GetAddIcon, GetAddIconAlt, GetAddLabel, GetAlertMessageForEmptyList, GetArrExpListColInfo, GetDeleteIcon, GetDeleteIconAlt, GetDelRowConfirmMsg, GetEmptyListInstructions, GetEmptyListMainMessage, GetEnableMoveRowActions, GetIsListReadOnly, GetListKey, GetMainColumnSort, GetMainColumnSortDirection, GetModelStorageName, GetReadOnlyItems, GetSectionTitle, GetTableInstructions, GetUniqueInt, GetUniqueString, GetUnusedProperties, GetWrapColumnHeaders, IsAddButtonDisabled, IsCheckBoxesDisabled, IsPaginationEnabled

Methods inherited from interface com.plumtree.uiinfrastructure.form.pagination.IPaginationModelRO

GetCurrentLowerObjectCount, GetCurrentUpperObjectCount, GetNumObjects, GetPaginationSize

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

GetName

Method Detail

CheckObjectSupportsEOD

boolean CheckObjectSupportsEOD()

Checks to see if the object supports EOD

Returns:

Returns true if object supports EOD. Otherwise returns false.

CheckRowIsHREF

boolean CheckRowIsHREF(int _nRowIndex)

Checks to see if the property is an HREF

Parameters:

_nRowIndex - Current row index

Returns:

Returns true if HREF. Otherwise returns false.

CheckRowIsMandatory

boolean CheckRowIsMandatory(int _nRowIndex)

Checks to see if the property is mandatory

Parameters:

_nRowIndex - Current row index

Returns:

Returns true if mandatory. Otherwise returns false.

CheckRowIsMultiValued

boolean CheckRowIsMultiValued(int _nRowIndex)

Checks to see if the property is multivalued

Parameters:

_nRowIndex - Current row index

Returns:

Returns true if multivalued. Otherwise returns false.

CheckRowIsReadOnly

boolean CheckRowIsReadOnly(int _nRowIndex)

Checks to see if the property is read-only

Parameters:

_nRowIndex - Current row index

Returns:

Returns true if read-only. Otherwise returns false.

CheckRowIsVisible

boolean CheckRowIsVisible(int _nRowIndex)

Checks to see if the property is visible

Parameters:

_nRowIndex - Current row index

Returns:

Returns true if visible. Otherwise returns false.

CheckDisplayPageIsMandatory

boolean CheckDisplayPageIsMandatory()

Returns true if the display page is mandatory because it contains mandatory properties.

Returns:

True if page contains mandatory properties that user must enter values for.

GetPickListValues

java.lang.Object[][] GetPickListValues(int _nPropertyID)

Return pick list values for the property

Parameters:

_nPropertyID - Property ID

Returns:

Pick list values

GetRowPropertyInfo

java.lang.Object GetRowPropertyInfo(int _nRowIndex,
                                    int nPropID)

Returns the value of the requested PROPID from the EOD query result.

Parameters:

_nRowIndex - Row index

nPropID - PT_PROPID

Returns:

Value of requested PROPID

GetRowRefValueName

java.lang.String GetRowRefValueName(int _nRowIndex)

Returns the reference value name

Parameters:

_nRowIndex - Row index

Returns:

Reference value name

GetStringFromObjectValue

java.lang.String GetStringFromObjectValue(java.lang.Object oValue,
                                          int nPropertyType)

Returns string representation of property value

Parameters:

oValue - Property value as Object

nPropertyType - Property type

Returns:

Property value as string

GetSelectedReference

java.lang.String GetSelectedReference(int _nRowIndex)

Returns any previously selected reference

Parameters:

_nRowIndex - Row index

Returns:

Value of property

HasAccessToGlobalObjectPropMapEditor

boolean HasAccessToGlobalObjectPropMapEditor()

Returns true if current user has access to global object property map. In order to access this editor, the user must be a member of the administrators group and must have the right to access the Plumtree utilities.

Returns:

True if user has access. False otherwise.

CheckPickValuesAreValid

boolean CheckPickValuesAreValid(int _nRowIndex)

If a property has a pick tree or pick list, check that the pick values can be successfully retrieved.

Parameters:

_nRowIndex - Row index

Returns:

True if pick values can be successfully retrieved.