com.plumtree.portalpages.portlets.jobhistory
Class JobHistoryPortletModel

java.lang.Object
  com.plumtree.uiinfrastructure.activityspace.AClearModel
      com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletModel
          com.plumtree.portalpages.portlets.jobhistory.JobHistoryPortletModel

All Implemented Interfaces:

IJobLogModelRO, IJobHistoryPortletModelRO, IIntrinsicPortletModelRO, IManagedObject, IModel, IModelRO, IMVCObject, IRepostModel

public class JobHistoryPortletModel
extends IntrinsicPortletModel
implements IJobHistoryPortletModelRO, IRepostModel, IJobLogModelRO

This class implements the model for the Job History intrinsic portlet

Author:

JohnH

Field Summary

static java.lang.String

STR_MVC_CLASS_NAME Class name for the model

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

JobHistoryPortletModel()

Method Summary

boolean	ControlExists() Returns true if this portlet has a control class
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".
int[]	GetArrayOfJobsToKill(XPHashtable _htFormData) This function returns an int array of JobID's to be killed
int	GetCurrentLogPage() Returns the log page currently being displayed.
int	GetCurrentPage() Returns CurrentPage setting.
JSDatePickerMgr	GetDatePickerControlManager() Get the Date picker control manager
int	GetJobID() Returns the jobID.
java.lang.String	GetJobName() Returns the jobName.
byte[]	GetLogFile() Returns the log file in byte array format
java.lang.String	GetName() Returns the Class name.
java.lang.Object	GetNewTempData() This method returns a new temporary data object.
java.lang.String	GetPortletName() Returns the portlet name
IPTSession	GetPTSession() Returns the Plumtree Session object.
Redirect	GetRedirectAfterFinish() Returns the Redirect object (this is were we need to go at the end of the Editor).
int	GetRowToDisplay() Returns the job history row to display in the job log detail viewer.
java.lang.String	GetRunTime() Returns the runTime.
java.lang.String	GetSearchString() Returns a string used for searching the job log.
void	Init(AActivitySpace parent) Inits the Model with the IPTSession.
boolean	IsSearchRequest() Returns whether the very last request is a search of the job log.
void	KillJobs(XPHashtable _htFormData) This function will send a kill message to each job that has been checked by the user.
int	SavePage(java.lang.String _sPageName, XPHashtable _htFormData) Calls the right save function according to the page name passed in argument.
void	SetCurrentLogPage(int currentLogPage) Sets the the log page currently being displayed.
void	SetCurrentPage(int _intCurrentPage) Sets CurrentRecord setting.
void	SetJobID(int jobID) Sets the jobID.
void	SetJobName(java.lang.String jobName) Sets the jobName.
void	SetLogSearchPage(java.lang.String strSearchText) Sets the the search term and indicates a result page
void	SetRowToDisplay(int rowToDisplay) Sets the job history row to display in the job log detail viewer.
void	SetRunTime(java.lang.String runTime) Sets the runTime.

Methods inherited from class com.plumtree.portaluiinfrastructure.intrinsicportlets.IntrinsicPortletModel

CleanupAllData, CleanupTempData, GetPortletID, GetSettingValue, GetSettingValues, InitPortlet, 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

Field Detail

STR_MVC_CLASS_NAME

public static final java.lang.String STR_MVC_CLASS_NAME

Class name for the model

See Also:

Constant Field Values

Constructor Detail

JobHistoryPortletModel

public JobHistoryPortletModel()

Method Detail

ControlExists

public boolean ControlExists()

Returns true if this portlet has a control class

Specified by:

ControlExists in interface IIntrinsicPortletModelRO

Specified by:

ControlExists in class IntrinsicPortletModel

Returns:

boolean

See Also:

IIntrinsicPortletModelRO.ControlExists()

Create

public java.lang.Object Create()

Description copied from class: AClearModel

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 AClearModel

Returns:

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

See Also:

IManagedObject.Create()

Finish

public void Finish()

Implement some code to execute when the user clicks on "Finish".

Specified by:

Finish in interface IRepostModel

GetName

public java.lang.String GetName()

Returns the Class name.

Specified by:

GetName in interface IMVCObject

Specified by:

GetName in class IntrinsicPortletModel

Returns:

String

See Also:

IMVCObject.GetName()

GetNewTempData

public java.lang.Object GetNewTempData()

Description copied from class: AClearModel

This method returns a new temporary data object. It is called at the beginning of a new HTTP Request. This method can perform initialization on the data object if necessary.

Specified by:

GetNewTempData in class AClearModel

Returns:

GetPortletName

public java.lang.String GetPortletName()

Returns the portlet name

Specified by:

