|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.portalpages.common.joblogs.JobLogModel
public class JobLogModel
This is a helper model class implemented to support the display and browsing of Job histories and job logs.
Field Summary | |
---|---|
static java.lang.String |
DELETE_THROUGH
Unique identifier for delete through date picker |
static java.lang.String |
FILTER_FROM
Unique identifier for filter from date picker |
static java.lang.String |
FILTER_TO
Unique identifier for filter to date picker |
static java.lang.String |
STR_MVC_CLASS_NAME
Unique identifier for the model |
Constructor Summary | |
---|---|
JobLogModel()
|
Method Summary | |
---|---|
void |
CleanupAllData()
This method is called when an ActivitySpace is removed from the cache. |
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. |
void |
DeleteJobHistory(XPDateTime xpdtDeleteFrom)
Delete the job history from the passed in date and earlier |
void |
ExitSearchMode()
Returns the job viewer to non-search mode. |
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. |
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. |
void |
RetrieveFileForDownload(int intInstanceID)
Prepare the log file for download by setting it on a byte array member variable |
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 java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String STR_MVC_CLASS_NAME
public static final java.lang.String FILTER_FROM
public static final java.lang.String FILTER_TO
public static final java.lang.String DELETE_THROUGH
Constructor Detail |
---|
public JobLogModel()
Method Detail |
---|
public void Init(AActivitySpace parent)
Init
in interface IModel
parent
- public java.lang.Object Create()
IManagedObject
Create
in interface IManagedObject
IManagedObject.Create()
public void CleanupTempData()
IModel
CleanupTempData
in interface IModel
IModel.CleanupTempData()
public void CleanupAllData()
IModel
CleanupAllData
in interface IModel
IModel.CleanupAllData()
public void Finish()
IRepostModel
Finish
in interface IRepostModel
IRepostModel.Finish()
public Redirect GetRedirectAfterFinish()
IRepostModel
GetRedirectAfterFinish
in interface IRepostModel
IRepostModel.GetRedirectAfterFinish()
public java.lang.String GetName()
GetName
in interface IMVCObject
public void DeleteJobHistory(XPDateTime xpdtDeleteFrom)
xpdtDeleteFrom
- public void ExitSearchMode()
public int[] GetArrayOfJobsToKill(XPHashtable _htFormData)
_htFormData
-
public void KillJobs(XPHashtable _htFormData)
_htFormData
- public void RetrieveFileForDownload(int intInstanceID)
intInstanceID
- - The instance ID of the job logpublic boolean IsSearchRequest()
IsSearchRequest
in interface IJobLogModelRO
public java.lang.String GetSearchString()
GetSearchString
in interface IJobLogModelRO
public int GetCurrentLogPage()
GetCurrentLogPage
in interface IJobLogModelRO
public int GetCurrentPage()
GetCurrentPage
in interface IJobLogModelRO
public int GetJobID()
GetJobID
in interface IJobLogModelRO
public java.lang.String GetJobName()
GetJobName
in interface IJobLogModelRO
public IPTSession GetPTSession()
GetPTSession
in interface IJobLogModelRO
public int GetRowToDisplay()
GetRowToDisplay
in interface IJobLogModelRO
public java.lang.String GetRunTime()
GetRunTime
in interface IJobLogModelRO
public void SetLogSearchPage(java.lang.String strSearchText)
SearchTerm
- to be applied against the log textpublic void SetCurrentLogPage(int currentLogPage)
currentLogPage
- The currentLogPage to setpublic void SetCurrentPage(int _intCurrentPage)
public void SetJobID(int jobID)
jobID
- The jobID to setpublic void SetJobName(java.lang.String jobName)
jobName
- The jobName to setpublic void SetRowToDisplay(int rowToDisplay)
rowToDisplay
- The rowToDisplay to setpublic void SetRunTime(java.lang.String runTime)
runTime
- The runTime to setpublic byte[] GetLogFile()
GetLogFile
in interface IJobLogModelRO
public JSDatePickerMgr GetDatePickerControlManager()
GetDatePickerControlManager
in interface IJobLogModelRO
public int SavePage(java.lang.String _sPageName, XPHashtable _htFormData)
IRepostModel
SavePage
in interface IRepostModel
IRepostModel.SavePage(String, XPHashtable)
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |