Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / EnsPortal.ScheduleEditor
Private  Storage   

EnsPortal.ScheduleEditor


class EnsPortal.ScheduleEditor extends
EnsPortal.Template.standardPage

Ensemble schedule spec editor. Schedules are used to schedule resources and alerts.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
3 9 48


Summary


This is a Zen Page class. It belongs to the application EnsPortal.Application.

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
ParentURL StdTitle aboutPage addMode
align aux backgroundTimerInterval canEdit
cellAlign cellSize cellStyle cellVAlign
children composite containerStyle cssLevel
currSortMode currStep currViewMode disabled
dragAndDrop dragEnabled dropEnabled editMode
enclosingClass enclosingStyle error groupClass
groupStyle height hidden hint
hintClass hintStyle home homePage
id index keepAliveInterval label
labelClass labelDisabledClass labelPosition labelStyle
layout lblAdd lblEdit lblTitle
limitPopups msgDate msgDelete msgNotPermitted
name onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate pageModified parent
scheduleId scheduleString searchKey selectedRow
showLabel slice title tuple
useSVG useSoftModals valign visible
width window zenPersistentPopup

Methods
%AddCSPShareHyperevents %AddChild %AddChildAfter %AddChildBefore
%AddComponent %AddEnsExceptionHandler %AddImportedComponents %AddLocatorLinks
%AddToSaveSet %ApplyURLParms %Attr %BindExport
%ClassIsLatestVersion %ClassName %ConstructClone %DispatchClassMethod
%DispatchGetModified %DispatchGetProperty %DispatchMethod %DispatchSetModified
%DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout %DrawClassDefinitions
%DrawComponentHTML %DrawHTML %DrawHTMLPage %DrawJSStrings
%DrawObjectDefinitions %EnclosingDivId %EndBackgroundMethod %EndScript
%Eval %EvalC %Extends %ForceClientRender
%GetChildIndex %GetComponent %GetComponentById %GetComponentByName
%GetEventHandlers %GetHomePage %GetHomeParam %GetLinks
%GetLocatorLinks %GetPageName %GetParameter %GetProductName
%GetValueById %GetValueByName %GetXMLName %IsA
%IsModified %Link %LinkCSS %LinkScript
%MakeId %New %NormalizeObject %ObjectModified
%OnAddToPageAfter %OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage
%OnCreateApplication %OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv
%OnDrawHTMLBody %OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties
%OnFinishBackgroundTask %OnGetPageName %OnGetProductName %OnGetSmallMenu
%OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch
%OnPreHTTP %OnSubmit %OnUseSoftModals %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%Register %RemoveChild %RemoveChildren %RemoveComponent
%RemoveFromSaveSet %RunBackgroundMethod %Self %SerializeObject
%SetBackgroundMethodStatus %SetErrorById %SetErrorByName %SetModified
%SetValueById %SetValueByName %SetValuesByName %StartScript
%ValidateObject %ZENVersion BuildMenu CheckAllBlanks
CheckContextLinks CheckEnterpriseManager ConvertParameter Decrypt
DeleteID DoLogout DrawListing1 DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL EvalResult GetCSPURL GetContextLinks
GetDocPage GetHomePage GetHyperEventResources GetNewURL
GetQuickLinks GetScheduleInfo HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsPrivate
Link LoadSchedule OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
QuoteJS RegisterRecent RewriteURL SaveData
ShowError SimpleKeepAlive StartTimer StopTimer
ThrowError UnescapeHTML UnescapeURL ValidateScheduleString
XMLDTD XMLExport XMLExportToStream XMLExportToString
XMLNew XMLSchema XMLSchemaNamespace XMLSchemaType
addChild addChildAfter addChildBefore addItem
addPopupSuffix adjustSizes applyRawToView arrowClick
cancelPopup cancelRaw changeFrequency changeMonthly
changePassword changeSchedule changeURLNamespace checkEdit
childrenMutated clearFields clientKeepAlive correctIELayering
createComponent createComponentNS deleteComponent deleteSchedule
disableCommandButton dragFinishHandler dragHandler dragNotifyHandler
dragStartHandler dropHandler dropStartHandler enableCommandButton
endModal exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getDialogValue getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getProperty getSettings getTitleAreaHeight getType
goHome goMenu gotoAdded gotoNamespace
gotoNotSelected gotoPage gotoSelected hideCommandButton
inResizeLoop initPopupSuffix invokeSuper isOfType
launchPopupWindow logout makeId navigate
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondisabledHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onunloadHandler
onupdateHandler popupActionHandler refreshCalendar refreshContents
refreshList removeChild removeEmptyRow removeItem
removePopupSuffix render renderContents renderSVG
saveCurrentStringAndName saveDeployable saveDescription saveRaw
saveRawSchedule saveSchedule searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress selectDate
selectItem selectRow selectSchedule setActionsHidden
setComponentId setConnectivityStatusMsg setHidden setModified
setOverlayMode setProperty setPropertyAll setScheduleEndTime
setScheduleInterval setScheduleStartTime setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showDocumentation showHelp showWorkArea
startKeepAlive startModal startProgressBar stopKeepAlive
stopProgressBar switchNamespace updateSchedule


