Class SY_CustomFieldLabel_bus

Inherits

CI_CompanyCode_val, CI_DeveloperCode_val, CI_ModuleCode_val, SY_Maint, SY_MaintSet

Known SubClasses

PM_CustomFieldLabel_bus

Properties

LOCAL cMainTable$="SY_CustomFieldLabel"  
LOCAL cIsSysDB=isTRUE  

Methods

FUNCTION CommitRow()  

Override to the same function in SY_MaintSet to include applying text changes to tasks, menus, messages and memos, on a successful commit.

Returns returns value from the call to CommitRow in SY_MaintSet
FUNCTION LOCAL AddApplyInfo(label$, type$, tasks$, secOpts$, memos$, msgs$)  
FUNCTION LOCAL AddApplyInfo(label$, type$, tasks$, secOpts$, memos$, msgs$, rpts$)  

Function to be called by inheriting class, to setup information to be applied. The calling class can add list of tasks, memos, and messages to be applied. This method populates a memory table with the information to apply when the field labels are changed. This memory table will then be used by the ApplyLabelChanges() method.

ParameterDescription
label$ [input, string] label code that these changes to apply are meant for (ie. STEP)
type$ [input, string] one character type to indicate "S"=short description or "L"ong description to use when applying changes
tasks$ [input ,string] comma separated list of task Id's to apply label changes. These are then used in conjunction with the cApplyDevCode$ and cApplyModuleNo$ to lookup tasks & menus.
secOpts$ [input, string] comma separated list of task Id's for security options to apply label changes.
memos$ [input, string] comma separated list of memo codes, to apply field label changes too. This will be used in conjunction with the cApplyMemoCode$
msgs$ [input, string] comma separated list of Message Library codes, to apply field label changes.
rpts$ {optional} [input, string] comma separated list of Report Id's, to apply field label changes.
Returns Always returns retSUCCESS(1)
FUNCTION LOCAL ApplyLabelChanges()  

Applies label changes to the areas defined by the AddApplyInfo() method. This will only apply changes to field labels that change in value, and uses the cApplyChangesToTasks, cApplyChangesToMemos, cApplyChangesToMsgs flags, and the information found in the memory file populated by the AddApplyInfo() method.

Returns Always returns retSUCCESS(1)
FUNCTION LOCAL GetApplyInfo()  

This is a stub function within this class, and inheriting classes should create this method to encompass the AddApplyInfo() calls that define the areas to apply field label changes too.

Returns Always returns retSUCCESS(1)
FUNCTION LOCAL GetLabelChanges$()  

Compares values to previous values and defines a list of labels that have changed. This will populate the memory table used to apply label changes with old and new values, as well as populate and return a string intended for the activity log, to record an audit of changes. This function is called directly after the GetApplyInfo() function is called, both in the CommitRow() prior to calling the CommitRow from SY_MaintSet

Returns [return string] Log entry string intended to be written to the system activity log of all changes to the custom field labels.
FUNCTION LOCAL RenameTasks(tasks$, type$, oldLabel$, newLabel$)  

Renames task table entries for tasks and security options, specified in the AddApplyInfo(). This method will scan for the old text of the label and replace with the new text. Populates a list of tasks that have changed to apply when rebuilding the menu.

ParameterDescription
tasks$ [input, string] Comma separated list of 3 digit task ID's or the fully key to the task table (moduleNumber+taskOwner+developerCode+taskId)
type$ [input, string] Task type to rename "0" = Programs, "2" = Security Events
oldLabel$ [input, string] previous value of label$
newLabel$ [input, string] new value of label$
Returns Always returns retSUCCESS(1)
FUNCTION LOCAL SetChildColl()  
Returns Alwyas returns retSUCCESS(1)
FUNCTION LOCAL ValidateCompanyCode(value$)  

Validates company code using Company Class Validation only if the company code is not "###" which represents all companies.

ParameterDescription
value$ [input, string] Value to be vaildated
Returns [boolean]
ValueDescription
retSUCCESS(1) If valid company code or "###"
retFAILURE(0) If value is not a valid company code.

Properties inherited from: SY_Maint

cActionWrite, cActionDelete, cActivityLogFilePrefix$, DocDateWarnDisplayed, DocDateWarnStatus, EditState, RecordChanged, FirstFailure$, DocumentTotal, ReadOnlyReason$, UDTValidation$, ViewOnly, CurrentPrecision, DocDateWarnForceOff, DocDateWarnObject, ScriptObject, ImportTest, SkipNullCheck$, AFSRequiredFields$

Properties inherited from: SY_MaintSet

FileChanged

Methods inherited from: CI_CompanyCode_val

ClassValidateCompanyCode(), ValidateCompanyKey()

Methods inherited from: CI_DeveloperCode_val

ClassValidateDeveloperCode()

Methods inherited from: CI_ModuleCode_val

ClassValidateModuleCode()

Methods inherited from: SY_Maint

ChangedRecordCompare(), ChangedRecordInfo(), Clear(), ClearRecord(), ConfirmDelete(), CopyFrom(), ExportToCSV(), GetColumnInfo(), GetColumnProperties$(), GetDefaults(), GetOrigRecord$(), GetPropertyValue(), GetValidationGroups$(), ResetDocDateWarnState(), SetCopyKeyValue(), SetDocDateWarnDisplayed(), SetDocDateWarnOff(), SetKey(), SetKeyValue(), SetPartialRecord(), SetRecord(), SetToReadOnly(), SetValue(), SetValues(), Write(), ActivityLogCreateFile(), ActivityLogPrepare(), ActivityLogSetMessage$(), ActivityLogWrite(), CallScript(), CheckForAdvancedFieldSettings(), CheckForScripts(), CheckNullRequiredField(), PERFORM ChildValidate(), ClassValidateDate(), ClassValidateTelephoneNo(), ClearSetFiles(), ColInfoInitAll(), ColInfoInitDefaults(), CommitRow(), GetPropertyCommon(), InitColInfo(), InitScriptEngine(), InitSearchForUpdate(), InitWorkTable(), IsColInIOList(), IsValid(), LoadColInfo(), OpenMainTable(), ParseExtField(), PreWriteScripts(), RemoveColToSkip(), ResetRow(), RetrieveColInfo(), SetDefaults(), SetFilter(), SetMode(), SetParentHandle(), SetValueNoValidate(), StoreColToSkip(), ValidateAll(), ValidateAllRecord(), ValidateColInfo(), ValidateRule()

Methods inherited from: SY_MaintSet

ClearSetFiles(), CommitRow(), QuickRowLoad(), ResetRow(), SeedDetailRow(), SetFilter(), SetMode()