com.plumtree.portaluiinfrastructure.editor.commonpages.migrationhistory
Class MigrationHistoryPluginModel

java.lang.Object
  com.plumtree.uiinfrastructure.editor.EditorHelperModel
      com.plumtree.portaluiinfrastructure.editor.commonpages.migrationhistory.MigrationHistoryPluginModel

All Implemented Interfaces:

IMigrationHistoryModel, IMigrationHistoryModelRO, IManagedObject, IModel, IModelRO, IMVCObject

public class MigrationHistoryPluginModel
extends EditorHelperModel
implements IMigrationHistoryModel, IMigrationHistoryModelRO

Model for the migration history of a single PTObject.

Author:

ArvindS

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME

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

m_asOwner

Constructor Summary

MigrationHistoryPluginModel()

Method Summary

void	CleanupTempData() This method is called at the end of every HTTP request by the Interpreter.
java.lang.Object	Create() This method is used by the ASManager to return new instances of managed objects.
int	GetCurrentMigrationStatus() Retrieves the current migration status of the underlying PTObject.
MigrationHistoryItem	GetHistoryItem(int _nIndex) Retrieves the history item at the index specified by _nIndex
java.lang.String	GetName() Returns the Class name.
int	GetNumHistoryItems() Returns the number of items in the history for the underlying PTObject.
boolean	InitializeHistory(int nClassID, int nObjectID) Implements some actions to perform on start.
boolean	IsMigrationCheckboxChecked() Retrieves the flag indicating whether the checkbox has been checked in this editor session.
boolean	IsStandalone() Retrieves the flag indicating whether or not we are being hosted by another activity space, or our own.
int	SaveSection(XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	SetApprovedForMigration(boolean bApproved) Sets the flag indicating this object has been approved for migration
boolean	ShouldDisplayApproval() Retrieves the flag indicating whether or not to display the approval checkbox (currently only for full sysadmins)
void	StoreMigrationStatus(int nClassID, int nObjectID) Helper method to Store the migration status on the object.

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

CleanupAllData, Init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

CleanupAllData, Init

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

See Also:

Constant Field Values

Constructor Detail

MigrationHistoryPluginModel

public MigrationHistoryPluginModel()

Method Detail

CleanupTempData

public void CleanupTempData()

Description copied from interface: IModel

This method is called at the end of every HTTP request by the Interpreter. The Interpreter calls AActivitySpace.CleanupTempData(), which calls this method on all IModels registered using AActivitySpace.RegisterModel(). This method is intended for cleaning up temporary data that is only used for the lifetime of a single request, like DB query results.

Specified by:

CleanupTempData in interface IModel

Overrides:

CleanupTempData in class EditorHelperModel

See Also:

IModel.CleanupTempData()

Create

public java.lang.Object Create()

Description copied from class: EditorHelperModel

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 EditorHelperModel

Returns:

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

See Also:

IManagedObject.Create()

GetCurrentMigrationStatus

public int GetCurrentMigrationStatus()

Description copied from interface: IMigrationHistoryModel

Retrieves the current migration status of the underlying PTObject.

Specified by:

GetCurrentMigrationStatus in interface IMigrationHistoryModel

Specified by:

GetCurrentMigrationStatus in interface IMigrationHistoryModelRO

Returns:

GetHistoryItem

public MigrationHistoryItem GetHistoryItem(int _nIndex)

Description copied from interface: IMigrationHistoryModel

Retrieves the history item at the index specified by _nIndex

Specified by:

GetHistoryItem in interface IMigrationHistoryModel

Specified by:

GetHistoryItem in interface IMigrationHistoryModelRO

Parameters:

_nIndex -

Returns:

GetName

public java.lang.String GetName()

Description copied from class: EditorHelperModel

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class EditorHelperModel

Returns:

String

See Also:

com.plumtree.portaluiinfrastructure.activityspace.IModelRO#GetName()

GetNumHistoryItems

public int GetNumHistoryItems()

Description copied from interface: IMigrationHistoryModel

Returns the number of items in the history for the underlying PTObject.

Specified by:

GetNumHistoryItems in interface IMigrationHistoryModel

Specified by:

GetNumHistoryItems in interface IMigrationHistoryModelRO

Returns:

InitializeHistory

public boolean InitializeHistory(int nClassID,
                                 int nObjectID)

Implements some actions to perform on start.

Parameters:

_htFormData -

Returns:

boolean Is true if the current user has the rights to access this Editor.

IsStandalone

public boolean IsStandalone()

Retrieves the flag indicating whether or not we are being hosted by another activity space, or our own.

Specified by:

IsStandalone in interface IMigrationHistoryModel

Specified by:

IsStandalone in interface IMigrationHistoryModelRO

ShouldDisplayApproval

public boolean ShouldDisplayApproval()

Retrieves the flag indicating whether or not to display the approval checkbox (currently only for full sysadmins)

Specified by:

ShouldDisplayApproval in interface IMigrationHistoryModel

Specified by:

ShouldDisplayApproval in interface IMigrationHistoryModelRO

StoreMigrationStatus

public void StoreMigrationStatus(int nClassID,
                                 int nObjectID)

Helper method to Store the migration status on the object.

Specified by:

StoreMigrationStatus in interface IMigrationHistoryModel

SetApprovedForMigration

public void SetApprovedForMigration(boolean bApproved)

Sets the flag indicating this object has been approved for migration

Specified by:

SetApprovedForMigration in interface IMigrationHistoryModel

IsMigrationCheckboxChecked

public boolean IsMigrationCheckboxChecked()

Retrieves the flag indicating whether the checkbox has been checked in this editor session.

Specified by:

IsMigrationCheckboxChecked in interface IMigrationHistoryModelRO

SaveSection

public int SaveSection(XPHashtable _htFormData)

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

Specified by:

SaveSection in class EditorHelperModel

Parameters:

_htFormData -

Returns:

int Page status for server side validation