Parameters


• parameter EDITRESOURCE = "%Ens_ProductionConfig:WRITE";
User needs WRITE permissions on the %Ens_ProductionConfig resource to edit this page.
• parameter PAGENAME = "Schedule Editor";
Displayed name of this page.
• parameter RESOURCE = "%Ens_ProductionConfig:READ";
User needs READ permissions on the %Ens_ProductionConfig resource to view this page.

Properties


• property addMode as %ZEN.Datatype.boolean;
whether or not the page is in add mode
• property editMode as %String(ZENURL="editMode");
Value of schedule string currently being edited.
• property lblAdd as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Add New Item Below") ];
• property lblEdit as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Edit Setting Below") ];
• property msgDate as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Please select a date!") ];
• property msgDelete as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Are you sure you want to remove this item?") ];
• property scheduleId as %String(ZENURL="scheduleId");
ID of schedule spec to display.
• property scheduleString as %String(ZENURL="schedule");
Value of schedule string currently being edited.
• property selectedRow as %ZEN.Datatype.integer;
Selected row in listing mode.

Methods


• method %OnAfterCreatePage() as %Status
Decorate the page.
• method %OnGetPageName() as %String
Get the (localized) name of the page.
• method %OnGetTitle() as %String
Get the (localized) title string for the page.
• classmethod DeleteID(id) as %String [ ZenMethod ]
Delete the given id.
• method DrawListing1(pSeed As %String) as %Status
Draw table under Description with Schedule view mode = calendar.
• classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
• classmethod GetScheduleInfo(ByRef pParms As %String, pBeginDate As %Date, pEndDate As %Date, ByRef pInfo As %List) as %Boolean
GetScheduleInfo callback for the Schedule Page.
This method returns the set of scheduled items that should be displayed on the schedulePane.
• classmethod LoadSchedule(scheduleId) as %ZEN.proxyObject [ ZenMethod ]
Load up the properties of the named schedule into the properties of the proxy object
• method OnDrawRibbon() as %Status
Add to the contents of the tool ribbon.
• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
• classmethod SaveData(pScheduleId As %String, Description As %String, scheduleString As %String, pDeployable As %Boolean) as %String [ ZenMethod ]
Save modified schedule to server.
• classmethod ValidateScheduleString(txt) as %String [ ZenMethod ]
Delete the given id.
• method addItem() [ Language = javascript ]
user clicked "Add Item". Reset the selectedRow to null, refresh table and show action block.
• method adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
• method applyRawToView() [ Language = javascript ]
user wishes to apply the current raw string to the entire schedule view
• method cancelRaw(action) [ Language = javascript ]
simply return to the production configuration page
• method changeFrequency(choice) [ Language = javascript ]
• method changeMonthly(choice) [ Language = javascript ]
enable/disable radio buttons for monthly
• method changeSchedule() [ Language = javascript ]
user selected a Schedule spec from drop-down
• method clearFields() [ Language = javascript ]
• method deleteSchedule() [ Language = javascript ]
User clicked Delete button.
• method getDialogValue() [ Language = javascript ]
• method gotoAdded() [ Language = javascript ]
• method gotoNotSelected() [ Language = javascript ]
• method gotoSelected() [ Language = javascript ]
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event, if present, is fired when the a popup page launched from this page fires an action.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method refreshCalendar() [ Language = javascript ]
Refresh list and calendar
• method refreshList() [ Language = javascript ]
Refresh list
• method removeEmptyRow() [ Language = javascript ]
• method removeItem() [ Language = javascript ]
user clicked "Remove Item". If confirmed, remove the matching piece from scheduleString and refresh table.
• method saveCurrentStringAndName() [ Language = javascript ]
• method saveDeployable() [ Language = javascript ]
user changed Deployable flag
• method saveDescription() [ Language = javascript ]
user clicked "Save" by the description.
• method saveRaw(action) [ Language = javascript ]
• method saveRawSchedule() [ Language = javascript ]
user clicked "Save As"
• method saveSchedule() [ Language = javascript ]
user clicked "Save Action". If selectedRow exists then this is Edit. Otherwise it's Add.
• method selectDate(date) [ Language = javascript ]
User has selected a new date in the calendar. Update the schedule pane.
• method selectItem(id, time) [ Language = javascript ]
• method selectRow(row) [ Language = javascript ]
User has selected a row in the listing table.
• method selectSchedule() [ Language = javascript ]
user clicked New. Open New Schedule dialog.
• method setActionsHidden(flag) [ Language = javascript ]
• method setScheduleEndTime(time) [ Language = javascript ]
Change the endTime displayed by the schedulePane.
• method setScheduleInterval(interval) [ Language = javascript ]
Change the time interval displayed by the schedulePane.
• method setScheduleStartTime(time) [ Language = javascript ]
Change the startTime displayed by the schedulePane.
• method showWorkArea(value) [ Language = javascript ]
• method updateSchedule() [ Language = javascript ]