Class MemberCsvImportHandler
- All Implemented Interfaces:
JcmsConstants,MemberImportConstants,JaliosConstants
- Since:
- jcms-10.0.8 / JCMS-10510
- Author:
- Sylvain Devaux
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Stringprotected booleanprotected Class<? extends Publication> protected booleanprotected booleanstatic final Stringprotected String[]static final Stringstatic final Stringstatic final Stringprotected Filestatic final Stringprotected Stringprotected DocUploadInfoprotected Stringprotected static final Stringstatic final Stringprotected Stringstatic final Stringstatic final Stringstatic final Stringprotected String[]static final Stringstatic final Stringstatic final Stringstatic final Stringprotected booleanstatic final Stringprotected booleanprotected Stringstatic final Stringstatic final intstatic final intstatic final intstatic final intstatic final intprotected intstatic final Stringprotected booleanstatic final Stringprotected String[]Fields inherited from class com.jalios.jcms.handler.EditDataHandler
id, isDeleteForced, opCancel, opCreate, opDelete, opRefresh, opUpdate, resultOpCreate, resultOpDelete, resultOpUpdateFields inherited from class com.jalios.jcms.handler.JcmsFormHandler
contextMap, csrfValidationEnabled, editFieldSet, formStep, noRedirect, noSendRedirect, op, openTabId, opFinish, opNext, opPrevious, popupEdition, redirect, redirectOnClosePopup, workspaceForcedFields inherited from class com.jalios.jcms.context.JcmsJspContext
AJAX_REQUEST_ATTRIBUTES, BODY_HEADER, CSS_FOOTER, CSS_HEADER, cssboMap, cssfoMap, CUSTOM_HEADER, editIcon, HTTPEQUIV_HEADER, httpequivMap, HTTPNAME_HEADER, httpnameMap, initEditIcon, JAVASCRIPT_CODE_SET_ATTRIBUTE, JAVASCRIPT_MODULE_SET_ATTRIBUTE, JAVASCRIPT_SET_ATTRIBUTE, jsboSet, jsfoSet, out, pageContext, SHOW_EDIT_ICON, STYLE_HEADERFields inherited from class com.jalios.jcms.context.JcmsContext
browser, caddy, channel, inFO, initDone, initWorkspace, isAdmin, isAjaxRequest, isDBMember, isDebug, isDebugTemplatePath, isLogged, loggedMember, request, response, userCountry, userLang, userLocale, userZoneId, workspaceFields inherited from interface com.jalios.util.JaliosConstants
CRLF, MILLIS_IN_ONE_DAY, MILLIS_IN_ONE_HOUR, MILLIS_IN_ONE_MINUTE, MILLIS_IN_ONE_MONTH, MILLIS_IN_ONE_SECOND, MILLIS_IN_ONE_WEEK, MILLIS_IN_ONE_YEARFields inherited from interface com.jalios.jcms.JcmsConstants
ADATE_SEARCH, ADVANCED_TAB, AJAX_MODE_ATTR, ARCHIVES_DIR, ASCII_WIDTH, CATEGORY_TAB, CDATE_SEARCH, CLASS_PROPERTY, COMMON_ALARM, CONTENT_TAB, COOKIE_MAX_AGE, COUNTRY_SPRITE, CS_TYPOLOGY_ROOT_CAT_VID, CTRL_TOPIC_INTERNAL, CTRL_TOPIC_REF, CTRL_TOPIC_VALUE, CTRL_TOPIC_WRITE, CUSTOM_PROP, DATA_DIRECTORY, DEFAULT_PHOTO_PROP, DOCCHOOSER_HEIGHT, DOCCHOOSER_WIDTH, DOCS_DIR, EDATE_SEARCH, EMAIL_REGEXP, ERROR_MSG, FORBIDDEN_FILE_ACCESS, FORBIDDEN_REDIRECT, FORCE_REDIRECT, GENERATIONAL_STORE_DIRECTORY, GLYPH_ICON_PREFIX, ICON_ARCHIVE, ICON_ICON_PREFIX, ICON_LOCK, ICON_LOCK_STRONG, ICON_PREFIX_PROP, ICON_WARN, ICON_WH_BOOK_CLOSED, ICON_WH_BOOK_OPEN, INFORMATION_MSG, IS_IN_FRONT_OFFICE, JALIOS_JUNIT_PROP, JCMS_CADDY, JCMS_MSG_LIST, JCMS_TOASTR_COLLECTION, JSYNC_DOWNLOAD_DIR, JSYNC_SYNC_ALARM, LANG_SPRITE, LOG_FILE, LOG_TOPIC_SECURITY, LOGGER_PROP, LOGGER_XMLPROP, MBR_PHOTO_DIR, MDATE_SEARCH, MONITOR_XML, OP_CREATE, OP_CREATE_STR, OP_DEEP_COPY, OP_DEEP_COPY_STR, OP_DEEP_DELETE, OP_DEEP_DELETE_STR, OP_DELETE, OP_DELETE_STR, OP_MERGE, OP_MERGE_STR, OP_UPDATE, OP_UPDATE_STR, ORGANIZATION_ROOT_GROUP_PROP, PDATE_SEARCH, PHOTO_DIR, PHOTO_ICON, PHOTO_ICON_HEIGHT, PHOTO_ICON_PROP_PREFIX, PHOTO_ICON_WIDTH, PHOTO_LARGE, PHOTO_LARGE_HEIGHT, PHOTO_LARGE_PROP_PREFIX, PHOTO_LARGE_WIDTH, PHOTO_MINI, PHOTO_MINI_HEIGHT, PHOTO_MINI_PROP_PREFIX, PHOTO_MINI_WIDTH, PHOTO_NORMAL, PHOTO_NORMAL_HEIGHT, PHOTO_NORMAL_PROP_PREFIX, PHOTO_NORMAL_WIDTH, PHOTO_SMALL, PHOTO_SMALL_HEIGHT, PHOTO_SMALL_PROP_PREFIX, PHOTO_SMALL_WIDTH, PHOTO_TINY, PHOTO_TINY_HEIGHT, PHOTO_TINY_PROP_PREFIX, PHOTO_TINY_WIDTH, PHOTO_XLARGE, PHOTO_XLARGE_HEIGHT, PHOTO_XLARGE_PROP_PREFIX, PHOTO_XLARGE_WIDTH, PREVIOUS_TAB, PRINT_VIEW, PRIVATE_FILE_ACCESS, PUBLIC_FILE_ACCESS, RAW_CONTENT_ICON_PREFIX, READ_RIGHT_TAB, SDATE_SEARCH, SEARCHENGINE_ALARM, SECURITY_LOG_FILE, SESSION_AUTHORIZED_FILENAMES_SET, SPRITE_ICON_PREFIX, STATS_REPORT_DIR, STATUS_PROP, STORE_XML, SUCCESS_MSG, SVG_ICON_PREFIX, SVGINLINE_ICON_PREFIX, SVGSPRITE_ICON_PREFIX, TEMPLATE_TAB, THEME_DIR, THUMBNAIL_LARGE_HEIGHT, THUMBNAIL_LARGE_WIDTH, THUMBNAIL_SMALL_HEIGHT, THUMBNAIL_SMALL_WIDTH, TTCARD_MEDIA_HEIGHT, TTCARD_MEDIA_WIDTH, TYPES_ICON_ALT_PROP, TYPES_ICON_SUFFIX_PROP, TYPES_ICON_TITLE_PROP, TYPES_PREFIX_PROP, TYPES_THUMB_SUFFIX_PROP, TYPES_UNKNOWN_CLASS_PROP, UDATE_SEARCH, UPDATE_RIGHT_TAB, UPLOAD_DIR, UPLOAD_PERMISSION_COUNT_PROP_PREFIX, UPLOAD_PERMISSION_SIZE_PROP_PREFIX, URL_REGEXP, VID_LOGGED_MEMBER, WARNING_MSG, WEBAPP_PROP, WFEXPRESS_ALARM, WFREMINDER_ALARM, WORKFLOW_TAB, WORKFLOW_XMLFields inherited from interface com.jalios.jcms.member.csvimport.MemberImportConstants
COMMENT_CHARACTER, DEFAULT_AS_GUESTS, DEFAULT_DBMEMBER, DEFAULT_DEFERR_EMAILS, DEFAULT_USAGE, EMAIL_BATCH_DEFERR_SECONDS_PROP, IS_IMPORT_ENABLED_PROP, MAX_ERROR_PER_IMPORT_PROP, MAX_MEMBER_PER_IMPORT_PROP, MEMBER_DC_SRC_COLUMNS_KEY, MEMBER_IMPORT_PROCESS_ATTR, WORKSPACE_ROOT_CATEGORY_VID_PROP -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleanbooleanRetrieve all the Collaborative workspaces as a Set, with the following conditions : workspace's isCollaborativeSpace() method return true; workspace is open workspace is not a model member belongs to workspace, or collaborative space has public access.intString[]intRetrieve the total number of steps used for edition when invoking this form handler.getGid()String[]Return common groups selected by user in GUI to add new members to.intintintgetUsage()Retrieve all the workspaces as a Set, with the following conditions : workspace's getCatSet() is child of "$id.member.csv-import.ws-root-cat" root category.String[]booleanbooleanbooleanbooleanReturns weither Workspace step should be displayed.protected voidinit()Method to implement if you need to initialize your handler from parameter received, prior to all security validation.booleanReturn true if import mode isAccount.booleanbooleanprotected booleanbooleanReturn true if import mode isContact.booleanbooleanbooleanbooleanbooleanbooleanprotected booleanprotected booleanbooleanMethod to be implemented to check/validate action to be performed and process them.voidsetCsGrpIds(String[] v) voidsetDbMembers(String dbMembers) Set true to create Member in DataBase.
False, to create JStore Members.
Only used for creation, not for updates.voidsetDocuments(String[] v) Moves the plupload uploaded file to JCMS temp directory in order the uploaded files to be cleaned periodically by JCMS.voidsetFilename(String filename) Set the name of the file, previous uploaded in temporary directory on first step, that we must use for CSV import.voidvoidsetGlobalGrpIds(String[] v) voidA flag to indicate common groups step was reached.voidSet weither members have to be imported as guests.voidsetImportType(String importType) voidsetSendEmail(String sendEmail) voidsetSeparator(String separator) voidsetUsage(int usage) voidsetWsGrpIds(String[] v) booleanCheck if the "Finish" button should be displayed in step modal form.booleanCheck if the "Next" button should be displayed in step modal form.booleanCheck if the "Previous" button should be displayed in step modal form.toString()booleanprotected booleanprotected booleanDoes custom check on csv file in update file step.protected booleanMethods inherited from class com.jalios.jcms.handler.EditDataHandler
afterValidation, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, createUploadedFileDocument, getAvailableData, getAvailableDataArray, getAvailableExtraDataMap, getAvailableExtraDBDataMap, getAvailableField, getControllerContext, getDeleteRedirect, getEnumLabels, getEnumValues, getId, getModalRedirect, getTabGroupMaxCount, handleRestResponse, isExtraDataHidden, isFirstAccess, performRefresh, processDataId, processDataIds, processDataIds, processMLData, processMLDataArray, restValidation, sendRedirect, setExtraDBKeys, setExtraDBValues, setExtraKeys, setExtraValues, setFields, setForceDelete, setId, setOpCancel, setOpCreate, setOpDelete, setOpRefresh, setOpUpdate, validateCancel, validateRefresh, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocument, validateUploadedFileDocumentMethods inherited from class com.jalios.jcms.handler.JcmsFormHandler
canStartProcess, checkMissingField, getAvailableMainLanguage, getBackgroundProcess, getClosePopupUrl, getEditFieldSet, getFormStep, getFormStepFinishLabel, getFormStepLabels, getFormStepPrefixProp, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenField, getHiddenFieldML, getMainLangValue, getMainLangValueArray, getMLMap, getMLMapArray, getMonolingualValue, getMonolingualValueArray, getMultilingualMainValue, getMultilingualMainValueArray, getMultilingualMLMap, getMultilingualMLMapArray, getOpenTabId, getRedirect, getRedirectOnClosePopup, getWorkspace, isFieldEdition, isFieldMissing, isFormStepClickable, isPartialFieldEdition, isPopupEdition, isWorkspaceForced, mapStringArrayToMapStringList, mapStringListToMapStringArray, mustSendForbiddenOnCSRF, performNext, processStatus, sanitize, sanitize, sendRedirect, sendRedirect, setEditField, setFormStep, setNoRedirect, setNoSendRedirect, setOpenTabId, setOpFinish, setOpNext, setOpPrevious, setPopupEdition, setRedirect, setRedirectOnClosePopup, setWorkspace, setWs, showCancelButton, startProcess, updateUploadedFields, validate, validateCSRFMethods inherited from class com.jalios.jcms.context.JcmsJspContext
addAvoidanceLink, addBodyAttributes, addCSSHeader, addCSSHeader, addCSSHeader, addCSSHeader, addCustomHeader, addHandlebarTemplate, addHttpEquivHeader, addHttpNameHeader, addJavaScript, addJavaScript, addJavaScript, addJavaScriptCode, addJavaScriptModule, addPrefetchHeader, addStyleHeader, addStyleHeader, addSvgSpriteIcon, addWebAssets, canAccessAdminArea, checkAccess, checkAccess, checkCSRF, debugDisplayContext, disablePacker, forceEditIcon, forceUpdate, getAjaxRequestAttribute, getAjaxRequestId, getAllHeadersDiffMap, getAllHeadersMap, getAvoidanceLinks, getBackOfficeCSSHeader, getBackOfficeJavaScriptSet, getBodyAttributes, getContentForm, getCSSHeaders, getCtxCategories, getCurrentCategory, getCustomHeaders, getDocType, getFinalCSSFooterMap, getFinalCSSMap, getFinalJavaScriptModuleSet, getFinalJavaScriptSet, getFrontOfficeCSSHeader, getFrontOfficeJavaScriptSet, getHandlebarTemplates, getHttpEquivHeaders, getHttpNameHeaders, getJavaScriptCodeSet, getJavaScriptModuleSet, getJavaScriptSet, getPageContext, getPageTitle, getPageZone, getPortal, getPortalCategory, getPortlet, getPublication, getStyleHeaders, getSvgSprites, getSvgSpritesHtml, getTemplateUsage, internalSetupEmptyHeader, isEditIcon, isEditIcon, isEditIconForPublish, isEditIconForPublish, isPrintView, registerDisplayContext, removeAjaxRequestAttribute, setAjaxRequestAttribute, setAjaxRequestId, setAllHeadersDiffMap, setDocType, setEditIcon, setPageContext, setPageTitle, setPageZone, setShowEditIcon, setTemplateUsage, showEditIcon, showEditIcon, showEditIconMethods inherited from class com.jalios.jcms.context.JcmsContext
addMsg, addMsg, addMsgSession, addMsgSession, addToastr, addToastr, addToastrSession, addToastrSession, applySelector, canAccessAdminArea, copyMsgListToMsgSessionList, forceWorkspaceUpdate, getBaseUrl, getBrowser, getCaddy, getContextPath, getErrorMsg, getErrorMsgList, getErrorMsgSession, getErrorMsgSessionList, getInfoMsg, getInfoMsgList, getInfoMsgSession, getInfoMsgSessionList, getLoggedMember, getMsgList, getMsgSessionList, getRequest, getResponse, getSession, getSuccessMsg, getSuccessMsgList, getSuccessMsgSession, getSuccessMsgSessionList, getToastrCollection, getToastrSessionCollection, getUploadedFiles, getUploadedFiles, getUrlWithCommonUpdatedParams, getUserCountry, getUserLang, getUserLocale, getUserZoneId, getWarningMsg, getWarningMsgList, getWarningMsgSession, getWarningMsgSessionList, glp, isAdmin, isAdminZone, isAjaxRequest, isDBMember, isDebug, isDebugTemplate, isInFrontOffice, isLogged, isWorkZone, removeMessage, removeMessage, removeMsg, select, sendError, sendError, sendForbidden, sendForbidden, sendRedirect, sendRedirect, sendRedirect, setErrorMsg, setErrorMsg, setErrorMsgSession, setErrorMsgSession, setInfoMsg, setInfoMsg, setInfoMsgSession, setInfoMsgSession, setLoggedMember, setRequest, setResponse, setSuccessMsg, setSuccessMsg, setSuccessMsgSession, setSuccessMsgSession, setWarningMsg, setWarningMsg, setWarningMsgSession, setWarningMsgSession, updateWorkspace, validateRegexp, validateSchedule
-
Field Details
-
ADMIN_USERS_MEMBER_ACL
- See Also:
-
CSV_SEMICOLON_CHAR_SEP
- See Also:
-
CSV_COMMA_CHAR_SEP
- See Also:
-
CSV_FILE_HTML_PARAM
- See Also:
-
SEPARATOR_HTML_PARAM
- See Also:
-
SEND_EMAIL_HTML_PARAM
- See Also:
-
WS_GROUP_ID_PARAM
- See Also:
-
CS_GROUP_ID_PARAM
- See Also:
-
GLOBAL_GROUP_ID_PARAM
- See Also:
-
GID_PARAM
- See Also:
-
GLOBAL_GROUP_IDS_FLAG_PARAM
- See Also:
-
DBMEMBER_PARAM
- See Also:
-
IMPORT_TYPE_PARAM
- See Also:
-
USAGE_PARAM
- See Also:
-
FORMHANDLER_REQ_ATTR
- See Also:
-
FILENAME_HTML_PARAM
- See Also:
-
STEP_1_FILE
public static final int STEP_1_FILE- See Also:
-
STEP_2_PREVIEW
public static final int STEP_2_PREVIEW- See Also:
-
STEP_3
public static final int STEP_3- See Also:
-
STEP_4
public static final int STEP_4- See Also:
-
STEP_5
public static final int STEP_5- See Also:
-
IMPORT_TYPE_ACCOUNT
- See Also:
-
IMPORT_TYPE_CONTACT
- See Also:
-
IMPORT_TYPE_GUEST
- See Also:
-
separator
-
sendEmail
protected boolean sendEmail -
wsGrpIds
-
csGrpIds
-
globalGrpIds
-
gid
-
isGlobalGrpStepReached
protected boolean isGlobalGrpStepReached -
docUploadInfo
-
dbMembers
-
useDbMembers
protected boolean useDbMembers -
usage
protected int usage -
asGuests
protected boolean asGuests -
csvFile
-
filename
-
collaborativeSpaceClazz
-
collaborativeSpacePluginActive
protected boolean collaborativeSpacePluginActive -
collaborativeSpaceInitDone
protected boolean collaborativeSpaceInitDone
-
-
Constructor Details
-
MemberCsvImportHandler
public MemberCsvImportHandler()
-
-
Method Details
-
init
protected void init()Description copied from class:JcmsFormHandlerMethod to implement if you need to initialize your handler from parameter received, prior to all security validation.You must absolutely not perform any action which modify data or site configuration.
Therefore it is strongly recommend NOT TO implement this method, or use very wisely.
- Overrides:
initin classJcmsFormHandler
-
processAction
Description copied from class:JcmsFormHandlerMethod to be implemented to check/validate action to be performed and process them.Default implementation is to return false. No need to call super method.
This method may NOT be invoked at all if security validation are not met.
You must ensure your handler and JSP can work properly without any code invoked in this method.
- Overrides:
processActionin classEditDataHandler- Returns:
- false if no redirection is needed, true otherwise
- Throws:
IOException- IO Exception
-
getDataClass
- Specified by:
getDataClassin classEditDataHandler
-
validatePrevious
- Overrides:
validatePreviousin classJcmsFormHandler- Throws:
IOException
-
validateFinish
- Overrides:
validateFinishin classJcmsFormHandler- Throws:
IOException
-
isImportInProgress
public boolean isImportInProgress() -
isPreviewStep
public boolean isPreviewStep() -
isImportProcessAuthor
public boolean isImportProcessAuthor() -
performFinish
- Overrides:
performFinishin classJcmsFormHandler- Throws:
IOException
-
performPrevious
- Overrides:
performPreviousin classJcmsFormHandler- Throws:
IOException
-
showPreviousButton
public boolean showPreviousButton()Description copied from class:JcmsFormHandlerCheck if the "Previous" button should be displayed in step modal form.The default implementation of this method is to return true if the current step (as returned by
JcmsFormHandler.getFormStep()is higher than 0.You can provide a custom FormHandler to override this behavior.
See jcore/doStepButtons.jspf for use of this method.
- Overrides:
showPreviousButtonin classJcmsFormHandler- Returns:
- true to display the "Previous" button, false to hide it
-
showNextButton
public boolean showNextButton()Description copied from class:JcmsFormHandlerCheck if the "Next" button should be displayed in step modal form.The default implementation of this method is to return true unless the finish button is being displayed by method
JcmsFormHandler.showFinishButton().You can provide a custom FormHandler to override this behavior.
See jcore/doStepButtons.jspf for use of this method.
- Overrides:
showNextButtonin classJcmsFormHandler- Returns:
- true to display the "Next" button, false to hide it
-
performCancel
- Overrides:
performCancelin classEditDataHandler- Throws:
IOException
-
showFinishButton
public boolean showFinishButton()Description copied from class:JcmsFormHandlerCheck if the "Finish" button should be displayed in step modal form.The default implementation of this method is to return true if the current step (as returned by
JcmsFormHandler.getFormStep()is the last one (as compared withJcmsFormHandler.getFormStepCount().You can provide a custom FormHandler to override this behavior.
See jcore/doStepButtons.jspf for use of this method.
- Overrides:
showFinishButtonin classJcmsFormHandler- Returns:
- true to display the "Finish" button, false to hide it
-
getFormStepHiddenFields
- Overrides:
getFormStepHiddenFieldsin classJcmsFormHandler
-
getFormStepCount
public int getFormStepCount()Description copied from class:JcmsFormHandlerRetrieve the total number of steps used for edition when invoking this form handler.The default implementation of this method is to return 1, corresponding to one step (which means only 1 screen being displayed).
You can provide a custom FormHandler to override this behavior.
See jcore/doSteps.jspf for use of this method.
- Overrides:
getFormStepCountin classJcmsFormHandler- Returns:
- the total number of steps in this formhandler
-
getModalTitle
-
getModalHtmlAttributes
-
getModalCss
-
isCollaborativeSpacePluginAvailable
protected boolean isCollaborativeSpacePluginAvailable()- Returns:
- true if CollaborativeSpace plugin is active.
- Since:
- jcms-10.0.8
-
validateNext
Does custom check on csv file in update file step.- Overrides:
validateNextin classJcmsFormHandler- Returns:
- true if file is ok at upload step, else if opNext is clicked
- Throws:
IOException- if an exception occurs while simulating import.- Since:
- jcms-10.0.8
-
hasWorkspaceStep
public boolean hasWorkspaceStep()Returns weither Workspace step should be displayed.- Returns:
- true if a valid Workspaces root category has been defined,
and the logged member can see at least one workspace under this cat.
See
getWorkspaceSet().
-
hasCollaborativeSpaceStep
public boolean hasCollaborativeSpaceStep()- Returns:
- true if the current loggedMember can see any Collaborative Space.
-
hasGlobalGroupsStep
public boolean hasGlobalGroupsStep()- Returns:
- true if the current loggedMember can see any global groups.
- Since:
- jcms-10.0.5
-
isGlobalGroupsStep
public boolean isGlobalGroupsStep() -
getWorkspaceSet
Retrieve all the workspaces as a Set, with the following conditions :- workspace's getCatSet() is child of "$id.member.csv-import.ws-root-cat" root category.
- the workspace is not a collaborative space
- the workspace is not a model
- the workspace is open
- the workspace does have at least one group visible by loggedMember
- Returns:
- the ws set.
- Since:
- jcms-10.0.8
-
getCollaborativeSpaceSet
Retrieve all the Collaborative workspaces as a Set, with the following conditions :- workspace's isCollaborativeSpace() method return true;
- workspace is open
- workspace is not a model
- member belongs to workspace, or collaborative space has public access.
- the workspace does have at least one group visible by loggedMember
- Returns:
- the ws set.
- Since:
- jcms-10.0.8
-
getGlobalGroupSet
-
isAnotherProcessRunning
public boolean isAnotherProcessRunning() -
setDocuments
Moves the plupload uploaded file to JCMS temp directory in order the uploaded files to be cleaned periodically by JCMS.- Parameters:
v- the documents argument from plupload.- Since:
- jcms-10.0.8
-
getSeparator
- Returns:
- the separator
- Since:
- jcms-10.0.8
-
setSeparator
- Parameters:
separator- the separator to set- Since:
- jcms-10.0.8
-
getSendEmail
- Returns:
- the sendEmail
- Since:
- jcms-10.0.8
-
setSendEmail
- Parameters:
sendEmail- the sendEmail to set- Since:
- jcms-10.0.8
-
hasToSendEmail
public boolean hasToSendEmail()- Returns:
- the sendEmail
- Since:
- jcms-10.0.8
-
setDbMembers
Set true to create Member in DataBase.
False, to create JStore Members.
Only used for creation, not for updates.- Parameters:
dbMembers- the dbMembers to set- Since:
- jcms-10.0.8
-
useDbMembers
public boolean useDbMembers()- Returns:
- Weither to use DBMember or Member class.
- Since:
- jcms-10.0.8
-
getCreateCount
public int getCreateCount()- Returns:
- the createCount
- Since:
- jcms-10.0.8
-
getUpdateCount
public int getUpdateCount()- Returns:
- the updateCount
- Since:
- jcms-10.0.8
-
getInvalidCount
public int getInvalidCount()- Returns:
- the invalidCount
- Since:
- jcms-10.0.8
-
getMemberInfoList
- Returns:
- the memberInfoList
- Since:
- jcms-10.0.8
-
isAnyError
public boolean isAnyError()- Returns:
- true if the current import manager contains error.
- Since:
- jcms-10.0.8
-
getWsGrpIds
- Returns:
- the wsGrpIds
- Since:
- jcms-10.0.8
-
setWsGrpIds
- Parameters:
v- the wsGrpIds to set- Since:
- jcms-10.0.8
-
getCsGrpIds
- Returns:
- the csGrpIds
- Since:
- jcms-10.0.8
-
setCsGrpIds
- Parameters:
v- the csGrpIds to set- Since:
- jcms-10.0.8
-
getGlobalGrpIds
Return common groups selected by user in GUI to add new members to.Note: before 10.0.7 (JCMS-9493):
Automatically adds channel default group by default, only if file validation step was reached, and if common groups step was not reached, when opImport is posted. Since 10.0.7 (JCMS-9493), this no longer happen for guests accounts import.- Returns:
- the globalGrpIds
- Since:
- jcms-10.0.5
-
setGlobalGrpIds
- Parameters:
v- the globalGrpIds to set- Since:
- jcms-10.0.5
-
setGlobalGrpIdsFlag
A flag to indicate common groups step was reached.Note: before 10.0.7 (JCMS-9493):
When true, selected common groups will not be modified, and will be exactly ones user requested.
When false, default common groups can be selected by the system. (eg: the channel default Group)
Since 10.0.7 (JCMS-9493), default group is no longer added to those groups.- Parameters:
v- true when step was reached- Since:
- jcms-10.0.6 JCMS-8958
-
getGid
-
getGidGroup
-
setGid
-
getAllGroupIds
- Returns:
- all the groups members to be added in
- Since:
- jcms-10.0.7
-
setImportType
- Parameters:
importType- the type of import- Since:
- jcms-10.0.5 / JCMS-8503
-
getImportType
- Returns:
- tye type of import
- Since:
- jcms-10.0.5 / JCMS-8503
-
getUsage
public int getUsage()- Returns:
- the usage (Account or contact) for members to create.
- Since:
- jcms-10.0.8
-
setUsage
public void setUsage(int usage) - Parameters:
usage- the usage (Account or contact) for members to create to set.- Since:
- jcms-10.0.8
-
isAccountMode
public boolean isAccountMode()Return true if import mode isAccount.- Returns:
- true if import mode is
Account. - Since:
- jcms-10.0.8
-
isContactMode
public boolean isContactMode()Return true if import mode isContact.- Returns:
- true if import mode is
Contact. - Since:
- jcms-10.0.8
-
displayUsageOption
public boolean displayUsageOption()- Returns:
- true if option usage must be proposed.
- Since:
- jcms-10.0.8
-
displayGuestOption
public boolean displayGuestOption()- Returns:
- true if option import as guests must be proposed.
- Since:
- jcms-10.0.5 / JCMS-8503
-
isGuestMode
public boolean isGuestMode()- Returns:
- true if members should be imported as CSP guests.
- Since:
- jcms-10.0.5 / JCMS-8503
-
getGuestGroup
- Returns:
- the guest group if any
- Since:
- jcms-10.0.5 / JCMS-8503
-
setGuest
Set weither members have to be imported as guests.- Parameters:
v- form parameter- Since:
- jcms-10.0.5 / JCMS-8503
-
getFilename
- Returns:
- the relative filename of the imported file.
- Since:
- jcms-10.0.8
-
setFilename
Set the name of the file, previous uploaded in temporary directory on first step, that we must use for CSV import.- Parameters:
filename- the filename to set- Since:
- jcms-10.0.8
-
toString
-