Package com.simplicite.util

Class ObjectService

java.lang.Object

com.simplicite.util.ObjectCore

com.simplicite.util.ObjectDB

com.simplicite.util.ScriptedObjectDB

com.simplicite.util.ObjectService

All Implemented Interfaces:

com.simplicite.util.engine.CacheInterface, java.io.Serializable

Direct Known Subclasses:

ObjectServiceLDAP, ObjectServiceMongoDB, ObjectServiceOpenDataSoft, ObjectServiceREST, ObjectServiceSalesForce, ObjectServiceServiceNow, ObjectServiceSimplicite

public class ObjectService
extends ScriptedObjectDB

Service business object

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.simplicite.util.ObjectDB

ObjectDB.SearchCallback<T>

Field Summary

Fields inherited from class com.simplicite.util.ScriptedObjectDB

SCRIPTED_HOOKS

Fields inherited from class com.simplicite.util.ObjectCore

CONTEXT_ACTION, CONTEXT_AGENDA, CONTEXT_ASSOCIATE, CONTEXT_COPY, CONTEXT_CREATE, CONTEXT_CROSSTAB, CONTEXT_DATAMAPSELECT, CONTEXT_DELETE, CONTEXT_EXPORT, CONTEXT_IMPORT, CONTEXT_LIST, CONTEXT_NONE, CONTEXT_PANELLIST, CONTEXT_PLACEMAP, CONTEXT_POSTVALIDATE, CONTEXT_PREVALIDATE, CONTEXT_PRINTTMPL, CONTEXT_REFSELECT, CONTEXT_SEARCH, CONTEXT_STATETRANSITION, CONTEXT_UPDATE, CONTEXT_UPDATEALL, DB_DERBY, DB_H2, DB_HSQLDB, DB_MSSQL, DB_MYSQL, DB_ORACLE, DB_POSTGRESQL, DB_UNKNOWN, DEL_CASCAD, DEL_IGNORE, DEL_NULL, DEL_RESTRICT, FORM_LAYOUT_COMPACT, FORM_LAYOUT_DEFAULT, LIST_EDIT_ADD, LIST_EDIT_ROWS, LIST_EDIT_UPSERT, PREDEF_SEARCH_NONE, PREDEF_SEARCH_ONLIST, PREDEF_SEARCH_USE_EDIT, PREDEF_SEARCH_USE_ONLY, SEARCH_DIALOG, SEARCH_DOCK, SEARCH_HIDE, SEARCH_LIST, TIMESTAMP_BLOKING, TIMESTAMP_NON_BLOKING, TIMESTAMP_NONE, TIMESTAMP_OPTIMISTIC, TYPE_QUERY, TYPE_SERVICE, TYPE_SERVICE_LDAP, TYPE_SERVICE_MONGODB, TYPE_SERVICE_OPENDATASOFT, TYPE_SERVICE_REST, TYPE_SERVICE_SALESFORCE, TYPE_SERVICE_SERVICENOW, TYPE_SERVICE_SIMPLICITE, VIEW_MODE_ACCORDION, VIEW_MODE_COLLAPSED, VIEW_MODE_EXTENDED, VIEW_MODE_TABS, VIEW_MODE_TABS_VERTICAL

Constructor Summary

Constructors

Constructor	Description
ObjectService()

Method Summary

Modifier and Type	Method	Description
java.lang.Object	actionService(Action action)	Action service
java.lang.Object	actionService(java.lang.String action)	Deprecated. Use actionService with Action argument
long	countService()	Count service
java.lang.String	createService()	Create service
DocumentDB	dbdocService(java.lang.String rowId, java.lang.String fieldName)	Document service
java.lang.String	deleteService()	Delete service
java.util.List<SearchItem>	indexSearchService(java.lang.String query, int limit)	Indexed search service
ObjectDB	load(Grant grant)	Object definition loading
void	loadServiceConfig()	Load configuration
boolean	pingService(boolean resetConfig)	Ping service to check if available
java.lang.Object	printService(PrintTemplate prt)	Publication service
java.util.List<java.lang.String[]>	searchService(boolean pagine)	Search service
boolean	selectService(java.lang.String rowId, boolean copy)	Select item
org.json.JSONObject	serviceConfig()	Deprecated, for removal: This API element is subject to removal in a future version. Use getConfig
java.lang.String	updateService()	Update service

