Class ObjectHooks


  • public class ObjectHooks
    extends java.lang.Object
    Object hooks wrapper with try/catch
    • Constructor Detail

      • ObjectHooks

        public ObjectHooks()
    • Method Detail

      • postLoad

        public static void postLoad​(ObjectDB obj)
        Post load
        Parameters:
        obj - object
      • initCopy

        public static void initCopy​(ObjectDB obj)
        Init copy
        Parameters:
        obj - Object
      • initCreate

        public static void initCreate​(ObjectDB obj)
        Init create
        Parameters:
        obj - Object
      • initUpdate

        public static void initUpdate​(ObjectDB obj)
        Init update
        Parameters:
        obj - Object
      • initUpdateAll

        public static void initUpdateAll​(ObjectDB obj)
        Init update all
        Parameters:
        obj - Object
      • initDelete

        public static void initDelete​(ObjectDB obj)
        Init delete
        Parameters:
        obj - Object
      • initList

        public static void initList​(ObjectDB obj,
                                    ObjectDB parent)
        Init list
        Parameters:
        obj - Object
        parent - Optional parent object
      • initRefSelect

        public static void initRefSelect​(ObjectDB obj,
                                         ObjectDB parent)
        Init reference selection
        Parameters:
        obj - Object
        parent - Parent object
      • initAssociate

        public static void initAssociate​(ObjectDB obj,
                                         ObjectDB parent)
        Init bulk association
        Parameters:
        obj - Object
        parent - Parent object
      • initDataMapSelect

        public static void initDataMapSelect​(ObjectDB obj,
                                             java.lang.String dataMapName,
                                             ObjectDB parent)
        Init datamap selection
        Parameters:
        obj - Object
        dataMapName - Datamap name
        parent - Parent object
      • initExport

        public static void initExport​(ObjectDB obj)
        Init export
        Parameters:
        obj - Object
      • initCrosstab

        public static void initCrosstab​(ObjectDB obj,
                                        java.lang.String crosstabName)
        Init crosstab
        Parameters:
        obj - Object
        crosstabName - Crosstab name
      • initPrintTemplate

        public static void initPrintTemplate​(ObjectDB obj,
                                             java.lang.String printTemplateName)
        Init print template
        Parameters:
        obj - Object
        printTemplateName - Print template name
      • initAgenda

        public static void initAgenda​(ObjectDB obj,
                                      Agenda agenda)
        Init agenda
        Parameters:
        obj - Object
        agenda - Agenda
      • initPlaceMap

        public static void initPlaceMap​(ObjectDB obj,
                                        PlaceMap placemap)
        Init place map
        Parameters:
        obj - Object
        placemap - Place map
      • initSearch

        public static void initSearch​(ObjectDB obj)
        Init search
        Parameters:
        obj - Object
      • initAction

        public static void initAction​(ObjectDB obj,
                                      Action action)
        Init action
        Parameters:
        obj - Object
        action - Action
      • preValidateSearch

        public static java.util.List<java.lang.String> preValidateSearch​(ObjectDB obj)
        Pre validate search
        Parameters:
        obj - Object
        Returns:
        Null or messages
      • postValidateSearch

        public static java.util.List<java.lang.String> postValidateSearch​(ObjectDB obj)
        Post validate search
        Parameters:
        obj - Object
        Returns:
        Null or messages
      • preValidate

        public static java.util.List<java.lang.String> preValidate​(ObjectDB obj)
        Pre validate
        Parameters:
        obj - Object
        Returns:
        Null or messages
      • postValidate

        public static java.util.List<java.lang.String> postValidate​(ObjectDB obj)
        Post validate
        Parameters:
        obj - Object
        Returns:
        Null or messages
      • preStateTransition

        public static java.util.List<java.lang.String> preStateTransition​(ObjectDB obj,
                                                                          java.lang.String fromStatus,
                                                                          java.lang.String toStatus)
        Pre state transition
        Parameters:
        obj - Object
        fromStatus - From status code
        toStatus - To status code
        Returns:
        Null or messages
      • getCount

        public static long getCount​(ObjectDB obj,
                                    int maxRows)
        Count rows
        Parameters:
        obj - Object
        maxRows - Page size or 0
        Returns:
        search count
      • preCount

        public static void preCount​(ObjectDB obj)
        Pre count
        Parameters:
        obj - Object
      • preSearch

        public static void preSearch​(ObjectDB obj)
        Pre search
        Parameters:
        obj - Object
      • postSearchRow

        public static java.lang.String[] postSearchRow​(ObjectDB obj,
                                                       java.lang.String[] row)
        Post search a record
        Parameters:
        obj - Object
        row - Found row
        Returns:
        row
      • postSearch

        public static java.util.List<java.lang.String[]> postSearch​(ObjectDB obj,
                                                                    java.util.List<java.lang.String[]> rows)
        Post search
        Parameters:
        obj - Object
        rows - Found rows
        Returns:
        List of rows
      • preCrosstabSearch

        public static void preCrosstabSearch​(ObjectDB obj,
                                             Crosstab ctb)
        Pre pivot table search
        Parameters:
        obj - Object
        ctb - Pivot table
      • postCrosstabSearch

        public static java.util.List<java.lang.String[]> postCrosstabSearch​(ObjectDB obj,
                                                                            Crosstab ctb,
                                                                            java.util.List<java.lang.String[]> rows)
        Post pivot table search
        Parameters:
        obj - Object
        ctb - Pivot table
        rows - Found rows
        Returns:
        List of rows
      • preObjectSearch

        public static void preObjectSearch​(ObjectDB obj)
        Pre object search (datamap or ref select)
        Parameters:
        obj - Object
      • postObjectSearch

        public static java.util.List<java.lang.String[]> postObjectSearch​(ObjectDB obj,
                                                                          java.util.List<java.lang.String[]> rows)
        Post object search (datamap or ref select)
        Parameters:
        obj - Object
        rows - Found rows
        Returns:
        List of rows
      • preSelect

        public static void preSelect​(ObjectDB obj,
                                     java.lang.String rowId,
                                     boolean copy)
        Pre select a record
        Parameters:
        obj - Object
        rowId - Row ID
        copy - select for copy?
      • postSelect

        public static void postSelect​(ObjectDB obj,
                                      java.lang.String rowId,
                                      boolean copy)
        Post select a record
        Parameters:
        obj - Object
        rowId - row ID
        copy - select for copy?
      • preCreate

        public static java.lang.String preCreate​(ObjectDB obj)
        Pre create
        Parameters:
        obj - Object
        Returns:
        null or message
      • postCreate

        public static java.lang.String postCreate​(ObjectDB obj)
        Post create
        Parameters:
        obj - Object
        Returns:
        null or message
      • preUpdate

        public static java.lang.String preUpdate​(ObjectDB obj)
        Pre update
        Parameters:
        obj - Object
        Returns:
        null or message
      • postUpdate

        public static java.lang.String postUpdate​(ObjectDB obj)
        Post update
        Parameters:
        obj - Object
        Returns:
        null or message
      • preSave

        public static java.lang.String preSave​(ObjectDB obj)
        Pre save
        Parameters:
        obj - Object
        Returns:
        null or message
      • postSave

        public static java.lang.String postSave​(ObjectDB obj)
        Post save
        Parameters:
        obj - Object
        Returns:
        null or message
      • preDelete

        public static java.lang.String preDelete​(ObjectDB obj)
        Pre delete
        Parameters:
        obj - Object
        Returns:
        null or message
      • postDelete

        public static java.lang.String postDelete​(ObjectDB obj)
        Post save
        Parameters:
        obj - Object
        Returns:
        null or message
      • preUpdateAll

        public static java.lang.String preUpdateAll​(ObjectDB obj,
                                                    Parameters params)
        Pre update all
        Parameters:
        obj - Object
        Returns:
        null or message
      • postUpdateAll

        public static void postUpdateAll​(ObjectDB obj,
                                         Parameters params)
        Post update all
        Parameters:
        obj - Object
        params - Parameters
      • preDeleteAll

        public static java.lang.String preDeleteAll​(ObjectDB obj)
        Pre delete all
        Parameters:
        obj - Object
        Returns:
        null or message
      • postDeleteAll

        public static java.lang.String postDeleteAll​(ObjectDB obj)
        Post delete all
        Parameters:
        obj - Object
        Returns:
        null or message
      • initTimesheet

        public static void initTimesheet​(ObjectDB obj,
                                         Timesheet ts)
        Init timesheet
        Parameters:
        obj - Object
        ts - Timesheet
      • preSaveTimesheet

        public static java.util.List<java.lang.String> preSaveTimesheet​(ObjectDB obj,
                                                                        Timesheet ts)
        Pre save timesheet
        Parameters:
        obj - Object
        ts - Timesheet
        Returns:
        null or messages
      • postSaveTimesheet

        public static java.util.List<java.lang.String> postSaveTimesheet​(ObjectDB obj,
                                                                         Timesheet ts)
        Post save timesheet
        Parameters:
        obj - Object
        ts - Timesheet
        Returns:
        null or messages
      • getPredefinedSearches

        public static java.util.List<PredefinedSearch> getPredefinedSearches​(ObjectDB obj)
        List predefined searches
        Parameters:
        obj - Object
        Returns:
        List of predefined searches
      • preSavePredefinedSearch

        public static java.lang.String preSavePredefinedSearch​(ObjectDB obj,
                                                               PredefinedSearch ps)
        Pre save predefined search
        Parameters:
        obj - Object
        ps - Search
        Returns:
        null or message
      • postSavePredefinedSearch

        public static void postSavePredefinedSearch​(ObjectDB obj,
                                                    PredefinedSearch ps)
        Post save predefined search
        Parameters:
        obj - Object
        ps - Search
      • preExport

        public static void preExport​(ObjectDB obj)
        Pre export data
        Parameters:
        obj - Object
      • postExport

        public static java.util.List<java.lang.String[]> postExport​(ObjectDB obj,
                                                                    java.util.List<java.lang.String[]> rows)
        Post export data
        Parameters:
        obj - Object
        rows - Found records
        Returns:
        List of records
      • preImport

        public static java.lang.String preImport​(ObjectDB obj)
        Pre import
        Parameters:
        obj - Object
        Returns:
        null or message
      • postImport

        public static java.lang.String postImport​(ObjectDB obj)
        Post import
        Parameters:
        obj - Object
        Returns:
        null or message
      • isMergeMaster

        public static boolean isMergeMaster​(ObjectDB obj)
        Merge master
        Parameters:
        obj - Object
        Returns:
        true if the object is the master to merge into
      • isMergeEnable

        public static java.lang.String isMergeEnable​(ObjectDB obj,
                                                     java.util.List<java.lang.String> ids)
        Is merge enabled ?
        Parameters:
        obj - Object
        ids - List of row IDs to merge
        Returns:
        true if allowed
      • isStateTransitionEnable

        public static boolean isStateTransitionEnable​(ObjectDB obj,
                                                      java.lang.String fromStatus,
                                                      java.lang.String toStatus)
        Is a state transition permitted?
        Parameters:
        obj - Object
        fromStatus - From status
        toStatus - To status
        Returns:
        true if permitted
      • isCrosstabEnable

        public static boolean isCrosstabEnable​(ObjectDB obj,
                                               java.lang.String crosstab)
        Is crosstab enabled?
        Parameters:
        obj - Object
        crosstab - Crosstab name
        Returns:
        true if permitted
      • canFollowLink

        public static boolean canFollowLink​(ObjectDB obj,
                                            ObjectField field)
        Can follow a link?
        Parameters:
        obj - Object
        field - Field
        Returns:
        true if navigable
      • canCreateOnLink

        public static boolean canCreateOnLink​(ObjectDB obj,
                                              ObjectField field)
        Can create on link?
        Parameters:
        obj - Object
        field - Field
        Returns:
        true if permitted
      • isHistoric

        public static boolean isHistoric​(ObjectDB obj)
        Is object history enabled?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • isUndoable

        public static boolean isUndoable​(ObjectDB obj,
                                         java.lang.String action)
        Is unodable
        Parameters:
        obj - Object
        action - CRUD
        Returns:
        true if undoable
      • preUndo

        public static boolean preUndo​(ObjectDB obj)
        Pre undo
        Parameters:
        obj - Object
        Returns:
        true if undoable
      • postUndo

        public static void postUndo​(ObjectDB obj)
        Post undo
        Parameters:
        obj - Object
      • preRedo

        public static boolean preRedo​(ObjectDB obj)
        Pre redo
        Parameters:
        obj - Object
        Returns:
        true id redoable
      • postRedo

        public static void postRedo​(ObjectDB obj)
        Post redo
        Parameters:
        obj - Object
      • getExportFileName

        public static java.lang.String getExportFileName​(ObjectDB obj,
                                                         java.lang.String media,
                                                         java.lang.String name,
                                                         java.lang.String[] row)
        Export file name
        Parameters:
        obj - Object
        media - Media
        name - Default file name
        row - Record
        Returns:
        New file name
      • getStyle

        public static java.lang.String getStyle​(ObjectDB obj,
                                                ObjectField f,
                                                java.lang.String[] row)
        Get field style
        Parameters:
        obj - Object
        f - Field
        row - Record
        Returns:
        CSS class name or null
      • getStyle

        public static java.lang.String getStyle​(ObjectDB obj,
                                                ObjectField f,
                                                double d)
        Get float style
        Parameters:
        obj - Object
        f - Field
        d - Value
        Returns:
        CSS class style or null
      • getStyleTree

        public static java.lang.String getStyleTree​(ObjectDB obj,
                                                    TreeView tv,
                                                    java.lang.String[] row)
        Get treeview style
        Parameters:
        obj - Object
        tv - Tree view
        row - Record
        Returns:
        CSS class name or null
      • getImage

        public static java.lang.String getImage​(ObjectDB obj,
                                                ObjectField f,
                                                java.lang.String val)
        Get field image
        Parameters:
        obj - Object
        f - Field
        val - Value
        Returns:
        Image name or null
      • getImage

        public static java.lang.String getImage​(ObjectDB obj,
                                                ObjectField f,
                                                java.lang.String[] row)
        Get field image
        Parameters:
        obj - Object
        f - Field
        row - Record
        Returns:
        Image name or null
      • getImageTree

        public static java.lang.String getImageTree​(ObjectDB obj,
                                                    TreeView tv,
                                                    java.lang.String[] row)
        Get treeview image
        Parameters:
        obj - Object
        tv - Treeview
        row - Record
        Returns:
        Image name or null
      • getHelp

        public static java.lang.String getHelp​(ObjectDB obj)
        Get user help
        Parameters:
        obj - Object
        Returns:
        Object help or null
      • getCtxHelp

        public static java.lang.String getCtxHelp​(ObjectDB obj,
                                                  java.lang.String helpContext)
        Get contextual help
        Parameters:
        obj - Object
        helpContext - Context
        Returns:
        Help or null
      • preAlert

        public static java.lang.String preAlert​(ObjectDB obj,
                                                Alert a)
        Pre alert
        Parameters:
        obj - Object
        a - Alert
        Returns:
        null or message
      • customAlert

        public static java.lang.String customAlert​(ObjectDB obj,
                                                   Alert a,
                                                   java.lang.String subject,
                                                   java.lang.String body,
                                                   java.util.List<DocumentDB> docs)
        Custom alert
        Parameters:
        obj - Object
        a - Alert
        subject - Subject
        body - Body
        docs - Optional attachments
        Returns:
        null or message
      • postAlert

        public static java.lang.String postAlert​(ObjectDB obj,
                                                 Alert a)
        Post alert
        Parameters:
        obj - Object
        a - Alert
        Returns:
        null or message
      • getDeadlineDate

        public static java.util.Date getDeadlineDate​(ObjectDB obj,
                                                     java.lang.String row_id,
                                                     java.lang.String state,
                                                     java.lang.String update_dt,
                                                     int timeout)
        Get status deadline
        Parameters:
        obj - Object
        row_id - Row ID
        state - Status code
        update_dt - Last update date
        timeout - Default timeout
        Returns:
        Date or null
      • getEmailRecipientType

        public static char getEmailRecipientType​(ObjectDB obj,
                                                 java.lang.String alert,
                                                 java.lang.String email,
                                                 char type)
        Email recipient type
        Parameters:
        obj - Object
        alert - Alert
        email - Email
        type - Default type
        Returns:
        New type TO/CC/BCC
      • getGroupEmailRecipientType

        public static char getGroupEmailRecipientType​(ObjectDB obj,
                                                      java.lang.String alert,
                                                      java.lang.String group,
                                                      char type)
        Email recipient type
        Parameters:
        obj - Object
        alert - Alert
        group - Group name
        type - Default type
        Returns:
        New type TO/CC/BCC
      • spamEmail

        public static boolean spamEmail​(ObjectDB obj,
                                        java.lang.String alert,
                                        java.lang.String group,
                                        java.lang.String email)
        Email available?
        Parameters:
        obj - Object
        alert - Alert
        group - Group name
        email - Email
        Returns:
        true if email is permitted
      • spamGroup

        public static boolean spamGroup​(ObjectDB obj,
                                        java.lang.String alert,
                                        java.lang.String group)
        Group emails available?
        Parameters:
        obj - Object
        alert - Alert
        group - Group name
        Returns:
        true if emails of group are permitted
      • fieldCompletion

        public static java.util.List<java.lang.String> fieldCompletion​(ObjectDB obj,
                                                                       java.lang.String field,
                                                                       java.lang.String query,
                                                                       java.lang.String context)
        Field completion
        Parameters:
        obj - Object
        field - Field name
        query - User query
        context - Context
        Returns:
        List of matching response
      • getMappedExportPath

        public static java.lang.String getMappedExportPath​(ObjectDB obj,
                                                           java.lang.String[] row)
        Data export path
        Parameters:
        obj - Object
        row - Record
        Returns:
        Path
      • getMappedFilePath

        public static java.lang.String getMappedFilePath​(ObjectDB obj,
                                                         ObjectField f)
        File export path
        Parameters:
        obj - Object
        f - Field with document
        Returns:
        Path
      • unitTests

        public static java.lang.String unitTests​(ObjectDB obj)
        Unit test
        Parameters:
        obj - Object
        Returns:
        Unit test return
      • getSocialShareData

        public static SocialShareData getSocialShareData​(ObjectDB obj)
        Social share data
        Parameters:
        obj - Object
        Returns:
        data
      • isCreateEnable

        public static boolean isCreateEnable​(ObjectDB obj)
        Is create permitted?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • isCopyEnable

        public static boolean isCopyEnable​(ObjectDB obj,
                                           java.lang.String[] row)
        Is copy permitted?
        Parameters:
        obj - Object
        row - Record
        Returns:
        true if permitted
      • isUpdateEnable

        public static boolean isUpdateEnable​(ObjectDB obj,
                                             java.lang.String[] row)
        Is update permitted?
        Parameters:
        obj - Object
        row - Record
        Returns:
        true if permitted
      • isDeleteEnable

        public static boolean isDeleteEnable​(ObjectDB obj,
                                             java.lang.String[] row)
        Is delete permitted?
        Parameters:
        obj - Object
        row - Record
        Returns:
        true if permitted
      • isOpenEnable

        public static boolean isOpenEnable​(ObjectDB obj,
                                           java.lang.String[] row)
        Is open permitted?
        Parameters:
        obj - Object
        row - Record
        Returns:
        true if permitted
      • getUserKeyLabel

        public static java.lang.String getUserKeyLabel​(ObjectDB obj,
                                                       java.lang.String[] row)
        User key label
        Parameters:
        obj - Object
        row - Record
        Returns:
        User key to display
      • getUserKeySearch

        public static java.lang.String getUserKeySearch​(ObjectDB obj,
                                                        java.lang.String[] row)
        User key search
        Parameters:
        obj - Object
        row - Record
        Returns:
        User key to display on index search
      • getTargetObject

        public static java.lang.String[] getTargetObject​(ObjectDB obj,
                                                         java.lang.String rowId,
                                                         java.lang.String[] row)
        Get target object
        Parameters:
        obj - Object
        rowId - Row ID
        row - Optional record
        Returns:
        Array of object + instance + id
      • canListAccessNewForm

        public static boolean canListAccessNewForm​(ObjectDB obj)
        Can list access new form?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canListAccessNewLoop

        public static boolean canListAccessNewLoop​(ObjectCore obj)
        Can list access new loop?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canListAccessNewLine

        public static boolean canListAccessNewLine​(ObjectCore obj)
        Can list access new line
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canSelectRow

        public static boolean canSelectRow​(ObjectCore obj)
        Can select rows on UI?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canGroupByFields

        public static boolean canGroupByFields​(ObjectDB obj)
        Can group by fields
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canSave

        public static boolean canSave​(ObjectDB obj)
        Display the save button?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canSaveAndClose

        public static boolean canSaveAndClose​(ObjectDB obj)
        Display the save and close button?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canClose

        public static boolean canClose​(ObjectDB obj)
        Display the close button?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canSaveAndNew

        public static boolean canSaveAndNew​(ObjectDB obj)
        Display the save and new button?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canSaveAndCopy

        public static boolean canSaveAndCopy​(ObjectDB obj)
        Display the save and copy button?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canExport

        public static boolean canExport​(ObjectCore obj)
        Can export data?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • isExportAllowed

        public static java.lang.String isExportAllowed​(ObjectCore obj,
                                                       java.lang.String mode,
                                                       java.lang.String media,
                                                       java.lang.String rowId)
        Is requested export allowed?
        Parameters:
        obj - Object
        mode - ObjectXML.MODE_*
        media - ServletTool.MEDIA_*
        rowId - Optional ID (form export)
        Returns:
        Error to denied export, Warning to confirm on UI or null to allow export
      • canPrint

        public static boolean canPrint​(ObjectDB obj)
        Can print data?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canCopy

        public static boolean canCopy​(ObjectCore obj)
        Can copy data?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canUpdateAll

        public static boolean canUpdateAll​(ObjectCore obj,
                                           ObjectField f)
        Can update all selected rows?
        Parameters:
        obj - Object
        f - Optional field
        Returns:
        true if permitted
      • canDeleteAll

        public static boolean canDeleteAll​(ObjectCore obj)
        Can delete all selected rows?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • canPreview

        public static boolean canPreview​(ObjectCore obj,
                                         ObjectField f,
                                         DocumentDB doc)
        Can preview a document?
        Parameters:
        obj - Object
        Returns:
        true if permitted
      • isPrintTemplateEnable

        public static boolean isPrintTemplateEnable​(ObjectDB obj,
                                                    java.lang.String[] row,
                                                    java.lang.String pt)
        Is print template permitted?
        Parameters:
        obj - Object
        row - Record
        pt - Print template name
        Returns:
        true if permitted
      • isActionEnable

        public static boolean isActionEnable​(ObjectDB obj,
                                             Action action,
                                             java.lang.String[] row)
        Is action enabled?
        Parameters:
        obj - Object
        action - Action
        row - Optional record
        Returns:
        true if permitted
      • canReference

        public static boolean canReference​(ObjectDB obj,
                                           java.lang.String target,
                                           java.lang.String fk)
        Can display the referenced child list?
        Parameters:
        obj - Object
        target - Target object
        fk - Foreign key field name
        Returns:
        true if permitted