com.plumtree.portalpages.admin.editors.property
Class PropModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorModel
      com.plumtree.portaluiinfrastructure.editor.ObjEditorModel
          com.plumtree.portalpages.admin.editors.property.PropModel

All Implemented Interfaces:

IPropModelRO, IDescriptionModelRO, IMigrationModelRO, IObjEditorModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IEditorModelRO, IRepostModel

public class PropModel
extends ObjEditorModel
implements IPropModelRO

Model for property editor

Author:

josephc

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME Class name for PropModel

Fields inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

EDITOR_CLASSID_UNKNOWN, EDITOR_FOLDERID_UNKNOWN, EDITOR_OBJECTID_UNKNOWN, EDITOR_QS_BOL_QS_FORCESAVEINFOLDER, EDITOR_QS_INT_CLASS_ID, EDITOR_QS_INT_QS_FOLDER_ID, EDITOR_QS_INT_QS_OBJECT_ID, m_bDisableDescription, m_bDisableSecurity, m_bForceSavedInSuppliedFolder, m_bIsSysAdmin, m_nClassID, m_nFolderID, m_nFolderType, m_nObjectID, m_ptObject, m_Session, m_sFolderName, OBJECT_NAME_TRUNCATE

Fields inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

isReadAccessAvailable, m_asOwner, m_bCloseOnDone, m_bDeleteOnCancel, m_bEnableApplyButton, m_bEnableCancelButton, m_bHideLeftNav, m_bIsEditorReadOnly, m_bUserHasAccessToEditor, m_nEditorType

Constructor Summary

PropModel()
Creates a new PropModel object.

Method Summary

java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
void	DoTaskAfterStore() Code executed after the object is stored.
void	DoTaskBeforeStore() Code executed before the object is stored.
void	DoTaskOnStartEditor(XPHashtable _htFormData) Code to perform tasks specific to Property Editor
java.lang.String	GetManagedPicklistValidationFunction() Return pick list validation function
java.lang.String	GetName() Returns the Class name.
java.lang.String	GetPickTable() Returns name of database table used for pick table
int	GetPickType() Returns pick table types (PT_PICKTABLE_TYPES)
int	GetPropertyType() Returns property type (PT_PROPERTY_TYPES)
int	GetReferenceClass() Returns reference class
boolean	IsAlwaysCardProperty() Returns true if property is always a card property
boolean	IsCardProperty() Returns true if property is a card property
boolean	IsMandatory() Returns true if property is mandatory
boolean	IsMultiValued() Returns true if property is multi-valued
boolean	IsReadOnly() Returns true if property is read-only
boolean	IsSearchable() Returns true if property is searchable
boolean	IsURL() Returns true if property is an URL
boolean	IsVisible() Returns true if property is visible
protected int	SaveMainPage(XPHashtable _htFormData) Saves the data on the Main page.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	StartPickListValuesList() Helper method to start the growable list for pick list values list.
void	StartPickTableColList(java.lang.Object[][] arPickTableColumns) Helper method to start the multi-column list for pick table column list.

Methods inherited from class com.plumtree.portaluiinfrastructure.editor.ObjEditorModel

CheckEditorAccess, CheckEditorAccessAndStart, CheckFolderType, DisableSecurity, DoTaskOnComeBackFromSubEditor, Finish, ForceSaveInFolder, GetClassID, GetFolderID, GetFolderName, GetIsSysAdmin, GetMigrationStatus, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession, Init, InitIsSysAdminFlag, InitPTObject, IsDescriptionDisabled, IsMigrationApproved, SaveMigrationStatus, SetDisableDescription, SetEditorToReadOnly, SetMemberVariablesFromQS, SetMigrationStatus, StartKeywords, StartLocNamesList, StartMigrationHistory, StartObjectProp, StartSecurityList, StoreObject

Methods inherited from class com.plumtree.uiinfrastructure.editor.EditorModel

Cancel, CleanupAllData, CleanupTempData, DoTaskOnChangePage, GetAccessToEditorPriviledges, GetCloseOnDone, GetCurrentRepostAction, GetDeleteOnCancel, GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly, GetRedirectAfterFinish, GetUserHasAccessToEditor, SetCloseOnDone, SetDeleteOnCancel, SetEditorType, SetEnableApplyButton, SetHideLeftNav, SetPageStatus, SetUserHasAccessToEditor

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.editor.IObjEditorModelRO

GetClassID, GetObject, GetObjectDescription, GetObjectID, GetObjectName, GetParentFolderPath, GetPTSession