Methods inherited from class com.simplicite.util.ScriptedObjectDB

applyConstraints, applyFieldConstraints, applyObjectConstraints, applyStaticConstraints, applyTargetConstraints, canCreateOnLink, canFollowLink, canReference, canUpdateAll, checkExpression, checkObjectPropConstraints, customAlert, docuSign, evalExpression, fieldCompletion, getAgendaDay, getAgendaLabel, getAgendaSelector, getAgendaValue, getAgendaWeek, getCount, getCtxHelp, getDeadlineDate, getEmailRecipientType, getExportFileName, getGroupEmailRecipientType, getHelp, getImage, getImage, getImageTree, getMappedExportPath, getMappedFilePath, getPredefinedSearches, getSocialShareData, getStyle, getStyle, getStyleTree, getTargetObject, getUserKeyLabel, getUserKeySearch, initAction, initAgenda, initAssociate, initCopy, initCreate, initCrosstab, initDataMapSelect, initDelete, initExport, initList, initPlaceMap, initPrintTemplate, initRefSelect, initSearch, initTimesheet, initUpdate, invokeAction, invokeCallback, invokeCallback, invokeMethod, invokePrint, isActionEnable, isCopyEnable, isCreateEnable, isCrosstabEnable, isDeleteEnable, isExportAllowed, isHistoric, isMergeEnable, isMergeMaster, isOpenEnable, isPrintTemplateEnable, isStateTransitionEnable, isUndoable, isUpdateEnable, postAlert, postCreate, postCrosstabSearch, postDelete, postDeleteAll, postExport, postImport, postLoad, postObjectSearch, postRedo, postSave, postSavePredefinedSearch, postSaveTimesheet, postSearch, postSearchRow, postSelect, postUndo, postUpdate, postUpdateAll, postUpdateAll, postValidate, postValidateSearch, preAlert, preCount, preCreate, preCrosstabSearch, preDelete, preDeleteAll, preExport, preImport, preObjectSearch, preRedo, preSave, preSavePredefinedSearch, preSaveTimesheet, preSearch, preSelect, preStateTransition, preUndo, preUpdate, preUpdateAll, preUpdateAll, preValidate, preValidateSearch, printed, spamEmail, spamGroup, unitTests

Methods inherited from class com.simplicite.util.ObjectDB

addLink, addLinkMetaObject, buildTreeList, canUpdateAllEnum, checkCreateConstraints, checkCreateVisibilities, checkDelete, checkDeleteConstraints, checkDeleteVisibilities, checkUpdateConstraints, checkUpdateVisibilities, clear, completeForeignKeys, completeForeignKeys, count, create, del, delete, delete, deleteTree, editTemplateUsage, evalCalculatedFields, evalCalculatedFields, evalNextRowId, evalObjectCalculatedFields, getAlert, getConsole, getCount, getCountGroupBy, getDirectURL, getFieldDefaultValue, getFileName, getFilePath, getFirstRowId, getInterface, getLastRowId, getNextRowId, getParentObject, getPreviousRowId, getQuery, getRefCalc, getRefCount, getSearchSpec, getStyle, getTool, getUserKeyList, hasFieldConstraints, hasTargetConstraints, init, initFromTable, initUpdateAll, insertTree, invokeAction, invokeAction, invokeAction, invokePrint, javascript, load, makeTree, merge, merge, populate, populate, populate, populateForeignKey, populateForeignKey, populateForeignKey, preLoad, prepareActionURL, redirect, resetParentContext, save, save, search, search, search, search, searchCrosstab, searchExport, searchExport, searchGroupBy, searchGroupBy, searchRowId, searchRowId, select, select, select, selectWithoutFilters, selectWithoutFilters, sendJavaScript, sendRedirect, setConsole, setConstraint, storeParentContext, storeParentContext, toCSV, toCSV, toTSV, toTSV, toXML, update, update, validate, validate, validateSearch

Methods inherited from class com.simplicite.util.ObjectCore

