Class WorkflowTemplateModel
- java.lang.Object
-
- de.hybris.platform.servicelayer.model.AbstractItemModel
-
- de.hybris.platform.core.model.ItemModel
-
- de.hybris.platform.cronjob.model.JobModel
-
- de.hybris.platform.workflow.model.WorkflowTemplateModel
-
- All Implemented Interfaces:
java.io.Serializable
public class WorkflowTemplateModel extends JobModel
Generated model class for type WorkflowTemplate first defined at extension workflow.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel
AbstractItemModel.NewModelContextFactory
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
_TYPECODE
Generated model type code constant.static java.lang.String
_WORKFLOWTEMPLATEFORCATALOGVERSION
Generated relation code constant for relationWorkflowTemplateForCatalogVersion
defining source attributecatalogVersions
in extensioncms2
.static java.lang.String
ACTIONS
Generated constant - Attribute key ofWorkflowTemplate.actions
attribute defined at extensionworkflow
.static java.lang.String
ACTIVATIONSCRIPT
Generated constant - Attribute key ofWorkflowTemplate.activationScript
attribute defined at extensionworkflow
.static java.lang.String
CATALOGVERSIONS
Generated constant - Attribute key ofWorkflowTemplate.catalogVersions
attribute defined at extensioncms2
.static java.lang.String
DESCRIPTION
Generated constant - Attribute key ofWorkflowTemplate.description
attribute defined at extensionworkflow
.static java.lang.String
NAME
Generated constant - Attribute key ofWorkflowTemplate.name
attribute defined at extensionworkflow
.static java.lang.String
VISIBLEFORPRINCIPALS
Generated constant - Attribute key ofWorkflowTemplate.visibleForPrincipals
attribute defined at extensionworkflow
.-
Fields inherited from class de.hybris.platform.cronjob.model.JobModel
ACTIVE, ALTERNATIVEDATASOURCEID, CHANGERECORDINGENABLED, CODE, CRONJOBS, EMAILADDRESS, EMAILNOTIFICATIONTEMPLATE, ERRORMODE, LOGLEVELDATABASE, LOGLEVELFILE, LOGTODATABASE, LOGTOFILE, NODEGROUP, NODEID, PRIORITY, REMOVEONEXIT, REQUESTABORT, REQUESTABORTSTEP, RESTRICTIONS, RETRY, SENDEMAIL, SESSIONCONTEXTVALUES, SESSIONCURRENCY, SESSIONLANGUAGE, SESSIONUSER, SINGLEEXECUTABLE, TRIGGERS
-
Fields inherited from class de.hybris.platform.core.model.ItemModel
_COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK, SEALED
-
Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel
LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY
-
-
Constructor Summary
Constructors Constructor Description WorkflowTemplateModel()
Generated constructor - Default constructor for generic creation.WorkflowTemplateModel(ItemModelContext ctx)
Generated constructor - Default constructor for creation with existing contextWorkflowTemplateModel(java.lang.String _code)
Deprecated, for removal: This API element is subject to removal in a future version.since 4.1.1 Please use the default constructor without parametersWorkflowTemplateModel(java.lang.String _code, java.lang.Integer _nodeID, UserModel _owner)
Deprecated, for removal: This API element is subject to removal in a future version.since 4.1.1 Please use the default constructor without parameters
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.List<WorkflowActionTemplateModel>
getActions()
Generated method - Getter of theWorkflowTemplate.actions
attribute defined at extensionworkflow
.java.lang.String
getActivationScript()
Generated method - Getter of theWorkflowTemplate.activationScript
attribute defined at extensionworkflow
.java.util.Collection<CatalogVersionModel>
getCatalogVersions()
Generated method - Getter of theWorkflowTemplate.catalogVersions
attribute defined at extensioncms2
.java.lang.String
getDescription()
Generated method - Getter of theWorkflowTemplate.description
attribute defined at extensionworkflow
.java.lang.String
getDescription(java.util.Locale loc)
Generated method - Getter of theWorkflowTemplate.description
attribute defined at extensionworkflow
.java.lang.String
getName()
Generated method - Getter of theWorkflowTemplate.name
attribute defined at extensionworkflow
.java.lang.String
getName(java.util.Locale loc)
Generated method - Getter of theWorkflowTemplate.name
attribute defined at extensionworkflow
.UserModel
getOwner()
Generated method - Getter of theItem.owner
attribute defined at extensioncore
and redeclared at extensionworkflow
.java.util.Collection<PrincipalModel>
getVisibleForPrincipals()
Generated method - Getter of theWorkflowTemplate.visibleForPrincipals
attribute defined at extensionworkflow
.void
setActions(java.util.List<WorkflowActionTemplateModel> value)
Generated method - Setter ofWorkflowTemplate.actions
attribute defined at extensionworkflow
.void
setActivationScript(java.lang.String value)
Generated method - Setter ofWorkflowTemplate.activationScript
attribute defined at extensionworkflow
.void
setCatalogVersions(java.util.Collection<CatalogVersionModel> value)
Generated method - Setter ofWorkflowTemplate.catalogVersions
attribute defined at extensioncms2
.void
setDescription(java.lang.String value)
Generated method - Setter ofWorkflowTemplate.description
attribute defined at extensionworkflow
.void
setDescription(java.lang.String value, java.util.Locale loc)
Generated method - Setter ofWorkflowTemplate.description
attribute defined at extensionworkflow
.void
setName(java.lang.String value)
Generated method - Setter ofWorkflowTemplate.name
attribute defined at extensionworkflow
.void
setName(java.lang.String value, java.util.Locale loc)
Generated method - Setter ofWorkflowTemplate.name
attribute defined at extensionworkflow
.void
setOwner(ItemModel value)
Generated method - Setter ofItem.owner
attribute defined at extensioncore
and redeclared at extensionworkflow
.void
setVisibleForPrincipals(java.util.Collection<PrincipalModel> value)
Generated method - Setter ofWorkflowTemplate.visibleForPrincipals
attribute defined at extensionworkflow
.-
Methods inherited from class de.hybris.platform.cronjob.model.JobModel
getActive, getAlternativeDataSourceID, getChangeRecordingEnabled, getCode, getCronJobs, getEmailAddress, getEmailNotificationTemplate, getErrorMode, getLogLevelDatabase, getLogLevelFile, getLogToDatabase, getLogToFile, getNodeGroup, getNodeID, getPriority, getRemoveOnExit, getRequestAbort, getRequestAbortStep, getRestrictions, getRetry, getSendEmail, getSessionCurrency, getSessionLanguage, getSessionUser, getSingleExecutable, getTriggers, setActive, setAlternativeDataSourceID, setChangeRecordingEnabled, setCode, setEmailAddress, setEmailNotificationTemplate, setErrorMode, setLogLevelDatabase, setLogLevelFile, setLogToDatabase, setLogToFile, setNodeGroup, setNodeID, setPriority, setRemoveOnExit, setRequestAbort, setRequestAbortStep, setRestrictions, setRetry, setSendEmail, setSessionCurrency, setSessionLanguage, setSessionUser, setSingleExecutable, setTriggers
-
Methods inherited from class de.hybris.platform.core.model.ItemModel
getComments, getCreationtime, getModifiedtime, isSealed, setComments, setCreationtime, setModifiedtime
-
Methods inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel
equals, getItemModelContext, getItemtype, getPersistenceContext, getPk, getProperty, getProperty, getTenantId, hashCode, readResolve, setProperty, setProperty, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toObject, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toPrimitive, toString, writeReplace
-
-
-
-
Field Detail
-
_TYPECODE
public static final java.lang.String _TYPECODE
Generated model type code constant.- See Also:
- Constant Field Values
-
_WORKFLOWTEMPLATEFORCATALOGVERSION
public static final java.lang.String _WORKFLOWTEMPLATEFORCATALOGVERSION
Generated relation code constant for relationWorkflowTemplateForCatalogVersion
defining source attributecatalogVersions
in extensioncms2
.- See Also:
- Constant Field Values
-
NAME
public static final java.lang.String NAME
Generated constant - Attribute key ofWorkflowTemplate.name
attribute defined at extensionworkflow
.- See Also:
- Constant Field Values
-
DESCRIPTION
public static final java.lang.String DESCRIPTION
Generated constant - Attribute key ofWorkflowTemplate.description
attribute defined at extensionworkflow
.- See Also:
- Constant Field Values
-
ACTIVATIONSCRIPT
public static final java.lang.String ACTIVATIONSCRIPT
Generated constant - Attribute key ofWorkflowTemplate.activationScript
attribute defined at extensionworkflow
.- See Also:
- Constant Field Values
-
ACTIONS
public static final java.lang.String ACTIONS
Generated constant - Attribute key ofWorkflowTemplate.actions
attribute defined at extensionworkflow
.- See Also:
- Constant Field Values
-
VISIBLEFORPRINCIPALS
public static final java.lang.String VISIBLEFORPRINCIPALS
Generated constant - Attribute key ofWorkflowTemplate.visibleForPrincipals
attribute defined at extensionworkflow
.- See Also:
- Constant Field Values
-
CATALOGVERSIONS
public static final java.lang.String CATALOGVERSIONS
Generated constant - Attribute key ofWorkflowTemplate.catalogVersions
attribute defined at extensioncms2
.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
WorkflowTemplateModel
public WorkflowTemplateModel()
Generated constructor - Default constructor for generic creation.
-
WorkflowTemplateModel
public WorkflowTemplateModel(ItemModelContext ctx)
Generated constructor - Default constructor for creation with existing context- Parameters:
ctx
- the model context to be injected, must not be null
-
WorkflowTemplateModel
@Deprecated(since="4.1.1", forRemoval=true) public WorkflowTemplateModel(java.lang.String _code)
Deprecated, for removal: This API element is subject to removal in a future version.since 4.1.1 Please use the default constructor without parametersGenerated constructor - Constructor with all mandatory attributes.- Parameters:
_code
- initial attribute declared by typeWorkflowTemplate
at extensionworkflow
-
WorkflowTemplateModel
@Deprecated(since="4.1.1", forRemoval=true) public WorkflowTemplateModel(java.lang.String _code, java.lang.Integer _nodeID, UserModel _owner)
Deprecated, for removal: This API element is subject to removal in a future version.since 4.1.1 Please use the default constructor without parametersGenerated constructor - for all mandatory and initial attributes.- Parameters:
_code
- initial attribute declared by typeWorkflowTemplate
at extensionworkflow
_nodeID
- initial attribute declared by typeJob
at extensionprocessing
_owner
- initial attribute declared by typeWorkflowTemplate
at extensionworkflow
-
-
Method Detail
-
getActions
@Accessor(qualifier="actions", type=GETTER) public java.util.List<WorkflowActionTemplateModel> getActions()
Generated method - Getter of theWorkflowTemplate.actions
attribute defined at extensionworkflow
. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the 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
-
getActivationScript
@Accessor(qualifier="activationScript", type=GETTER) public java.lang.String getActivationScript()
Generated method - Getter of theWorkflowTemplate.activationScript
attribute defined at extensionworkflow
.- Returns:
- the activationScript - Java code used to automatically trigger a Workflow
-
getCatalogVersions
@Accessor(qualifier="catalogVersions", type=GETTER) public java.util.Collection<CatalogVersionModel> getCatalogVersions()
Generated method - Getter of theWorkflowTemplate.catalogVersions
attribute defined at extensioncms2
. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the catalogVersions
-
getDescription
@Accessor(qualifier="description", type=GETTER) public java.lang.String getDescription()
Generated method - Getter of theWorkflowTemplate.description
attribute defined at extensionworkflow
.- Returns:
- the description - description of the workflows created by the template; will be copied to a created workflow initially
-
getDescription
@Accessor(qualifier="description", type=GETTER) public java.lang.String getDescription(java.util.Locale loc)
Generated method - Getter of theWorkflowTemplate.description
attribute defined at extensionworkflow
.- Parameters:
loc
- the value localization key- Returns:
- the description - description of the workflows created by the template; will be copied to a created workflow initially
- Throws:
java.lang.IllegalArgumentException
- if localization key cannot be mapped to data language
-
getName
@Accessor(qualifier="name", type=GETTER) public java.lang.String getName()
Generated method - Getter of theWorkflowTemplate.name
attribute defined at extensionworkflow
.- Returns:
- the name - name of the workflows created by the template; will be copied to a created workflow initially
-
getName
@Accessor(qualifier="name", type=GETTER) public java.lang.String getName(java.util.Locale loc)
Generated method - Getter of theWorkflowTemplate.name
attribute defined at extensionworkflow
.- Parameters:
loc
- the value localization key- Returns:
- the name - name of the workflows created by the template; will be copied to a created workflow initially
- Throws:
java.lang.IllegalArgumentException
- if localization key cannot be mapped to data language
-
getOwner
@Accessor(qualifier="owner", type=GETTER) public UserModel getOwner()
Generated method - Getter of theItem.owner
attribute defined at extensioncore
and redeclared at extensionworkflow
.
-
getVisibleForPrincipals
@Accessor(qualifier="visibleForPrincipals", type=GETTER) public java.util.Collection<PrincipalModel> getVisibleForPrincipals()
Generated method - Getter of theWorkflowTemplate.visibleForPrincipals
attribute defined at extensionworkflow
. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.- Returns:
- the visibleForPrincipals
-
setActions
@Accessor(qualifier="actions", type=SETTER) public void setActions(java.util.List<WorkflowActionTemplateModel> value)
Generated method - Setter ofWorkflowTemplate.actions
attribute defined at extensionworkflow
.- Parameters:
value
- the 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
-
setActivationScript
@Accessor(qualifier="activationScript", type=SETTER) public void setActivationScript(java.lang.String value)
Generated method - Setter ofWorkflowTemplate.activationScript
attribute defined at extensionworkflow
.- Parameters:
value
- the activationScript - Java code used to automatically trigger a Workflow
-
setCatalogVersions
@Accessor(qualifier="catalogVersions", type=SETTER) public void setCatalogVersions(java.util.Collection<CatalogVersionModel> value)
Generated method - Setter ofWorkflowTemplate.catalogVersions
attribute defined at extensioncms2
.- Parameters:
value
- the catalogVersions
-
setDescription
@Accessor(qualifier="description", type=SETTER) public void setDescription(java.lang.String value)
Generated method - Setter ofWorkflowTemplate.description
attribute defined at extensionworkflow
.- Parameters:
value
- the description - description of the workflows created by the template; will be copied to a created workflow initially
-
setDescription
@Accessor(qualifier="description", type=SETTER) public void setDescription(java.lang.String value, java.util.Locale loc)
Generated method - Setter ofWorkflowTemplate.description
attribute defined at extensionworkflow
.- Parameters:
value
- the description - description of the workflows created by the template; will be copied to a created workflow initiallyloc
- the value localization key- Throws:
java.lang.IllegalArgumentException
- if localization key cannot be mapped to data language
-
setName
@Accessor(qualifier="name", type=SETTER) public void setName(java.lang.String value)
Generated method - Setter ofWorkflowTemplate.name
attribute defined at extensionworkflow
.- Parameters:
value
- the name - name of the workflows created by the template; will be copied to a created workflow initially
-
setName
@Accessor(qualifier="name", type=SETTER) public void setName(java.lang.String value, java.util.Locale loc)
Generated method - Setter ofWorkflowTemplate.name
attribute defined at extensionworkflow
.- Parameters:
value
- the name - name of the workflows created by the template; will be copied to a created workflow initiallyloc
- the value localization key- Throws:
java.lang.IllegalArgumentException
- if localization key cannot be mapped to data language
-
setOwner
@Accessor(qualifier="owner", type=SETTER) public void setOwner(ItemModel value)
Generated method - Setter ofItem.owner
attribute defined at extensioncore
and redeclared at extensionworkflow
. Will only accept values of typeUserModel
.
-
setVisibleForPrincipals
@Accessor(qualifier="visibleForPrincipals", type=SETTER) public void setVisibleForPrincipals(java.util.Collection<PrincipalModel> value)
Generated method - Setter ofWorkflowTemplate.visibleForPrincipals
attribute defined at extensionworkflow
.- Parameters:
value
- the visibleForPrincipals
-
-