GetPortletName in interface IJobHistoryPortletModelRO

Returns:

Portlet name

GetRedirectAfterFinish

public Redirect GetRedirectAfterFinish()

Returns the Redirect object (this is were we need to go at the end of the Editor).

Specified by:

GetRedirectAfterFinish in interface IRepostModel

Returns:

Redirect

Init

public void Init(AActivitySpace parent)

Inits the Model with the IPTSession.

Specified by:

Init in interface IModel

Overrides:

Init in class IntrinsicPortletModel

Parameters:

parent -

See Also:

IModel.Init(AActivitySpace)

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

Parameters:

_sPageName -

_htFormData -

Returns:

GetArrayOfJobsToKill

public int[] GetArrayOfJobsToKill(XPHashtable _htFormData)

This function returns an int array of JobID's to be killed

Parameters:

_htFormData -

Returns:

int[]

KillJobs

public void KillJobs(XPHashtable _htFormData)

This function will send a kill message to each job that has been checked by the user.

Parameters:

_htFormData -

IsSearchRequest

public boolean IsSearchRequest()

Returns whether the very last request is a search of the job log.

Specified by:

IsSearchRequest in interface IJobLogModelRO

Specified by:

IsSearchRequest in interface IJobHistoryPortletModelRO

Returns:

int

GetSearchString

public java.lang.String GetSearchString()

Returns a string used for searching the job log.

Specified by:

GetSearchString in interface IJobLogModelRO

Specified by:

GetSearchString in interface IJobHistoryPortletModelRO

Returns:

String

GetCurrentLogPage

public int GetCurrentLogPage()

Returns the log page currently being displayed.

Specified by:

GetCurrentLogPage in interface IJobLogModelRO

Specified by:

GetCurrentLogPage in interface IJobHistoryPortletModelRO

Returns:

int

GetCurrentPage

public int GetCurrentPage()

Returns CurrentPage setting.

Specified by:

GetCurrentPage in interface IJobLogModelRO

Specified by:

GetCurrentPage in interface IJobHistoryPortletModelRO

Returns:

int

GetJobID

public int GetJobID()

Returns the jobID.

Specified by:

GetJobID in interface IJobLogModelRO

Specified by:

GetJobID in interface IJobHistoryPortletModelRO

Returns:

int

GetJobName

public java.lang.String GetJobName()

Returns the jobName.

Specified by:

GetJobName in interface IJobLogModelRO

Specified by:

GetJobName in interface IJobHistoryPortletModelRO

Returns:

String

GetPTSession

public IPTSession GetPTSession()

Returns the Plumtree Session object.

Specified by:

GetPTSession in interface IJobLogModelRO

Specified by:

GetPTSession in interface IJobHistoryPortletModelRO

Returns:

IPTSession

GetRowToDisplay

public int GetRowToDisplay()

Returns the job history row to display in the job log detail viewer.

Specified by:

GetRowToDisplay in interface IJobLogModelRO

Specified by:

GetRowToDisplay in interface IJobHistoryPortletModelRO

Returns:

int

GetRunTime

public java.lang.String GetRunTime()

Returns the runTime.

Specified by:

GetRunTime in interface IJobLogModelRO

Specified by:

GetRunTime in interface IJobHistoryPortletModelRO

Returns:

String

SetLogSearchPage

public void SetLogSearchPage(java.lang.String strSearchText)

Sets the the search term and indicates a result page

Parameters:

SearchTerm - to be applied against the log text

SetCurrentLogPage

public void SetCurrentLogPage(int currentLogPage)

Sets the the log page currently being displayed.

Parameters:

currentLogPage - The currentLogPage to set

SetCurrentPage

public void SetCurrentPage(int _intCurrentPage)

Sets CurrentRecord setting.

SetJobID

public void SetJobID(int jobID)

Sets the jobID.

Parameters:

jobID - The jobID to set

SetJobName

public void SetJobName(java.lang.String jobName)

Sets the jobName.

Parameters:

jobName - The jobName to set

SetRowToDisplay

public void SetRowToDisplay(int rowToDisplay)

Sets the job history row to display in the job log detail viewer.

Parameters:

rowToDisplay - The rowToDisplay to set

SetRunTime

public void SetRunTime(java.lang.String runTime)

Sets the runTime.

Parameters:

runTime - The runTime to set

GetLogFile

public byte[] GetLogFile()

Returns the log file in byte array format

Specified by:

GetLogFile in interface IJobLogModelRO

Returns:

byte[]

GetDatePickerControlManager

public JSDatePickerMgr GetDatePickerControlManager()

Get the Date picker control manager

Specified by:

GetDatePickerControlManager in interface IJobLogModelRO

Returns:

JSDatePickerMgr