addAgenda, addCrosstab, addDataMap, addDefaultValues, addLinkDataMap, addListOperationField, addMenuListField, addMenuTrayField, addPlaceMap, addPredefinedSearch, addPrintTemplate, addReflexiveLink, addResource, addScript, addSharedScript, addTimesheet, buildInsertSQL, canClose, canCopy, canCreateOnLinks, canDeleteAll, canExport, canExportTimestamp, canFollowLink, canFollowLinks, canGroupByFields, canListAccessNewForm, canListAccessNewLine, canListAccessNewLoop, canPreview, canPrint, canSave, canSaveAndClose, canSaveAndCopy, canSaveAndNew, canSelectRow, canUpdateAll, clearMenuTrayFields, convertFilterToService, convertGuiToService, convertServiceToFilter, convertServiceToGui, destroy, enableGC, evalExpression, evalExpression, evalExpression, evalInputDisplayOldValue, evalInputDisplayValue, evalInputOldValue, evalInputValue, filtersToJson, freeListTree, garbageCollection, genAction, genCommonActions, getAction, getActions, getAgenda, getAgendas, getAlias, getBooleanParameter, getCacheFrom, getCacheKey, getCacheSelect, getClassName, getCode, getCodes, getConfig, getConfirmField, getConfirmFieldValue, getContext, getContextTitle, getCopyId, getCreatedBy, getCreatedDate, getCrosstab, getCrosstabs, getCtxHelps, getCurrentAction, getCurrentItem, getCurrentList, getCurrentPage, getCurrentPos, getCurrentRowId, getCurrentTransition, getCurrentView, getData, getDataMap, getDataSource, getDataSourceVendor, getDbField, getDBField, getDbIndex, getDBIndex, getDBName, getDefaultLink, getDefaultSearchSpec, getDesc, getDisplay, getDisplay, getDisplay, getDisplayFromDB, getDocFields, getDoubleParameter, getEndDateField, getField, getField, getField, getFieldArea, getFieldArea, getFieldAreas, getFieldAtIndex, getFieldByObjectFieldId, getFieldByTranslation, getFieldDisplayOldValue, getFieldDisplayOldValue, getFieldDisplayValue, getFieldDisplayValue, getFieldDisplayValue, getFieldFilter, getFieldFromColumn, getFieldFromColumn, getFieldIndex, getFieldIndex, getFieldOldValue, getFieldOldValue, getFieldOrder, getFields, getFields, getFieldsByType, getFieldsDocument, getFieldValue, getFieldValue, getFieldValue, getFieldValues, getFieldValues, getFilters, getFilters, getFlagParameter, getFloatParameter, getFonctId, getForeignKeys, getFormLayout, getFullInput, getFullInput, getFullInputIndex, getFullInputIndex, getFunctId, getGrant, getGroupByFields, getHistoricDBName, getHistoricName, getIconCode, getId, getImageField, getIndex, getIndex, getInheritedObjects, getInput, getInput, getInputAtIndex, getInputIndex, getInputIndex, getInstanceName, getIntParameter, getLabel, getLastUpdatedBy, getLastUpdatedDate, getLink, getLinkDataMap, getLinks, getListEditMode, getListOperationFields, getListSearchMode, getListSize, getListTree, getLock, getLongParameter, getMaxPage, getMaxRows, getMenuListFields, getMenuSearch, getMenuTrayFields, getMinRows, getModuleId, getModuleId, getModuleIdByName, getModuleName, getName, getNotification, getNotifications, getObjectId, getObjectLocation, getObjectName, getObjectParameter, getObjectTable, getOldStatus, getOldValues, getOldValues, getPageSize, getParameter, getParameter, getParameters, getParentField, getParentIdx, getParentObjectRefField, getParentValues, getPlaceMap, getPlaceMaps, getPluralDisplay, getPluralLabel, getPredefinedSearch, getPredefinedSearch, getPredefinedSearch, getPredefinedSearchIndex, getPredefinedSearchIndex, getPredefinedSearchSelected, getPredefSearch, getPrintTemplate, getPrintTemplates, getRefField, getRefFields, getReflexiveLink, getReflexiveLinks, getRefObjects, getResource, getResources, getRootField, getRowId, getRowId, getRowIdField, getRowIdFieldIndex, getScript, getScriptId, getScripts, getSearchLimit, getSearchSpec, getSelectedIds, getSharedScript, getSharedScripts, getStartDateField, getStatus, getStatus, getStatusField, getStatusIndex, getTable, getTableAlias, getTemplateId, getTemplateName, getTimesheet, getTimesheets, getTitle, getTitle, getUIMiniature, getUITemplate, getUserKeyValues, getUserKeyValues, getValues, getValues, getView, getView, getViewMode, getViews, hasChanged, hasField, hasFieldType, hasFullInput, hasIndexableFields, hasInput, hasMenuDashboard, hasMenuStates, hasMenuTray, hasMoreOnForm, hasMoreOnList, hasMoreOnSearch, hasSearchLimitError, haveMore, initLists, initLists, isAgendaInstance, isAjaxInstance, isAreaVisible, isAreaVisibleOnList, isBatchInstance, isBookmark, isChildOf, isChildOf, isCopied, isCronInstance, isCustomRowId, isDataMapInstance, isDataMappedFrom, isDate, isDistinct, isExportInstance, isFieldForbidden, isFieldSearchable, isFieldUpdatable, isFieldVisible, isFieldVisibleJSON, isFiltered, isHistoricLog, isHistoricPost, isHistoricRedoLog, isHomeInstance, isIDEInstance, isIndexable, isInstanceOf, isInternalRowId, isJavaImplemented, isLimit, isListEditable, isListSearch, isListSearchVisible, isListTree, isListUpsertable, isLoaded, isMainInstance, isMergeable, isMergeInstance, isModelerInstance, isMoreForm, isMoreFormEnable, isMoreListEnable, isMoreOnForm, isMoreOnList, isMoreRows, isMoreSearch, isNew, isOrdered, isPanelInstance, isPanelOf, isPanelOf, isPredefSearch, isPredefSearchOnList, isPrintInstance, isProcessInstance, isQuerySpecific, isReadOnly, isReadOnlyFields, isRefCount, isReferencedFrom, isReferencedFrom, isRefInstance, isScripted, isServiceSpecific, isSocial, isSocialInline, isSocialPopup, isSocialShare, isSortableOnList, isTimestampBlocking, isTimestampNonBlocking, isTimestampOptimistic, isTmpInstance, isTreeviewInstance, isUIInstance, isUndoableInstance, isUnique, isUnique, isWebServiceInstance, lastUsage, listSelectAll, listSelectId, listSelectId, listSelectPage, listUnselectAll, listUnselectId, parseDataSourceName, parseTableName, prepareExpression, preparePagination, prepareSQL, removeField, removeLink, removeParameter, removeParameters, removeView, resetAllFields, resetAllFieldsRequired, resetAllFieldsSearch, resetAllFieldsSearchRequired, resetAllFieldsUpdatable, resetContextDefaultValues, resetFilter, resetFilters, resetFilters, resetFiltersOrdersAndCalcDefaults, resetGroupBy, resetOrders, resetOrders, resetRequireds, resetSearchables, resetSelectedIds, resetUpdatables, resetValues, resetValues, resetValues, resetVisibilities, selectCurrentItemFromList, selectItemFromList, setAlias, setAllFieldsUpdatable, setAreaVisibleOnList, setBookmark, setCacheFrom, setCacheSelect, setClassName, setClose, setConfig, setConfirmFieldValue, setContext, setCopy, setCopy, setCopyId, setCreateOnLinks, setCrosstabVisibility, setCtxHelp, setCtxHelps, setCurrentAction, setCurrentList, setCurrentPage, setCurrentPos, setCurrentPos, setCurrentTransition, setCurrentView, setData, setDataSource, setDataSourceVendor, setDBName, setDefaultLink, setDefaultSearchSpec, setDeleteAll, setDeleteAll, setDesc, setDisplay, setDistinct, setEndDateField, setExport, setExport, setExportTimestamp, setFieldFilter, setFieldOldValue, setFieldOrder, setFields, setFieldValue, setFilters, setFilters, setFilters, setFilters, setFilters, setFilters, setFollowLinks, setForm, setFormLayout, setFunctId, setGrant, setGroupByFields, setHaveMore, setHelp, setHistoric, setHistoricLog, setHistoricPost, setHistoricRedoLog, setIconCode, setId, setIndexable, setInheritedObject, setInstanceName, setLabel, setLimit, setListAccessNewForm, setListAccessNewLine, setListAccessNewLine, setListEdit, setListEdit, setListEditable, setListEditable, setListEditMode, setListSearch, setListSearchMode, setListSearchVisible, setListSize, setListTree, setListUpsertable, setMaxPage, setMaxRows, setMenuDashboard, setMenuSearch, setMenuStates, setMenuTray, setMergeable, setMergeable, setMinRows, setModuleId, setModuleName, setMoreForm, setMoreOnForm, setMoreOnList, setMoreRows, setMoreSearch, setName, setOldValues, setOldValues, setOldValues, setPageSize, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setParentObject, setParentObjectRefField, setParentValues, setPluralDisplay, setPluralLabel, setPredefinedSearchIndex, setPredefSearch, setPredefSearch, setPredefSearch, setPredefSearchOnList, setPrint, setPrintTemplateVisibility, setQuerySpecific, setQuerySpecific, setReadOnly, setRefCount, setRowId, setSave, setSaveAndClose, setSaveAndCopy, setSaveAndNew, setScriptId, setSearchCreatedBy, setSearchCreatedDate, setSearchLimit, setSearchLimitError, setSearchSpec, setSearchSpec, setSearchUpdatedBy, setSearchUpdatedDate, setSelectedIds, setSelectRow, setServiceSpecific, setServiceSpecific, setSocial, setSocial, setSortableOnList, setStartDateField, setStatus, setStatus, setStatus, setStatusField, setTable, setTimestamp, setTitle, setUIMiniature, setUITemplate, setUpdateAll, setUpdateAll, setUserKeyValues, setUserKeyValues, setValues, setValues, setValues, setValues, setValues, setValues, setValues, setValues, setValuesFromJSONObject, setValuesFromJSONObject, setViewMode, testData, testData, toHTML, toHTML, toHTML, toJSON, toJSON, toJSON, toJSON, toJSON, toJSON, toJSON, toJSON, toJSONArray, toJSONObject, toJSONObject, toJSONObject, toString, toString, useForm, useLimit, useTimestamp, useTimeStamp

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ObjectService

