DocBook|Search
Class Reference
%CSP.UI.System.OpenJournalPane
   
Server:basexml
Instance:SOAXML
User:UnknownUser
 
-
  [BASEXML] >  [%CSP] >  [UI] >  [System] >  [OpenJournalPane]
Private  Storage  

class %CSP.UI.System.OpenJournalPane extends %CSP.Util.Pane

This class is used internally by Caché. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

This pane is used to display system journal file contents

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
9


Summary

Properties
Align CommandFormClass CommandFormObject CommandSubmitPage
Commands FrameStyle Name Styles
Text URL

Methods
%%OIDGet %AddToSaveSet %ClassIsLatestVersion %ClassName
%ConstructClone %DispatchClassMethod %DispatchGetModified %DispatchGetProperty
%DispatchMethod %DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty
%Extends %GetParameter %IsA %IsModified
%New %NormalizeObject %ObjectModified %OriginalNamespace
%PackageName %RemoveFromSaveSet %SerializeObject %SetModified
%ValidateObject CancelProfile ComputeJournalProfile DrawBODY
DrawCommandForm DrawCommands DrawHEAD DrawJournalProfile
GenerateCode GetJournalProfile HasDBPermission LocalizeText
OnGenerateCode QuoteCOS RefreshProfile ShowRecordDetails
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType


Methods

• classmethod CancelProfile(pFile As %String)
Called from client to stop a profile calculation.
• classmethod ComputeJournalProfile(pFile As %String)
Given a journal file name, build a profile of the contents of the journal within a temp global. This takes the form:
^CacheTemp.JournalProfile(pFile) = status: 0 running, 1 complete
^CacheTemp.JournalProfile(pFile,"ERROR") = error (if any)
^CacheTemp.JournalProfile(pFile,"PROFILE",database,global) = size of records for this db.global
^CacheTemp.JournalProfile(pFile,"PROFILE","OTHER") = size of other records
• method DrawBODY(pInstance As PageInstance) as %Status
Draw the BODY of the detail pane
• method DrawHEAD(pInstance As PageInstance) as %Status
Overwritten by subclasses to draw anything this pane needs for the HEAD section.
• classmethod DrawJournalProfile(pClear As %Boolean, pFile As %String, pSortBy As %String = "", pMode As %Integer = 0) as %Status
Given a journal file name, Draw an HTML profile of the contents of the journal.
• classmethod GetJournalProfile(pFile As %String, Output pProfile, pClear As %Boolean = 0) as %Status
Given a journal file name, build a profile of the contents of the journal. This takes the form:
pProfile(database,global) = size of records for this db.global
pProfile("OTHER") = size of other records
• classmethod HasDBPermission(tDB As %String) as %Boolean
Returns whether current user's base permissions allow access to given database (directory)
• classmethod RefreshProfile(pClear As %Boolean, pFile As %String, pSortBy As %String = "")
Called from client to update the profile page
• classmethod ShowRecordDetails(pFile As %String, pOffset As %Integer)
Called by client to show details for a journal record