Class JobModel

All Implemented Interfaces:
Serializable
Direct Known Subclasses:
BatchJobModel, CompareCatalogVersionsJobModel, CompositeJobModel, ImpExExportJobModel, ImpExImportJobModel, LDIFGroupImportJobModel, LDIFImportJobModel, MoveMediaJobModel, RemoveCatalogVersionJobModel, RemoveItemsJobModel, RemoveOrphanedFilesJobModel, ServicelayerJobModel, SyncItemJobModel, TypeSystemExportJobModel, WorkflowTemplateModel

public class JobModel extends ItemModel
Generated model class for type Job first defined at extension processing.
See Also:
  • Field Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:
    • CODE

      public static final String CODE
      Generated constant - Attribute key of Job.code attribute defined at extension processing.
      See Also:
    • NODEID

      public static final String NODEID
      Generated constant - Attribute key of Job.nodeID attribute defined at extension processing.
      See Also:
    • NODEGROUP

      public static final String NODEGROUP
      Generated constant - Attribute key of Job.nodeGroup attribute defined at extension processing.
      See Also:
    • ERRORMODE

      public static final String ERRORMODE
      Generated constant - Attribute key of Job.errorMode attribute defined at extension processing.
      See Also:
    • LOGTOFILE

      public static final String LOGTOFILE
      Generated constant - Attribute key of Job.logToFile attribute defined at extension processing.
      See Also:
    • LOGTODATABASE

      public static final String LOGTODATABASE
      Generated constant - Attribute key of Job.logToDatabase attribute defined at extension processing.
      See Also:
    • LOGLEVELFILE

      public static final String LOGLEVELFILE
      Generated constant - Attribute key of Job.logLevelFile attribute defined at extension processing.
      See Also:
    • LOGLEVELDATABASE

      public static final String LOGLEVELDATABASE
      Generated constant - Attribute key of Job.logLevelDatabase attribute defined at extension processing.
      See Also:
    • SESSIONUSER

      public static final String SESSIONUSER
      Generated constant - Attribute key of Job.sessionUser attribute defined at extension processing.
      See Also:
    • SESSIONLANGUAGE

      public static final String SESSIONLANGUAGE
      Generated constant - Attribute key of Job.sessionLanguage attribute defined at extension processing.
      See Also:
    • SESSIONCURRENCY

      public static final String SESSIONCURRENCY
      Generated constant - Attribute key of Job.sessionCurrency attribute defined at extension processing.
      See Also:
    • SESSIONCONTEXTVALUES

      public static final String SESSIONCONTEXTVALUES
      Generated constant - Attribute key of Job.sessionContextValues attribute defined at extension processing.
      See Also:
    • ACTIVE

      public static final String ACTIVE
      Generated constant - Attribute key of Job.active attribute defined at extension processing.
      See Also:
    • RETRY

      public static final String RETRY
      Generated constant - Attribute key of Job.retry attribute defined at extension processing.
      See Also:
    • SINGLEEXECUTABLE

      public static final String SINGLEEXECUTABLE
      Generated constant - Attribute key of Job.singleExecutable attribute defined at extension processing.
      See Also:
    • EMAILADDRESS

      public static final String EMAILADDRESS
      Generated constant - Attribute key of Job.emailAddress attribute defined at extension processing.
      See Also:
    • SENDEMAIL

      public static final String SENDEMAIL
      Generated constant - Attribute key of Job.sendEmail attribute defined at extension processing.
      See Also:
    • CHANGERECORDINGENABLED

      public static final String CHANGERECORDINGENABLED
      Generated constant - Attribute key of Job.changeRecordingEnabled attribute defined at extension processing.
      See Also:
    • REQUESTABORT

      public static final String REQUESTABORT
      Generated constant - Attribute key of Job.requestAbort attribute defined at extension processing.
      See Also:
    • REQUESTABORTSTEP

      public static final String REQUESTABORTSTEP
      Generated constant - Attribute key of Job.requestAbortStep attribute defined at extension processing.
      See Also:
    • PRIORITY

      public static final String PRIORITY
      Generated constant - Attribute key of Job.priority attribute defined at extension processing.
      See Also:
    • REMOVEONEXIT

      public static final String REMOVEONEXIT
      Generated constant - Attribute key of Job.removeOnExit attribute defined at extension processing.
      See Also:
    • EMAILNOTIFICATIONTEMPLATE

      public static final String EMAILNOTIFICATIONTEMPLATE
      Generated constant - Attribute key of Job.emailNotificationTemplate attribute defined at extension processing.
      See Also:
    • ALTERNATIVEDATASOURCEID

      public static final String ALTERNATIVEDATASOURCEID
      Generated constant - Attribute key of Job.alternativeDataSourceID attribute defined at extension processing.
      See Also:
    • USEREADONLYDATASOURCE

      public static final String USEREADONLYDATASOURCE
      Generated constant - Attribute key of Job.useReadOnlyDatasource attribute defined at extension processing.
      See Also:
    • NUMBEROFRETRIES

      public static final String NUMBEROFRETRIES
      Generated constant - Attribute key of Job.numberOfRetries attribute defined at extension processing.
      See Also:
    • RESTRICTIONS

      public static final String RESTRICTIONS
      Generated constant - Attribute key of Job.restrictions attribute defined at extension processing.
      See Also:
    • TRIGGERS

      public static final String TRIGGERS
      Generated constant - Attribute key of Job.triggers attribute defined at extension processing.
      See Also:
    • CRONJOBS

      public static final String CRONJOBS
      Generated constant - Attribute key of Job.cronJobs attribute defined at extension processing.
      See Also:
  • Constructor Details

    • JobModel

      public JobModel()
      Generated constructor - Default constructor for generic creation.
    • JobModel

      public JobModel(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      Parameters:
      ctx - the model context to be injected, must not be null
    • JobModel

      @Deprecated(since="4.1.1", forRemoval=true) public JobModel(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 Job at extension processing
    • JobModel

      @Deprecated(since="4.1.1", forRemoval=true) public JobModel(String _code, Integer _nodeID, ItemModel _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 Job at extension processing
      _nodeID - initial attribute declared by type Job at extension processing
      _owner - initial attribute declared by type Item at extension core
  • Method Details

    • getActive

      @Accessor(qualifier="active", type=GETTER) public Boolean getActive()
      Generated method - Getter of the Job.active attribute defined at extension processing.
      Returns:
      the active
    • getAlternativeDataSourceID

      @Accessor(qualifier="alternativeDataSourceID", type=GETTER) public String getAlternativeDataSourceID()
      Generated method - Getter of the Job.alternativeDataSourceID attribute defined at extension processing.
      Returns:
      the alternativeDataSourceID
    • getChangeRecordingEnabled

      @Accessor(qualifier="changeRecordingEnabled", type=GETTER) public Boolean getChangeRecordingEnabled()
      Generated method - Getter of the Job.changeRecordingEnabled attribute defined at extension processing.
      Returns:
      the changeRecordingEnabled
    • getCode

      @Accessor(qualifier="code", type=GETTER) public String getCode()
      Generated method - Getter of the Job.code attribute defined at extension processing.
      Returns:
      the code
    • getCronJobs

      @Accessor(qualifier="cronJobs", type=GETTER) public Collection<CronJobModel> getCronJobs()
      Generated method - Getter of the Job.cronJobs attribute defined at extension processing. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the cronJobs - CronJobs the job is assigned to
    • getEmailAddress

      @Accessor(qualifier="emailAddress", type=GETTER) public String getEmailAddress()
      Generated method - Getter of the Job.emailAddress attribute defined at extension processing.
      Returns:
      the emailAddress
    • getEmailNotificationTemplate

      @Accessor(qualifier="emailNotificationTemplate", type=GETTER) public RendererTemplateModel getEmailNotificationTemplate()
      Generated method - Getter of the Job.emailNotificationTemplate attribute defined at extension processing.
      Returns:
      the emailNotificationTemplate
    • getErrorMode

      @Accessor(qualifier="errorMode", type=GETTER) public ErrorMode getErrorMode()
      Generated method - Getter of the Job.errorMode attribute defined at extension processing.
      Returns:
      the errorMode - the error mode. @since 2.10
    • getLogLevelDatabase

      @Accessor(qualifier="logLevelDatabase", type=GETTER) public JobLogLevel getLogLevelDatabase()
      Generated method - Getter of the Job.logLevelDatabase attribute defined at extension processing.
      Returns:
      the logLevelDatabase
    • getLogLevelFile

      @Accessor(qualifier="logLevelFile", type=GETTER) public JobLogLevel getLogLevelFile()
      Generated method - Getter of the Job.logLevelFile attribute defined at extension processing.
      Returns:
      the logLevelFile
    • getLogToDatabase

      @Accessor(qualifier="logToDatabase", type=GETTER) public Boolean getLogToDatabase()
      Generated method - Getter of the Job.logToDatabase attribute defined at extension processing.
      Returns:
      the logToDatabase
    • getLogToFile

      @Accessor(qualifier="logToFile", type=GETTER) public Boolean getLogToFile()
      Generated method - Getter of the Job.logToFile attribute defined at extension processing.
      Returns:
      the logToFile
    • getNodeGroup

      @Accessor(qualifier="nodeGroup", type=GETTER) public String getNodeGroup()
      Generated method - Getter of the Job.nodeGroup attribute defined at extension processing.
      Returns:
      the nodeGroup
    • getNodeID

      @Accessor(qualifier="nodeID", type=GETTER) public Integer getNodeID()
      Generated method - Getter of the Job.nodeID attribute defined at extension processing.
      Returns:
      the nodeID - Node ID
    • getNumberOfRetries

      @Accessor(qualifier="numberOfRetries", type=GETTER) public int getNumberOfRetries()
      Generated method - Getter of the Job.numberOfRetries attribute defined at extension processing.
      Returns:
      the numberOfRetries - Determine whether cron job should be repeated and how many times in case of an database connection failure
    • getPriority

      @Accessor(qualifier="priority", type=GETTER) public Integer getPriority()
      Generated method - Getter of the Job.priority attribute defined at extension processing.
      Returns:
      the priority - the priority. @since 2.10
    • getRemoveOnExit

      @Accessor(qualifier="removeOnExit", type=GETTER) public Boolean getRemoveOnExit()
      Generated method - Getter of the Job.removeOnExit attribute defined at extension processing.
      Returns:
      the removeOnExit
    • getRequestAbort

      @Accessor(qualifier="requestAbort", type=GETTER) public Boolean getRequestAbort()
      Generated method - Getter of the Job.requestAbort attribute defined at extension processing.
      Returns:
      the requestAbort
    • getRequestAbortStep

      @Accessor(qualifier="requestAbortStep", type=GETTER) public Boolean getRequestAbortStep()
      Generated method - Getter of the Job.requestAbortStep attribute defined at extension processing.
      Returns:
      the requestAbortStep
    • getRestrictions

      @Accessor(qualifier="restrictions", type=GETTER) public List<JobSearchRestrictionModel> getRestrictions()
      Generated method - Getter of the Job.restrictions attribute defined at extension processing. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the restrictions - processed steps
    • getRetry

      @Accessor(qualifier="retry", type=GETTER) public Boolean getRetry()
      Generated method - Getter of the Job.retry attribute defined at extension processing.
      Returns:
      the retry
    • getSendEmail

      @Accessor(qualifier="sendEmail", type=GETTER) public Boolean getSendEmail()
      Generated method - Getter of the Job.sendEmail attribute defined at extension processing.
      Returns:
      the sendEmail
    • getSessionCurrency

      @Accessor(qualifier="sessionCurrency", type=GETTER) public CurrencyModel getSessionCurrency()
      Generated method - Getter of the Job.sessionCurrency attribute defined at extension processing.
      Returns:
      the sessionCurrency
    • getSessionLanguage

      @Accessor(qualifier="sessionLanguage", type=GETTER) public LanguageModel getSessionLanguage()
      Generated method - Getter of the Job.sessionLanguage attribute defined at extension processing.
      Returns:
      the sessionLanguage
    • getSessionUser

      @Accessor(qualifier="sessionUser", type=GETTER) public UserModel getSessionUser()
      Generated method - Getter of the Job.sessionUser attribute defined at extension processing.
      Returns:
      the sessionUser
    • getSingleExecutable

      @Accessor(qualifier="singleExecutable", type=GETTER) public Boolean getSingleExecutable()
      Generated method - Getter of the Job.singleExecutable attribute defined at extension processing.
      Returns:
      the singleExecutable
    • getTriggers

      @Accessor(qualifier="triggers", type=GETTER) public List<TriggerModel> getTriggers()
      Generated method - Getter of the Job.triggers attribute defined at extension processing. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the triggers - list of triggers
    • getUseReadOnlyDatasource

      @Accessor(qualifier="useReadOnlyDatasource", type=GETTER) public Boolean getUseReadOnlyDatasource()
      Generated method - Getter of the Job.useReadOnlyDatasource attribute defined at extension processing.
      Returns:
      the useReadOnlyDatasource
    • setActive

      @Accessor(qualifier="active", type=SETTER) public void setActive(Boolean value)
      Generated method - Setter of Job.active attribute defined at extension processing.
      Parameters:
      value - the active
    • setAlternativeDataSourceID

      @Accessor(qualifier="alternativeDataSourceID", type=SETTER) public void setAlternativeDataSourceID(String value)
      Generated method - Setter of Job.alternativeDataSourceID attribute defined at extension processing.
      Parameters:
      value - the alternativeDataSourceID
    • setChangeRecordingEnabled

      @Accessor(qualifier="changeRecordingEnabled", type=SETTER) public void setChangeRecordingEnabled(Boolean value)
      Generated method - Setter of Job.changeRecordingEnabled attribute defined at extension processing.
      Parameters:
      value - the changeRecordingEnabled
    • setCode

      @Accessor(qualifier="code", type=SETTER) public void setCode(String value)
      Generated method - Setter of Job.code attribute defined at extension processing.
      Parameters:
      value - the code
    • setEmailAddress

      @Accessor(qualifier="emailAddress", type=SETTER) public void setEmailAddress(String value)
      Generated method - Setter of Job.emailAddress attribute defined at extension processing.
      Parameters:
      value - the emailAddress
    • setEmailNotificationTemplate

      @Accessor(qualifier="emailNotificationTemplate", type=SETTER) public void setEmailNotificationTemplate(RendererTemplateModel value)
      Generated method - Setter of Job.emailNotificationTemplate attribute defined at extension processing.
      Parameters:
      value - the emailNotificationTemplate
    • setErrorMode

      @Accessor(qualifier="errorMode", type=SETTER) public void setErrorMode(ErrorMode value)
      Generated method - Setter of Job.errorMode attribute defined at extension processing.
      Parameters:
      value - the errorMode - the error mode. @since 2.10
    • setLogLevelDatabase

      @Accessor(qualifier="logLevelDatabase", type=SETTER) public void setLogLevelDatabase(JobLogLevel value)
      Generated method - Setter of Job.logLevelDatabase attribute defined at extension processing.
      Parameters:
      value - the logLevelDatabase
    • setLogLevelFile

      @Accessor(qualifier="logLevelFile", type=SETTER) public void setLogLevelFile(JobLogLevel value)
      Generated method - Setter of Job.logLevelFile attribute defined at extension processing.
      Parameters:
      value - the logLevelFile
    • setLogToDatabase

      @Accessor(qualifier="logToDatabase", type=SETTER) public void setLogToDatabase(Boolean value)
      Generated method - Setter of Job.logToDatabase attribute defined at extension processing.
      Parameters:
      value - the logToDatabase
    • setLogToFile

      @Accessor(qualifier="logToFile", type=SETTER) public void setLogToFile(Boolean value)
      Generated method - Setter of Job.logToFile attribute defined at extension processing.
      Parameters:
      value - the logToFile
    • setNodeGroup

      @Accessor(qualifier="nodeGroup", type=SETTER) public void setNodeGroup(String value)
      Generated method - Setter of Job.nodeGroup attribute defined at extension processing.
      Parameters:
      value - the nodeGroup
    • setNodeID

      @Accessor(qualifier="nodeID", type=SETTER) public void setNodeID(Integer value)
      Generated method - Initial setter of Job.nodeID attribute defined at extension processing. Can only be used at creation of model - before first save.
      Parameters:
      value - the nodeID - Node ID
    • setNumberOfRetries

      @Accessor(qualifier="numberOfRetries", type=SETTER) public void setNumberOfRetries(int value)
      Generated method - Setter of Job.numberOfRetries attribute defined at extension processing.
      Parameters:
      value - the numberOfRetries - Determine whether cron job should be repeated and how many times in case of an database connection failure
    • setPriority

      @Accessor(qualifier="priority", type=SETTER) public void setPriority(Integer value)
      Generated method - Setter of Job.priority attribute defined at extension processing.
      Parameters:
      value - the priority - the priority. @since 2.10
    • setRemoveOnExit

      @Accessor(qualifier="removeOnExit", type=SETTER) public void setRemoveOnExit(Boolean value)
      Generated method - Setter of Job.removeOnExit attribute defined at extension processing.
      Parameters:
      value - the removeOnExit
    • setRequestAbort

      @Accessor(qualifier="requestAbort", type=SETTER) public void setRequestAbort(Boolean value)
      Generated method - Setter of Job.requestAbort attribute defined at extension processing.
      Parameters:
      value - the requestAbort
    • setRequestAbortStep

      @Accessor(qualifier="requestAbortStep", type=SETTER) public void setRequestAbortStep(Boolean value)
      Generated method - Setter of Job.requestAbortStep attribute defined at extension processing.
      Parameters:
      value - the requestAbortStep
    • setRestrictions

      @Accessor(qualifier="restrictions", type=SETTER) public void setRestrictions(List<JobSearchRestrictionModel> value)
      Generated method - Setter of Job.restrictions attribute defined at extension processing.
      Parameters:
      value - the restrictions - processed steps
    • setRetry

      @Accessor(qualifier="retry", type=SETTER) public void setRetry(Boolean value)
      Generated method - Setter of Job.retry attribute defined at extension processing.
      Parameters:
      value - the retry
    • setSendEmail

      @Accessor(qualifier="sendEmail", type=SETTER) public void setSendEmail(Boolean value)
      Generated method - Setter of Job.sendEmail attribute defined at extension processing.
      Parameters:
      value - the sendEmail
    • setSessionCurrency

      @Accessor(qualifier="sessionCurrency", type=SETTER) public void setSessionCurrency(CurrencyModel value)
      Generated method - Setter of Job.sessionCurrency attribute defined at extension processing.
      Parameters:
      value - the sessionCurrency
    • setSessionLanguage

      @Accessor(qualifier="sessionLanguage", type=SETTER) public void setSessionLanguage(LanguageModel value)
      Generated method - Setter of Job.sessionLanguage attribute defined at extension processing.
      Parameters:
      value - the sessionLanguage
    • setSessionUser

      @Accessor(qualifier="sessionUser", type=SETTER) public void setSessionUser(UserModel value)
      Generated method - Setter of Job.sessionUser attribute defined at extension processing.
      Parameters:
      value - the sessionUser
    • setSingleExecutable

      @Accessor(qualifier="singleExecutable", type=SETTER) public void setSingleExecutable(Boolean value)
      Generated method - Setter of Job.singleExecutable attribute defined at extension processing.
      Parameters:
      value - the singleExecutable
    • setTriggers

      @Accessor(qualifier="triggers", type=SETTER) public void setTriggers(List<TriggerModel> value)
      Generated method - Setter of Job.triggers attribute defined at extension processing.
      Parameters:
      value - the triggers - list of triggers
    • setUseReadOnlyDatasource

      @Accessor(qualifier="useReadOnlyDatasource", type=SETTER) public void setUseReadOnlyDatasource(Boolean value)
      Generated method - Setter of Job.useReadOnlyDatasource attribute defined at extension processing.
      Parameters:
      value - the useReadOnlyDatasource