Package de.hybris.platform.workflow.jalo
Class WorkflowTemplate
- java.lang.Object
-
- de.hybris.platform.util.BridgeAbstraction
-
- de.hybris.platform.jalo.Item
-
- de.hybris.platform.jalo.ExtensibleItem
-
- de.hybris.platform.jalo.c2l.LocalizableItem
-
- de.hybris.platform.jalo.GenericItem
-
- de.hybris.platform.cronjob.jalo.GeneratedJob
-
- de.hybris.platform.cronjob.jalo.Job
-
- de.hybris.platform.workflow.jalo.GeneratedWorkflowTemplate
-
- de.hybris.platform.workflow.jalo.WorkflowTemplate
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Comparable
@Deprecated public class WorkflowTemplate extends GeneratedWorkflowTemplate
Deprecated.since ages - as of release 4.3, please useWorkflowTemplateModelTemplate for creating an workflow instance. The instance will be getting the attributes of this template.
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class de.hybris.platform.cronjob.jalo.Job
Job.JobFileLogContainer, Job.Synchronicity
-
Nested classes/interfaces inherited from class de.hybris.platform.jalo.GenericItem
GenericItem.GenericItemImpl
-
Nested classes/interfaces inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LocalizableItem.LocalizableItemImpl
-
Nested classes/interfaces inherited from class de.hybris.platform.jalo.ExtensibleItem
ExtensibleItem.ExtensibleItemImpl
-
Nested classes/interfaces inherited from class de.hybris.platform.jalo.Item
Item.AttributeFilter, Item.AttributeMode, Item.CachedGetter, Item.CachedSetter, Item.ItemAttributeMap, Item.ItemConstraint, Item.ItemImpl, Item.JaloCachedComputationException
-
-
Field Summary
-
Fields inherited from class de.hybris.platform.workflow.jalo.GeneratedWorkflowTemplate
ACTIONS, ACTIONSHANDLER, ACTIVATIONSCRIPT, DEFAULT_INITIAL_ATTRIBUTES, DESCRIPTION, NAME, VISIBLEFORPRINCIPALS, WORKFLOWTEMPLATE2PRINCIPALRELATION_MARKMODIFIED, WORKFLOWTEMPLATE2PRINCIPALRELATION_SRC_ORDERED, WORKFLOWTEMPLATE2PRINCIPALRELATION_TGT_ORDERED
-
Fields inherited from class de.hybris.platform.cronjob.jalo.Job
CTX_CURRENTCRONJOB, CTX_CURRENTJOB
-
Fields inherited from class de.hybris.platform.cronjob.jalo.GeneratedJob
ACTIVE, ALTERNATIVEDATASOURCEID, CHANGERECORDINGENABLED, CODE, CRONJOBS, CRONJOBSHANDLER, EMAILADDRESS, EMAILNOTIFICATIONTEMPLATE, ERRORMODE, LOGLEVELDATABASE, LOGLEVELFILE, LOGTODATABASE, LOGTOFILE, NODEGROUP, NODEID, PRIORITY, REMOVEONEXIT, REQUESTABORT, REQUESTABORTSTEP, RESTRICTIONS, RESTRICTIONSHANDLER, RETRY, SENDEMAIL, SESSIONCONTEXTVALUES, SESSIONCURRENCY, SESSIONLANGUAGE, SESSIONUSER, SINGLEEXECUTABLE, TRIGGERS, TRIGGERSHANDLER
-
Fields inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
LANGUAGE_FALLBACK_ENABLED
-
Fields inherited from class de.hybris.platform.jalo.Item
_CREATION_TIME_INTERNAL, _MODIFIED_TIME_INTERNAL, accessorLog, CREATION_TIME, DISABLE_ATTRIBUTE_CHECK, DISABLE_ITEMCHECK_BEFORE_REMOVABLE, EVEN, FEATURE_ACCESSMAP_QUALIFIER, HJMPTS, INITIAL_CREATION_FLAG, isJaloOnly, MODIFIED_TIME, NEGATIVE, NOT_FOUND, OWNER, PK, POSITIVE, SAVE_FROM_SERVICE_LAYER, staticTransientObjects, TYPE
-
Fields inherited from class de.hybris.platform.util.BridgeAbstraction
impl, tenant
-
-
Constructor Summary
Constructors Constructor Description WorkflowTemplate()Deprecated.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description voidaddToActions(SessionContext ctx, WorkflowActionTemplate value)Deprecated.Generated method - Addsvalueto actions.voidcopyAndConnectionAttribute(WorkflowDecisionTemplate workflowDecisionTemplate, java.util.List<WorkflowAction> workflowActions, WorkflowDecision newDecision)Deprecated.Sets the andConntection Attribute on the extendet Relation WorkflowActionLinkRelation.protected java.util.List<WorkflowAction>createActions(Workflow workflow)Deprecated.Creates new actions corresponding to the action templates set to this workflow template.protected ItemcreateItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes)Deprecated.Has to be implemented for each concrete subtype of item.WorkflowcreateWorkflow()Deprecated.since ages - as of release 4.3, plase useWorkflowService.createWorkflow(WorkflowTemplateModel, de.hybris.platform.core.model.user.UserModel)protected WorkflowActiongetWorkAction(WorkflowActionTemplate templateAction, java.util.List<WorkflowAction> workflowActions)Deprecated.Gets the action out of given action list which was created by given action template.protected booleanisValidWorkflowTemplateActions()Deprecated.checks if all workflow template actions have at least one option, except for the actions with action type endprotected CronJob.CronJobResultperformCronJob(CronJob cronJob)Deprecated.You have to implement this method in yourJob.voidremove(SessionContext ctx)Deprecated.First all assignedCronJobswere removed, than theJobitself.voidsetOwner(Item item)Deprecated.-
Methods inherited from class de.hybris.platform.workflow.jalo.GeneratedWorkflowTemplate
addToActions, addToVisibleForPrincipals, addToVisibleForPrincipals, getActions, getActions, getActivationScript, getActivationScript, getAllDescription, getAllDescription, getAllName, getAllName, getDefaultAttributeModes, getDescription, getDescription, getName, getName, getVisibleForPrincipals, getVisibleForPrincipals, getVisibleForPrincipalsCount, getVisibleForPrincipalsCount, isMarkModifiedDisabled, removeFromActions, removeFromActions, removeFromVisibleForPrincipals, removeFromVisibleForPrincipals, setActions, setActions, setActivationScript, setActivationScript, setAllDescription, setAllDescription, setAllName, setAllName, setDescription, setDescription, setName, setName, setVisibleForPrincipals, setVisibleForPrincipals
-
Methods inherited from class de.hybris.platform.cronjob.jalo.Job
canPerform, canUndo, checkRemovable, configureCronjob, createLogContext, debug, error, fatal, getConfigAttributes, getCronJobsByCode, getCronJobsByCode, getCurrentLogContainer, getEffectiveLogLevel, getNonInitialAttributes, info, isAbortable, isDebugEnabled, isEnabledFor, isErrorEnabled, isInfoEnabled, isPerformable, isPerformable, isUndoable, isWarnEnabled, jobIsCurrentlyRunning, log, logToFile, perform, perform, perform, prepareAfterFinishEvent, prepareBeforeStartEvent, saveToLogFile, sendFinishedEvent, sendStartEvent, setCode, setCronJobs, setCurrentLogContainer, setNonInitialAttributes, startOwnSession, stopOwnSession, switchDataSource, undo, undo, undoCronJob, unsetAlternativeDataSource, unsetCurrentLogContainer, warn
-
Methods inherited from class de.hybris.platform.cronjob.jalo.GeneratedJob
addToRestrictions, addToRestrictions, addToTriggers, addToTriggers, getAlternativeDataSourceID, getAlternativeDataSourceID, getCode, getCode, getCronJobs, getCronJobs, getEmailAddress, getEmailAddress, getEmailNotificationTemplate, getEmailNotificationTemplate, getErrorMode, getErrorMode, getLogLevelDatabase, getLogLevelDatabase, getLogLevelFile, getLogLevelFile, getNodeGroup, getNodeGroup, getNodeID, getNodeID, getNodeIDAsPrimitive, getNodeIDAsPrimitive, getPriority, getPriority, getPriorityAsPrimitive, getPriorityAsPrimitive, getRestrictions, getRestrictions, getSessionCurrency, getSessionCurrency, getSessionLanguage, getSessionLanguage, getSessionUser, getSessionUser, getTriggers, getTriggers, isActive, isActive, isActiveAsPrimitive, isActiveAsPrimitive, isChangeRecordingEnabled, isChangeRecordingEnabled, isChangeRecordingEnabledAsPrimitive, isChangeRecordingEnabledAsPrimitive, isLogToDatabase, isLogToDatabase, isLogToDatabaseAsPrimitive, isLogToDatabaseAsPrimitive, isLogToFile, isLogToFile, isLogToFileAsPrimitive, isLogToFileAsPrimitive, isRemoveOnExit, isRemoveOnExit, isRemoveOnExitAsPrimitive, isRemoveOnExitAsPrimitive, isRequestAbort, isRequestAbort, isRequestAbortAsPrimitive, isRequestAbortAsPrimitive, isRequestAbortStep, isRequestAbortStep, isRequestAbortStepAsPrimitive, isRequestAbortStepAsPrimitive, isRetry, isRetry, isRetryAsPrimitive, isRetryAsPrimitive, isSendEmail, isSendEmail, isSendEmailAsPrimitive, isSendEmailAsPrimitive, isSingleExecutable, isSingleExecutable, isSingleExecutableAsPrimitive, isSingleExecutableAsPrimitive, removeFromRestrictions, removeFromRestrictions, removeFromTriggers, removeFromTriggers, setActive, setActive, setActive, setActive, setAlternativeDataSourceID, setAlternativeDataSourceID, setChangeRecordingEnabled, setChangeRecordingEnabled, setChangeRecordingEnabled, setChangeRecordingEnabled, setCode, setEmailAddress, setEmailAddress, setEmailNotificationTemplate, setEmailNotificationTemplate, setErrorMode, setErrorMode, setLogLevelDatabase, setLogLevelDatabase, setLogLevelFile, setLogLevelFile, setLogToDatabase, setLogToDatabase, setLogToDatabase, setLogToDatabase, setLogToFile, setLogToFile, setLogToFile, setLogToFile, setNodeGroup, setNodeGroup, setNodeID, setNodeID, setNodeID, setNodeID, setPriority, setPriority, setPriority, setPriority, setRemoveOnExit, setRemoveOnExit, setRemoveOnExit, setRemoveOnExit, setRequestAbort, setRequestAbort, setRequestAbort, setRequestAbort, setRequestAbortStep, setRequestAbortStep, setRequestAbortStep, setRequestAbortStep, setRestrictions, setRestrictions, setRetry, setRetry, setRetry, setRetry, setSendEmail, setSendEmail, setSendEmail, setSendEmail, setSessionCurrency, setSessionCurrency, setSessionLanguage, setSessionLanguage, setSessionUser, setSessionUser, setSingleExecutable, setSingleExecutable, setSingleExecutable, setSingleExecutable, setTriggers, setTriggers
-
Methods inherited from class de.hybris.platform.jalo.GenericItem
getImplementation, getInitialProperties, getRelatedItems, setRelatedItems
-
Methods inherited from class de.hybris.platform.jalo.c2l.LocalizableItem
getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllLocalizedProperties, getAllValuesSessionContext, getLocalizedProperty, getLocalizedProperty, getLocalizedPropertyInternal, getLocalizedPropertyNames, getLocalizedPropertyNames, hasLanguage, isEmptyValue, isFallbackEnabled, removeLocalizedProperty, removeLocalizedProperty, setAllLocalizedProperties, setAllLocalizedProperties, setLocalizedProperty, setLocalizedProperty
-
Methods inherited from class de.hybris.platform.jalo.ExtensibleItem
createNonClassAccessor, getAllProperties, getAllProperties, getProperty, getProperty, getPropertyNames, getPropertyNames, removeProperty, removeProperty, setAllProperties, setAllProperties, setProperty, setProperty
-
Methods inherited from class de.hybris.platform.jalo.Item
addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addLinkedItems, addNegativePermission, addPermission, addPositivePermission, assureExtensionsLoaded, changeTypeAfterCreation, checkConstraint, checkItemPermission, checkMandatoryAttribute, checkMandatoryAttribute, checkPermission, checkPermission, clearPermission, compareTo, ctx, doAfterRemove, doBeforeRemove, equals, getAccessorFor, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributes, getAllAttributesInternal, getAllLinkedItems, getAndCheckCacheBoundItem, getAttribute, getAttribute, getCacheBoundItem, getComposedType, getComposedTypePK, getCreationTime, getCurrentlyRemovingCount, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItems, getLinkedItemsCount, getLinkedItemsCount, getLinkedItemsCount, getModificationTime, getNegativePermissions, getOwner, getPermissionMap, getPermissions, getPersistenceVersion, getPK, getPositivePermissions, getRestrictedPrincipals, getSession, getSyncObject, getTenant, getTransientObject, getTransientObjectMap, hashCode, hasRegisteredClassAccessorFor, internal_registerClassAccessorFor, internal_registerNonClassAccessorFor, invalidateLocalCaches, isAlive, isCacheBound, isCurrentlyRemoving, isCurrentlyRemoving, isEmptyRelationValue, isInCreate, isInstanceOf, isItemCheckBeforeRemoveableDisabled, isRelationLocalizationFallbackEnabled, newInstance, notifyExtensionsAfterItemCreation, notifyExtensionsBeforeItemCreation, notifyItemRemoval, notifyManagerAboutItemRemoval, readResolve, registerAccessFor, registerAccessFor, registerJaloInvalidationListeners, remove, removeItemCollection, removeItemCollection, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinkedItems, removeLinks, removePartOfItems, removePartOfItems, setAllAttributes, setAllAttributes, setAllAttributesInternal, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAllLinkedItems, setAttribute, setAttribute, setAttributeFromString, setAttributeFromString, setCacheBound, setComposedType, setCreationTime, setImplementation, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setLinkedItems, setModificationTime, setPermissionsByMap, setTransientObject, setUseTA, toString, useTA, writeReplace
-
Methods inherited from class de.hybris.platform.util.BridgeAbstraction
setTenant
-
-
-
-
Method Detail
-
createItem
protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException
Deprecated.Description copied from class:ItemHas to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) duringComposedType.newInstance(Map).In case this method uses any of the attribute values during creation it is required to override
Item.getNonInitialAttributes(SessionContext, ItemAttributeMap)too.
Sn example:public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) ); // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes( SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret = super.getNonInitialAttributes( ctx, allAttributes ); // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }- Overrides:
createItemin classJob- Parameters:
ctx- the current session context which this item is created withintype- the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )- Returns:
- the new item instance
- Throws:
JaloBusinessException- indicates an error during creation - any changes will be rollbacked
-
createWorkflow
@Deprecated public Workflow createWorkflow()
Deprecated.since ages - as of release 4.3, plase useWorkflowService.createWorkflow(WorkflowTemplateModel, de.hybris.platform.core.model.user.UserModel)Creates a new workflow instance using this template for getting attributes.
- Returns:
- new workflow instance
-
createActions
protected java.util.List<WorkflowAction> createActions(Workflow workflow)
Deprecated.Creates new actions corresponding to the action templates set to this workflow template. Also creates the decisions and links associated- Parameters:
workflow- workflow instance set to the new action instances- Returns:
- list of created actions
-
copyAndConnectionAttribute
public void copyAndConnectionAttribute(WorkflowDecisionTemplate workflowDecisionTemplate, java.util.List<WorkflowAction> workflowActions, WorkflowDecision newDecision)
Deprecated.Sets the andConntection Attribute on the extendet Relation WorkflowActionLinkRelation.- Parameters:
workflowDecisionTemplate- The decisionTemplate which holds the source for the copy.workflowActions- The list actions in this workflow.newDecision- The new workflowDecision which holds the target of the copy.
-
getWorkAction
protected WorkflowAction getWorkAction(WorkflowActionTemplate templateAction, java.util.List<WorkflowAction> workflowActions)
Deprecated.Gets the action out of given action list which was created by given action template.- Parameters:
templateAction- template for which a corresponding action is searchedworkflowActions- list of actions which will be searched- Returns:
- the action that was created based on given action template
-
performCronJob
protected CronJob.CronJobResult performCronJob(CronJob cronJob) throws AbortCronJobException
Deprecated.Description copied from class:JobYou have to implement this method in yourJob. Here you can execute the job. You have to return aCronJobResultthat indicates whether theJobwas successfully executed or not.- Specified by:
performCronJobin classJob- Parameters:
cronJob- the CronJob to execute- Returns:
- a
CronJobResultthat indicates whether theJobwas successfully executed or not. - Throws:
AbortCronJobException- See Also:
CronJob.getFinishedResult(boolean),CronJob.getAbortResult()
-
addToActions
public void addToActions(SessionContext ctx, WorkflowActionTemplate value)
Deprecated.Description copied from class:GeneratedWorkflowTemplateGenerated method - Addsvalueto actions.- Overrides:
addToActionsin classGeneratedWorkflowTemplatevalue- the item to add to actions - n-part of the WorkflowTemplateActionTemplateRelation; set of action templates from which a action will be created and set to the workflow created by the workflow template each
-
remove
public void remove(SessionContext ctx) throws ConsistencyCheckException
Deprecated.Description copied from class:JobFirst all assignedCronJobswere removed, than theJobitself.- Overrides:
removein classJob- Parameters:
ctx- A SessionContext object- Throws:
ConsistencyCheckException- if this item could not be removed for some reason- See Also:
Item.remove(de.hybris.platform.jalo.SessionContext)
-
setOwner
public void setOwner(Item item) throws ConsistencyCheckException
Deprecated.- Overrides:
setOwnerin classItem- Throws:
ConsistencyCheckException
-
isValidWorkflowTemplateActions
protected boolean isValidWorkflowTemplateActions()
Deprecated.checks if all workflow template actions have at least one option, except for the actions with action type end- Returns:
- true if all workflow template actions have at least one option
-
-