com.plumtree.portalpages.common.joblogs
Class JobLogModelHelper

java.lang.Object
  com.plumtree.portalpages.common.joblogs.JobLogModelHelper

All Implemented Interfaces:

IJobLogModelRO

public class JobLogModelHelper
extends java.lang.Object
implements IJobLogModelRO

This helper class contains the implementation of the functions that the Job Log Model needs. Those functions have been moved to the helper class so they can be shared among multiple models (e.g. the intrinsic portlet model)

Author:

JohnH

Constructor Summary

JobLogModelHelper(AActivitySpace parent, IPTSession session)
The constructor for the JobLogModelHelper class.

Method Summary

void	DeleteJobHistory(XPDateTime xpdtDeleteFrom) Delete the job history from the passed in date and earlier
void	ExitSearchMode() This function returns the viewer to simple read mode
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
PageMgr	GetPageMgr()
IPTSession	GetPTSession() Returns the Plumtree Session object.
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	InitializeDatePickerMgrs(XPLocale xpLocale, XPTimeZone xpTimeZone) This function initializes the manager objects (Page and date) for the date pickers
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.
void	RetrieveFileForDownload(int intInstanceID) Prepare the log file for download by setting it on a byte array member variable
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 java.lang.Object

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

Constructor Detail

JobLogModelHelper

public JobLogModelHelper(AActivitySpace parent,
                         IPTSession session)

The constructor for the JobLogModelHelper class.

Parameters:

parent - - The activity space this is being called from

session - - The user's plumtree session

Method Detail

InitializeDatePickerMgrs

public void InitializeDatePickerMgrs(XPLocale xpLocale,
                                     XPTimeZone xpTimeZone)

This function initializes the manager objects (Page and date) for the date pickers

DeleteJobHistory

public void DeleteJobHistory(XPDateTime xpdtDeleteFrom)

Delete the job history from the passed in date and earlier

Parameters:

xpdtDeleteFrom -

ExitSearchMode

public void ExitSearchMode()

This function returns the viewer to simple read mode

Parameters:

none -

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 -

RetrieveFileForDownload

public void RetrieveFileForDownload(int intInstanceID)

Prepare the log file for download by setting it on a byte array member variable

Parameters:

intInstanceID - - The instance ID of the job log

IsSearchRequest

public boolean IsSearchRequest()

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

Specified by:

IsSearchRequest in interface IJobLogModelRO

Returns:

int

GetSearchString

public java.lang.String GetSearchString()

Returns a string used for searching the job log.

Specified by:

GetSearchString in interface IJobLogModelRO

Returns:

String

GetCurrentLogPage

public int GetCurrentLogPage()

Returns the log page currently being displayed.

Specified by:

GetCurrentLogPage in interface IJobLogModelRO

Returns:

int

GetCurrentPage

public int GetCurrentPage()

Returns CurrentPage setting.

Specified by:

GetCurrentPage in interface IJobLogModelRO

Returns:

int

GetJobID

public int GetJobID()

Returns the jobID.

Specified by:

GetJobID in interface IJobLogModelRO

Returns:

int

GetJobName

public java.lang.String GetJobName()

Returns the jobName.

Specified by:

GetJobName in interface IJobLogModelRO

Returns:

String

GetPTSession

public IPTSession GetPTSession()

Returns the Plumtree Session object.

Specified by:

GetPTSession in interface IJobLogModelRO

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

Returns:

int

GetRunTime

public java.lang.String GetRunTime()

Returns the runTime.

Specified by:

GetRunTime in interface IJobLogModelRO

Returns:

String

GetLogFile

public byte[] GetLogFile()

Returns the log file in byte array format

Specified by:

GetLogFile in interface IJobLogModelRO

Returns:

byte[]

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

GetDatePickerControlManager

public JSDatePickerMgr GetDatePickerControlManager()

Get the Date picker control manager

Specified by:

GetDatePickerControlManager in interface IJobLogModelRO

Returns:

JSDatePickerMgr

GetPageMgr

public PageMgr GetPageMgr()

Returns:

PageMgr