public ObjectService()

Method Detail

serviceConfig

@Deprecated(forRemoval=true,
            since="4.0")
public org.json.JSONObject serviceConfig()

Deprecated, for removal: This API element is subject to removal in a future version.

Use getConfig

load

public ObjectDB load(Grant grant)

Description copied from class: ObjectDB

Object definition loading

Overrides:

load in class ObjectDB

Parameters:

grant - User rights

Returns:

Object definition

loadServiceConfig

public void loadServiceConfig()

Load configuration

pingService

public boolean pingService(boolean resetConfig)

Ping service to check if available

Parameters:

resetConfig - Reset configuration if the service is unavailable?

Returns:

True if service is available

countService

public long countService()

Count service

Returns:

Count

searchService

public java.util.List<java.lang.String[]> searchService(boolean pagine)

Search service

Parameters:

pagine - Pagine?

Returns:

List of rows

selectService

public boolean selectService(java.lang.String rowId,
                             boolean copy)

Select item

Parameters:

rowId - Row ID

copy - For copy?

Returns:

True if item was found

dbdocService

public DocumentDB dbdocService(java.lang.String rowId,
                               java.lang.String fieldName)

Document service

Parameters:

rowId - Row ID

fieldName - Document field ID

Returns:

Document or null

createService

public java.lang.String createService()

Create service

Returns:

Error message or null

updateService

public java.lang.String updateService()

Update service

Returns:

Error message or null

deleteService

public java.lang.String deleteService()

Delete service

Returns:

Error message or null

actionService

@Deprecated(forRemoval=false,
            since="5")
public java.lang.Object actionService(java.lang.String action)

Deprecated.

Use actionService with Action argument

actionService

public java.lang.Object actionService(Action action)

Action service

Parameters:

action - Action

Returns:

Action result or error message

printService

public java.lang.Object printService(PrintTemplate prt)

Publication service

Parameters:

prt - Print template

Returns:

Publication result

indexSearchService

public java.util.List<SearchItem> indexSearchService(java.lang.String query,
                                                     int limit)

Indexed search service

Parameters:

query - Indexed search query string?

limit - Maximum search results list size

Returns:

Search results list