Methods inherited from interface com.plumtree.uiinfrastructure.editor.IEditorModelRO

GetEditorType, GetEnableApplyButton, GetEnableCancelButton, GetHideLeftNav, GetIsEditorReadOnly

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Class name for PropModel

See Also:

Constant Field Values

Constructor Detail

PropModel

public PropModel()

Creates a new PropModel object.

Method Detail

Create

public java.lang.Object Create()

Description copied from class: EditorModel

This method is used by the ASManager to return new instances of managed objects.

Specified by:

Create in interface IManagedObject

Specified by:

Create in class EditorModel

Returns:

A new instance of the managed class (i.e. return new Foo();)

See Also:

IManagedObject.Create()

DoTaskAfterStore

public void DoTaskAfterStore()

Code executed after the object is stored.

Overrides:

DoTaskAfterStore in class EditorModel

DoTaskBeforeStore

public void DoTaskBeforeStore()

Code executed before the object is stored.

Overrides:

DoTaskBeforeStore in class EditorModel

DoTaskOnStartEditor

public void DoTaskOnStartEditor(XPHashtable _htFormData)

Code to perform tasks specific to Property Editor

Overrides:

DoTaskOnStartEditor in class EditorModel

Parameters:

_htFormData -

GetManagedPicklistValidationFunction

public java.lang.String GetManagedPicklistValidationFunction()

Return pick list validation function

Specified by:

GetManagedPicklistValidationFunction in interface IPropModelRO

Returns:

Pick list validation function

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorModel

Returns:

String

GetPickTable

public java.lang.String GetPickTable()

Returns name of database table used for pick table

Specified by:

GetPickTable in interface IPropModelRO

Returns:

Name of database table used for pick table

GetPickType

public int GetPickType()

Returns pick table types (PT_PICKTABLE_TYPES)

Specified by:

GetPickType in interface IPropModelRO

Returns:

Pick type

GetPropertyType

public int GetPropertyType()

Returns property type (PT_PROPERTY_TYPES)

Specified by:

GetPropertyType in interface IPropModelRO

Returns:

Property type

GetReferenceClass

public int GetReferenceClass()

Returns reference class

Specified by:

GetReferenceClass in interface IPropModelRO

Returns:

Reference class

IsAlwaysCardProperty

public boolean IsAlwaysCardProperty()

Returns true if property is always a card property

Specified by:

IsAlwaysCardProperty in interface IPropModelRO

Returns:

True if property is always a card property

IsCardProperty

public boolean IsCardProperty()

Returns true if property is a card property

Specified by:

IsCardProperty in interface IPropModelRO

Returns:

True if property is a card property

IsMandatory

public boolean IsMandatory()

Returns true if property is mandatory

Specified by:

IsMandatory in interface IPropModelRO

Returns:

True if property is mandatory

IsMultiValued

public boolean IsMultiValued()

Returns true if property is multi-valued

Specified by:

IsMultiValued in interface IPropModelRO

Returns:

True if property is multi-valued

IsSearchable

public boolean IsSearchable()

Returns true if property is searchable

Specified by:

IsSearchable in interface IPropModelRO

Returns:

True if property is searchable

IsURL

public boolean IsURL()

Returns true if property is an URL

Specified by:

IsURL in interface IPropModelRO

Returns:

True if property is an URL

IsVisible

public boolean IsVisible()

Returns true if property is visible

Specified by:

IsVisible in interface IPropModelRO

Returns:

True if property is visible

IsReadOnly

public boolean IsReadOnly()

Returns true if property is read-only

Specified by:

IsReadOnly in interface IPropModelRO

Returns:

True if property is read-only

SavePage

public int SavePage(java.lang.String _sPageName,
                    XPHashtable _htFormData)

Calls the right save function according to the page name passed in argument.

Specified by:

SavePage in interface IRepostModel

Overrides:

SavePage in class ObjEditorModel

Parameters:

_sPageName -

_htFormData -

Returns:

int Page status for server side validation

StartPickListValuesList

public void StartPickListValuesList()

Helper method to start the growable list for pick list values list.

StartPickTableColList

public void StartPickTableColList(java.lang.Object[][] arPickTableColumns)

Helper method to start the multi-column list for pick table column list.

Parameters:

arPickTableColumns - Array of pick table columns

SaveMainPage

protected int SaveMainPage(XPHashtable _htFormData)

Saves the data on the Main page.

Parameters:

_htFormData -

Returns: