de.hybris.platform.workflow.model

Class WorkflowModel

java.lang.Object

de.hybris.platform.servicelayer.model.AbstractItemModel

de.hybris.platform.core.model.ItemModel

de.hybris.platform.cronjob.model.CronJobModel

de.hybris.platform.workflow.model.WorkflowModel

All Implemented Interfaces:

Serializable

public class WorkflowModel
extends CronJobModel

Generated model class for type Workflow 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 and Description
static String	_JOBCRONJOBRELATION Generated relation code constant for relation JobCronJobRelation defining source attribute job in extension processing.
static String	_TYPECODE Generated model type code constant.
static String	ACTIONS Generated constant - Attribute key of Workflow.actions attribute defined at extension workflow.
static String	ASSIGNEDJOB Generated constant - Attribute key of Workflow.assignedJob attribute defined at extension print.
static String	ATTACHMENTS Generated constant - Attribute key of Workflow.attachments attribute defined at extension workflow.
static String	DESCRIPTION Generated constant - Attribute key of Workflow.description attribute defined at extension workflow.
static String	NAME Generated constant - Attribute key of Workflow.name attribute defined at extension workflow.
static String	PRINCIPALASSIGNED Generated constant - Attribute key of Workflow.principalAssigned attribute defined at extension print.

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

ACTIVE, ALTERNATIVEDATASOURCEID, CHANGERECORDINGENABLED, CHANGES, CODE, CURRENTSTEP, EMAILADDRESS, EMAILNOTIFICATIONTEMPLATE, ENDTIME, ERRORMODE, FILESCOUNT, FILESDAYSOLD, FILESOPERATOR, JOB, LOGFILES, LOGLEVELDATABASE, LOGLEVELFILE, LOGS, LOGSCOUNT, LOGSDAYSOLD, LOGSOPERATOR, LOGTEXT, LOGTODATABASE, LOGTOFILE, NODEGROUP, NODEID, PENDINGSTEPS, PRIORITY, PROCESSEDSTEPS, REMOVEONEXIT, REQUESTABORT, REQUESTABORTSTEP, RESULT, RETRY, RUNNINGONCLUSTERNODE, SENDEMAIL, SESSIONCONTEXTVALUES, SESSIONCURRENCY, SESSIONLANGUAGE, SESSIONUSER, SINGLEEXECUTABLE, STARTTIME, STATUS, TIMETABLE, TRIGGERS

Fields inherited from class de.hybris.platform.core.model.ItemModel

_COMMENTITEMRELATION, COMMENTS, CREATIONTIME, ITEMTYPE, MODIFIEDTIME, OWNER, PK

Fields inherited from class de.hybris.platform.servicelayer.model.AbstractItemModel

LANGUAGE_FALLBACK_ENABLED_SERVICE_LAYER, MODEL_CONTEXT_FACTORY

Constructor Summary

Constructors

Constructor and Description
WorkflowModel() Generated constructor - Default constructor for generic creation.
WorkflowModel(ItemModelContext ctx) Generated constructor - Default constructor for creation with existing context
WorkflowModel(WorkflowTemplateModel _job, PrincipalModel _principalAssigned) Deprecated. Since 4.1.1 Please use the default constructor without parameters
WorkflowModel(WorkflowTemplateModel _job, UserModel _owner, PrincipalModel _principalAssigned) Deprecated. Since 4.1.1 Please use the default constructor without parameters

Method Summary

Modifier and Type	Method and Description
List<WorkflowActionModel>	getActions() Generated method - Getter of the Workflow.actions attribute defined at extension workflow.
AbstractCommentModel	getAssignedJob() Generated method - Getter of the Workflow.assignedJob dynamic attribute defined at extension print.
List<WorkflowItemAttachmentModel>	getAttachments() Generated method - Getter of the Workflow.attachments attribute defined at extension workflow.
String	getDescription() Generated method - Getter of the Workflow.description attribute defined at extension workflow.
String	getDescription(Locale loc) Generated method - Getter of the Workflow.description attribute defined at extension workflow.
WorkflowTemplateModel	getJob() Generated method - Getter of the CronJob.job attribute defined at extension processing and redeclared at extension workflow.
String	getName() Generated method - Getter of the Workflow.name attribute defined at extension workflow.
String	getName(Locale loc) Generated method - Getter of the Workflow.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.
PrincipalModel	getPrincipalAssigned() Generated method - Getter of the Workflow.principalAssigned attribute defined at extension print.
void	setActions(List<WorkflowActionModel> value) Generated method - Setter of Workflow.actions attribute defined at extension workflow.
void	setAssignedJob(AbstractCommentModel value) Generated method - Setter of Workflow.assignedJob dynamic attribute defined at extension print.
void	setAttachments(List<WorkflowItemAttachmentModel> value) Generated method - Setter of Workflow.attachments attribute defined at extension workflow.
void	setDescription(String value) Generated method - Setter of Workflow.description attribute defined at extension workflow.
void	setDescription(String value, Locale loc) Generated method - Setter of Workflow.description attribute defined at extension workflow.
void	setJob(JobModel value) Generated method - Initial setter of CronJob.job attribute defined at extension processing and redeclared at extension workflow.
void	setName(String value) Generated method - Setter of Workflow.name attribute defined at extension workflow.
void	setName(String value, Locale loc) Generated method - Setter of Workflow.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	setPrincipalAssigned(PrincipalModel value) Generated method - Setter of Workflow.principalAssigned attribute defined at extension print.

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

getActive, getAlternativeDataSourceID, getChangeRecordingEnabled, getChanges, getCode, getCurrentStep, getEmailAddress, getEmailNotificationTemplate, getEndTime, getErrorMode, getFilesCount, getFilesDaysOld, getFilesOperator, getLogFiles, getLogLevelDatabase, getLogLevelFile, getLogs, getLogsCount, getLogsDaysOld, getLogsOperator, getLogText, getLogToDatabase, getLogToFile, getNodeGroup, getNodeID, getPendingSteps, getPriority, getProcessedSteps, getRemoveOnExit, getRequestAbort, getRequestAbortStep, getResult, getRetry, getRunningOnClusterNode, getSendEmail, getSessionCurrency, getSessionLanguage, getSessionUser, getSingleExecutable, getStartTime, getStatus, getTimeTable, getTriggers, setActive, setAlternativeDataSourceID, setChangeRecordingEnabled, setCode, setEmailAddress, setEmailNotificationTemplate, setEndTime, setErrorMode, setFilesCount, setFilesDaysOld, setFilesOperator, setLogFiles, setLogLevelDatabase, setLogLevelFile, setLogsCount, setLogsDaysOld, setLogsOperator, setLogToDatabase, setLogToFile, setNodeGroup, setNodeID, setPendingSteps, setPriority, setProcessedSteps, setRemoveOnExit, setRequestAbort, setRequestAbortStep, setResult, setRetry, setRunningOnClusterNode, setSendEmail, setSessionCurrency, setSessionLanguage, setSessionUser, setSingleExecutable, setStartTime, setStatus, setTriggers

Methods inherited from class de.hybris.platform.core.model.ItemModel

getComments, getCreationtime, getModifiedtime, 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 Detail

_TYPECODE

public static final String _TYPECODE

Generated model type code constant.

See Also:

Constant Field Values

_JOBCRONJOBRELATION

public static final String _JOBCRONJOBRELATION

Generated relation code constant for relation JobCronJobRelation defining source attribute job in extension processing.

See Also:

Constant Field Values

NAME

public static final String NAME

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

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

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

See Also:

Constant Field Values

ACTIONS

public static final String ACTIONS

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

See Also:

Constant Field Values

ATTACHMENTS

public static final String ATTACHMENTS

Generated constant - Attribute key of Workflow.attachments attribute defined at extension workflow.

See Also:

Constant Field Values

PRINCIPALASSIGNED

public static final String PRINCIPALASSIGNED

Generated constant - Attribute key of Workflow.principalAssigned attribute defined at extension print.

See Also:

Constant Field Values

ASSIGNEDJOB

public static final String ASSIGNEDJOB

Generated constant - Attribute key of Workflow.assignedJob attribute defined at extension print.

See Also:

Constant Field Values

Constructor Detail

WorkflowModel

public WorkflowModel()

Generated constructor - Default constructor for generic creation.

WorkflowModel

public WorkflowModel(ItemModelContext ctx)

Generated constructor - Default constructor for creation with existing context

Parameters:

ctx - the model context to be injected, must not be null

WorkflowModel

@Deprecated
public WorkflowModel(WorkflowTemplateModel _job,
                                 PrincipalModel _principalAssigned)

