Package de.hybris.platform.workflow.model

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:

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 final String	_TYPECODE	Generated model type code constant.
static final String	_WORKFLOWTEMPLATEFORCATALOGVERSION	Generated relation code constant for relation WorkflowTemplateForCatalogVersion defining source attribute catalogVersions in extension cms2.
static final String	ACTIONS	Generated constant - Attribute key of WorkflowTemplate.actions attribute defined at extension workflow.
static final String	ACTIVATIONSCRIPT	Generated constant - Attribute key of WorkflowTemplate.activationScript attribute defined at extension workflow.
static final String	CATALOGVERSIONS	Generated constant - Attribute key of WorkflowTemplate.catalogVersions attribute defined at extension cms2.
static final String	DESCRIPTION	Generated constant - Attribute key of WorkflowTemplate.description attribute defined at extension workflow.
static final String	NAME	Generated constant - Attribute key of WorkflowTemplate.name attribute defined at extension workflow.
static final String	VISIBLEFORPRINCIPALS	Generated constant - Attribute key of WorkflowTemplate.visibleForPrincipals attribute defined at extension workflow.

Fields inherited from class de.hybris.platform.cronjob.model.JobModel

ACTIVE, ALTERNATIVEDATASOURCEID, CHANGERECORDINGENABLED, CODE, CRONJOBS, EMAILADDRESS, EMAILNOTIFICATIONTEMPLATE, ERRORMODE, LOGLEVELDATABASE, LOGLEVELFILE, LOGTODATABASE, LOGTOFILE, NODEGROUP, NODEID, NUMBEROFRETRIES, PRIORITY, REMOVEONEXIT, REQUESTABORT, REQUESTABORTSTEP, RESTRICTIONS, RETRY, SENDEMAIL, SESSIONCONTEXTVALUES, SESSIONCURRENCY, SESSIONLANGUAGE, SESSIONUSER, SINGLEEXECUTABLE, TRIGGERS, USEREADONLYDATASOURCE

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 context
WorkflowTemplateModel(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 parameters
WorkflowTemplateModel(String _code, 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

Modifier and Type	Method	Description
List<WorkflowActionTemplateModel>	getActions()	Generated method - Getter of the WorkflowTemplate.actions attribute defined at extension workflow.
String	getActivationScript()	Generated method - Getter of the WorkflowTemplate.activationScript attribute defined at extension workflow.
Collection<CatalogVersionModel>	getCatalogVersions()	Generated method - Getter of the WorkflowTemplate.catalogVersions attribute defined at extension cms2.
String	getDescription()	Generated method - Getter of the WorkflowTemplate.description attribute defined at extension workflow.
String	getDescription(Locale loc)	Generated method - Getter of the WorkflowTemplate.description attribute defined at extension workflow.
String	getName()	Generated method - Getter of the WorkflowTemplate.name attribute defined at extension workflow.
String	getName(Locale loc)	Generated method - Getter of the WorkflowTemplate.name attribute defined at extension workflow.
UserModel	getOwner()	Generated method - Getter of the Item.owner attribute defined at extension core and redeclared at extension workflow.
Collection<PrincipalModel>	getVisibleForPrincipals()	Generated method - Getter of the WorkflowTemplate.visibleForPrincipals attribute defined at extension workflow.
void	setActions(List<WorkflowActionTemplateModel> value)	Generated method - Setter of WorkflowTemplate.actions attribute defined at extension workflow.
void	setActivationScript(String value)	Generated method - Setter of WorkflowTemplate.activationScript attribute defined at extension workflow.
void	setCatalogVersions(Collection<CatalogVersionModel> value)	Generated method - Setter of WorkflowTemplate.catalogVersions attribute defined at extension cms2.
void	setDescription(String value)	Generated method - Setter of WorkflowTemplate.description attribute defined at extension workflow.
void	setDescription(String value, Locale loc)	Generated method - Setter of WorkflowTemplate.description attribute defined at extension workflow.
void	setName(String value)	Generated method - Setter of WorkflowTemplate.name attribute defined at extension workflow.
void	setName(String value, Locale loc)	Generated method - Setter of WorkflowTemplate.name attribute defined at extension workflow.
void	setOwner(ItemModel value)	Generated method - Setter of Item.owner attribute defined at extension core and redeclared at extension workflow.
void	setVisibleForPrincipals(Collection<PrincipalModel> value)	Generated method - Setter of WorkflowTemplate.visibleForPrincipals attribute defined at extension workflow.

Methods inherited from class de.hybris.platform.cronjob.model.JobModel

getActive, getAlternativeDataSourceID, getChangeRecordingEnabled, getCode, getCronJobs, getEmailAddress, getEmailNotificationTemplate, getErrorMode, getLogLevelDatabase, getLogLevelFile, getLogToDatabase, getLogToFile, getNodeGroup, getNodeID, getNumberOfRetries, getPriority, getRemoveOnExit, getRequestAbort, getRequestAbortStep, getRestrictions, getRetry, getSendEmail, getSessionCurrency, getSessionLanguage, getSessionUser, getSingleExecutable, getTriggers, getUseReadOnlyDatasource, setActive, setAlternativeDataSourceID, setChangeRecordingEnabled, setCode, setEmailAddress, setEmailNotificationTemplate, setErrorMode, setLogLevelDatabase, setLogLevelFile, setLogToDatabase, setLogToFile, setNodeGroup, setNodeID, setNumberOfRetries, setPriority, setRemoveOnExit, setRequestAbort, setRequestAbortStep, setRestrictions, setRetry, setSendEmail, setSessionCurrency, setSessionLanguage, setSessionUser, setSingleExecutable, setTriggers, setUseReadOnlyDatasource

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

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

_TYPECODE

public static final String _TYPECODE

Generated model type code constant.

See Also:

• Constant Field Values

_WORKFLOWTEMPLATEFORCATALOGVERSION

public static final String _WORKFLOWTEMPLATEFORCATALOGVERSION

Generated relation code constant for relation WorkflowTemplateForCatalogVersion defining source attribute catalogVersions in extension cms2.

See Also:

• Constant Field Values

NAME

public static final String NAME

Generated constant - Attribute key of WorkflowTemplate.name attribute defined at extension workflow.

See Also:

• Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

Generated constant - Attribute key of WorkflowTemplate.description attribute defined at extension workflow.

See Also:

• Constant Field Values

ACTIVATIONSCRIPT

public static final String ACTIVATIONSCRIPT

Generated constant - Attribute key of WorkflowTemplate.activationScript attribute defined at extension workflow.

See Also:

• Constant Field Values

ACTIONS

public static final String ACTIONS

Generated constant - Attribute key of WorkflowTemplate.actions attribute defined at extension workflow.

See Also:

• Constant Field Values

VISIBLEFORPRINCIPALS

public static final String VISIBLEFORPRINCIPALS

Generated constant - Attribute key of WorkflowTemplate.visibleForPrincipals attribute defined at extension workflow.

See Also:

• Constant Field Values

CATALOGVERSIONS

public static final String CATALOGVERSIONS

Generated constant - Attribute key of WorkflowTemplate.catalogVersions attribute defined at extension cms2.

See Also:

• Constant Field Values

Constructor Details

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(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 parameters

Generated constructor - Constructor with all mandatory attributes.

Parameters:

_code - initial attribute declared by type WorkflowTemplate at extension workflow

WorkflowTemplateModel

@Deprecated(since="4.1.1",
            forRemoval=true)
public WorkflowTemplateModel(String _code,
 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

Generated constructor - for all mandatory and initial attributes.

Parameters:

_code - initial attribute declared by type WorkflowTemplate at extension workflow

_nodeID - initial attribute declared by type Job at extension processing

_owner - initial attribute declared by type WorkflowTemplate at extension workflow

Method Details

getActions

@Accessor(qualifier="actions",
          type=GETTER)
public List<WorkflowActionTemplateModel> getActions()

Generated method - Getter of the WorkflowTemplate.actions attribute defined at extension workflow. 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 String getActivationScript()

Generated method - Getter of the WorkflowTemplate.activationScript attribute defined at extension workflow.

Returns:

the activationScript - Java code used to automatically trigger a Workflow

getCatalogVersions

@Accessor(qualifier="catalogVersions",
          type=GETTER)
public Collection<CatalogVersionModel> getCatalogVersions()

Generated method - Getter of the WorkflowTemplate.catalogVersions attribute defined at extension cms2. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the catalogVersions

getDescription

@Accessor(qualifier="description",
          type=GETTER)
public String getDescription()

Generated method - Getter of the WorkflowTemplate.description attribute defined at extension workflow.

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 String getDescription(Locale loc)

Generated method - Getter of the WorkflowTemplate.description attribute defined at extension workflow.

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:

IllegalArgumentException - if localization key cannot be mapped to data language

getName

@Accessor(qualifier="name",
          type=GETTER)
public String getName()

Generated method - Getter of the WorkflowTemplate.name attribute defined at extension workflow.

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 String getName(Locale loc)

Generated method - Getter of the WorkflowTemplate.name attribute defined at extension workflow.

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:

IllegalArgumentException - if localization key cannot be mapped to data language

getOwner

@Accessor(qualifier="owner",
          type=GETTER)
public UserModel getOwner()

Generated method - Getter of the Item.owner attribute defined at extension core and redeclared at extension workflow.

Overrides:

getOwner in class ItemModel

Returns:

the owner - responsible user for this template

getVisibleForPrincipals

@Accessor(qualifier="visibleForPrincipals",
          type=GETTER)
public Collection<PrincipalModel> getVisibleForPrincipals()

Generated method - Getter of the WorkflowTemplate.visibleForPrincipals attribute defined at extension workflow. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.

Returns:

the visibleForPrincipals

setActions

@Accessor(qualifier="actions",
          type=SETTER)
public void setActions(List<WorkflowActionTemplateModel> value)

Generated method - Setter of WorkflowTemplate.actions attribute defined at extension workflow.

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(String value)

Generated method - Setter of WorkflowTemplate.activationScript attribute defined at extension workflow.

Parameters:

value - the activationScript - Java code used to automatically trigger a Workflow

setCatalogVersions

@Accessor(qualifier="catalogVersions",
          type=SETTER)
public void setCatalogVersions(Collection<CatalogVersionModel> value)

Generated method - Setter of WorkflowTemplate.catalogVersions attribute defined at extension cms2.

Parameters:

value - the catalogVersions

setDescription

@Accessor(qualifier="description",
          type=SETTER)
public void setDescription(String value)

Generated method - Setter of WorkflowTemplate.description attribute defined at extension workflow.

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(String value,
 Locale loc)

Generated method - Setter of WorkflowTemplate.description attribute defined at extension workflow.

Parameters:

value - the description - description of the workflows created by the template; will be copied to a created workflow initially

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setName

@Accessor(qualifier="name",
          type=SETTER)
public void setName(String value)

Generated method - Setter of WorkflowTemplate.name attribute defined at extension workflow.

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(String value,
 Locale loc)

Generated method - Setter of WorkflowTemplate.name attribute defined at extension workflow.

Parameters:

value - the name - name of the workflows created by the template; will be copied to a created workflow initially

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setOwner

@Accessor(qualifier="owner",
          type=SETTER)
public void setOwner(ItemModel value)

Generated method - Setter of Item.owner attribute defined at extension core and redeclared at extension workflow. Will only accept values of type UserModel.

Overrides:

setOwner in class ItemModel

Parameters:

value - the owner - responsible user for this template

setVisibleForPrincipals

@Accessor(qualifier="visibleForPrincipals",
          type=SETTER)
public void setVisibleForPrincipals(Collection<PrincipalModel> value)

Generated method - Setter of WorkflowTemplate.visibleForPrincipals attribute defined at extension workflow.

Parameters:

value - the visibleForPrincipals