Deprecated. Since 4.1.1 Please use the default constructor without parameters

Generated constructor - Constructor with all mandatory attributes.

Parameters:

_job - initial attribute declared by type Workflow at extension workflow

_principalAssigned - initial attribute declared by type Workflow at extension print

WorkflowModel

@Deprecated
public WorkflowModel(WorkflowTemplateModel _job,
                                 UserModel _owner,
                                 PrincipalModel _principalAssigned)

Deprecated. Since 4.1.1 Please use the default constructor without parameters

Generated constructor - for all mandatory and initial attributes.

Parameters:

_job - initial attribute declared by type Workflow at extension workflow

_owner - initial attribute declared by type Workflow at extension workflow

_principalAssigned - initial attribute declared by type Workflow at extension print

Method Detail

getActions

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

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

Returns:

the actions

getAssignedJob

@Accessor(qualifier="assignedJob",
          type=GETTER)
public AbstractCommentModel getAssignedJob()

Generated method - Getter of the Workflow.assignedJob dynamic attribute defined at extension print.

Returns:

the assignedJob

getAttachments

@Accessor(qualifier="attachments",
          type=GETTER)
public List<WorkflowItemAttachmentModel> getAttachments()

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

Returns:

the attachments - n-part of the WorkflowItemAttachmentRelation; holds a set of attachments (item references) belonging to the topic of workflow

getDescription

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

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

Returns:

the description - global description of the workflow while each action has its own description

getDescription

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

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

Parameters:

loc - the value localization key

Returns:

the description - global description of the workflow while each action has its own description

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

getJob

@Accessor(qualifier="job",
          type=GETTER)
public WorkflowTemplateModel getJob()

Generated method - Getter of the CronJob.job attribute defined at extension processing and redeclared at extension workflow.

Overrides:

getJob in class CronJobModel

Returns:

the job - related workflow template this workflow is created from (never changable)

getName

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

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

Returns:

the name - name of the workflow

getName

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

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

Parameters:

loc - the value localization key

Returns:

the name - name of the workflow

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 - user responsible for this workflow

getPrincipalAssigned

@Accessor(qualifier="principalAssigned",
          type=GETTER)
public PrincipalModel getPrincipalAssigned()

Generated method - Getter of the Workflow.principalAssigned attribute defined at extension print.

Returns:

the principalAssigned - assigned principal who has to assure the completion (can also be a principal group where any member of the group can process the action)

setActions

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

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

Parameters:

value - the actions

setAssignedJob

@Accessor(qualifier="assignedJob",
          type=SETTER)
public void setAssignedJob(AbstractCommentModel value)

Generated method - Setter of Workflow.assignedJob dynamic attribute defined at extension print.

Parameters:

value - the assignedJob

setAttachments

@Accessor(qualifier="attachments",
          type=SETTER)
public void setAttachments(List<WorkflowItemAttachmentModel> value)

Generated method - Setter of Workflow.attachments attribute defined at extension workflow.

Parameters:

value - the attachments - n-part of the WorkflowItemAttachmentRelation; holds a set of attachments (item references) belonging to the topic of workflow

setDescription

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

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

Parameters:

value - the description - global description of the workflow while each action has its own description

setDescription

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

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

Parameters:

value - the description - global description of the workflow while each action has its own description

loc - the value localization key

Throws:

IllegalArgumentException - if localization key cannot be mapped to data language

setJob

@Accessor(qualifier="job",
          type=SETTER)
public void setJob(JobModel value)

Generated method - Initial setter of CronJob.job attribute defined at extension processing and redeclared at extension workflow. Can only be used at creation of model - before first save. Will only accept values of type WorkflowTemplateModel.

Overrides:

setJob in class CronJobModel

Parameters:

value - the job - related workflow template this workflow is created from (never changable)

setName

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

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

Parameters:

value - the name - name of the workflow

setName

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

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

Parameters:

value - the name - name of the workflow

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 - user responsible for this workflow

setPrincipalAssigned

@Accessor(qualifier="principalAssigned",
          type=SETTER)
public void setPrincipalAssigned(PrincipalModel value)

Generated method - Setter of Workflow.principalAssigned attribute defined at extension print.

Parameters:

value - the principalAssigned - assigned principal who has to assure the completion (can also be a principal group where any member of the group can process the action)