View source | Discuss this page | Page history | Printable version   

ERP/2.50/Developers Guide/Reference/Entity Model/ProcessRequest


Create a new Process Request to be executed immediately, at a later date or on a recurring basis.

To the database table (AD_Process_Request) of this entity.

Back to the entity model.



Property Column Constraints Type Description
id* AD_Process_Request_ID Mandatory
Max Length: 32
java.lang.String Request to run a Process, either directly or scheduled for a later date.
client AD_Client_ID Mandatory ADClient A Client is a company or a legal entity. You cannot share data between Clients.
organization AD_Org_ID Mandatory Organization An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations.
active Isactive Mandatory java.lang.Boolean There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reporting. There are two reasons for de-activating and not deleting records:

(1) The system requires the record for auditing purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are existing invoices for it. By de-activating the Business Partner you prevent it from being used in future transactions.

creationDate Created Mandatory java.util.Date The Created field indicates the date that this record was created.
createdBy Createdby Mandatory ADUser The Created By field indicates the user who created this record.
updated Updated Mandatory java.util.Date The Updated field indicates the date that this record was updated.
updatedBy Updatedby Mandatory ADUser The Updated By field indicates the user who updated this record.
process# AD_Process_ID Mandatory ADProcess The Process field identifies a unique Process or Report in the system.
description Description Max Length: 255 java.lang.String A description is limited to 255 characters.
userContact AD_User_ID ADUser The User identifies a unique user in the system. This could be an internal user or a business partner contact
securityBasedOnRole Isrolesecurity java.lang.Boolean A flag indicating whether access to an item should be based on a user's role within the system.
openbravoContext OB_Context Max Length: 4000 java.lang.String The context in which a Process Request was scheduled or executed. The context contains information such as user, client, organization, language, date format etc.
status Status Max Length: 60 java.lang.String Current status of a debt/payment.
nextExecution Next_Fire_Time java.util.Date The next time a process will execute.
previousExecution Previous_Fire_Time java.util.Date The last time this Process Request was executed.
finish Scheduled_Finish java.util.Date The date and time a Process Request is due to finish (repeating).
channel# Channel Max Length: 20 java.lang.String The method by which this Process request was executed/scheduled (Direct, Scheduled, Webservice)
timing Timing_Option Max Length: 60 java.lang.String When to run a Process Request - either immediately, at a later date or on a recurring basis.
startTime Start_Time java.sql.Timestamp The time at which an item is due to, or did, start.
startDate Start_Date java.util.Date The date on which an item is due to start.
frequency Frequency Max Length: 60 java.lang.String The frequency is used in conjunction with the frequency type in determining an event. Example: If the Frequency Type is Week and the Frequency is 2 - it is every two weeks.
intervalInSeconds Secondly_Interval java.lang.Long Interval in hours between an event (such as a process execution).
intervalInMinutes Minutely_Interval java.lang.Long Interval in minutes between an event (such as a process execution).
hourlyInterval Hourly_Interval java.lang.Long Interval in hours between an event (such as a process execution).
dailyInterval Daily_Interval java.lang.Long The daily interval between executions of a process.
repetitions Secondly_Repetitions java.lang.Long The number of times this element will repeat.
numRepetitions Minutely_Repetitions java.lang.Long The number of times this element will repeat.
numberOfRepetitions Hourly_Repetitions java.lang.Long The number of times this element will repeat.
monday DAY_Mon java.lang.Boolean The day of the week Monday.
tuesday DAY_Tue java.lang.Boolean The day of the week Tuesday.
wednesday DAY_Wed java.lang.Boolean The day of the week Wednesday.
thursday DAY_Thu java.lang.Boolean The day of the week Thursday.
friday DAY_Fri java.lang.Boolean The day of the week Friday.
saturday DAY_Sat java.lang.Boolean The day of the week Saturday.
sunday DAY_Sun java.lang.Boolean The day of the week Sunday.
monthlyOption Monthly_Option Max Length: 60 java.lang.String An option by which to schedule a Process in a monthly manner. The option can be a specific date within each month, the last day of each month, or the Nth selected day within each month, such as the first Wednesday of each month.
dayInMonth Monthly_Specific_Day java.lang.Long The specific date within each month. For example, specifying 15 will signify the 15th of each month.
dayOfTheWeek Monthly_Day_Of_Week Max Length: 60 java.lang.String A day within a week.
finishes Finishes java.lang.Boolean Specifiy that this item should finish.
finishTime Finishes_Time java.sql.Timestamp The time that this item will finish.
finishDate Finishes_Date java.util.Date The date that this item will finish.
dailyOption Daily_Option Max Length: 60 java.lang.String Option to run a Process Request on a daily basis.
cronExpression Cron Max Length: 60 java.lang.String A Quartz cron expression to schedule this Process Request. More information on Quartz cron expression can be found at and
processSet AD_Process_Set_ID Max Length: 32 java.lang.String Unique identifier for a Process Set (a collection of Process Requests).
scheduleProcess Schedule java.lang.Boolean Schedule a Process to be executed, either immediately, at a later date or on a recurring basis.
rescheduleProcess Reschedule java.lang.Boolean Reschedule a previoulsy (or currently) scheduled Process Request.
unscheduleProcess Unschedule java.lang.Boolean Unschedule the Process.
params Params Max Length: 4000 java.lang.String
processExecutionList List of ProcessExecution

Java Entity Class

 * The contents of this file are subject to the Openbravo  Public  License
 * Version  1.1  (the  "License"),  being   the  Mozilla   Public  License
 * Version 1.1  with a permitted attribution clause; you may not  use this
 * file except in compliance with the License. You  may  obtain  a copy of
 * the License at
 * Software distributed under the License  is  distributed  on  an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
 * License for the specific  language  governing  rights  and  limitations
 * under the License.
 * The Original Code is Openbravo ERP.
 * The Initial Developer of the Original Code is Openbravo SLU
 * All portions are Copyright (C) 2008-2010 Openbravo SLU
 * All Rights Reserved.
 * Contributor(s):  ______________________________________.
import org.openbravo.base.structure.ActiveEnabled;
import org.openbravo.base.structure.BaseOBObject;
import org.openbravo.base.structure.ClientEnabled;
import org.openbravo.base.structure.OrganizationEnabled;
import org.openbravo.base.structure.Traceable;
import org.openbravo.model.common.enterprise.Organization;
import java.lang.Boolean;
import java.lang.Long;
import java.lang.String;
import java.sql.Timestamp;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
 * Entity class for entity ProcessRequest (stored in table AD_Process_Request).
 * NOTE: This class should not be instantiated directly. To instantiate this
 * class the {@link org.openbravo.base.provider.OBProvider} should be used.
public class ProcessRequest extends BaseOBObject implements Traceable,
    ClientEnabled, OrganizationEnabled, ActiveEnabled {
    private static final long serialVersionUID = 1L;
    public static final String TABLE_NAME = "AD_Process_Request";
    public static final String ProcessRequest = "ProcessRequest";
    public static final String PROPERTY_ID = "id";
    public static final String PROPERTY_CLIENT = "client";
    public static final String PROPERTY_ORGANIZATION = "organization";
    public static final String PROPERTY_ACTIVE = "active";
    public static final String PROPERTY_CREATIONDATE = "creationDate";
    public static final String PROPERTY_CREATEDBY = "createdBy";
    public static final String PROPERTY_UPDATED = "updated";
    public static final String PROPERTY_UPDATEDBY = "updatedBy";
    public static final String PROPERTY_PROCESS = "process";
    public static final String PROPERTY_DESCRIPTION = "description";
    public static final String PROPERTY_USERCONTACT = "userContact";
    public static final String PROPERTY_SECURITYBASEDONROLE =
    public static final String PROPERTY_OPENBRAVOCONTEXT = "openbravoContext";
    public static final String PROPERTY_STATUS = "status";
    public static final String PROPERTY_NEXTEXECUTION = "nextExecution";
    public static final String PROPERTY_PREVIOUSEXECUTION = "previousExecution";
    public static final String PROPERTY_FINISH = "finish";
    public static final String PROPERTY_CHANNEL = "channel";
    public static final String PROPERTY_TIMING = "timing";
    public static final String PROPERTY_STARTTIME = "startTime";
    public static final String PROPERTY_STARTDATE = "startDate";
    public static final String PROPERTY_FREQUENCY = "frequency";
    public static final String PROPERTY_INTERVALINSECONDS = "intervalInSeconds";
    public static final String PROPERTY_INTERVALINMINUTES = "intervalInMinutes";
    public static final String PROPERTY_HOURLYINTERVAL = "hourlyInterval";
    public static final String PROPERTY_DAILYINTERVAL = "dailyInterval";
    public static final String PROPERTY_REPETITIONS = "repetitions";
    public static final String PROPERTY_NUMREPETITIONS = "numRepetitions";
    public static final String PROPERTY_NUMBEROFREPETITIONS =
    public static final String PROPERTY_MONDAY = "monday";
    public static final String PROPERTY_TUESDAY = "tuesday";
    public static final String PROPERTY_WEDNESDAY = "wednesday";
    public static final String PROPERTY_THURSDAY = "thursday";
    public static final String PROPERTY_FRIDAY = "friday";
    public static final String PROPERTY_SATURDAY = "saturday";
    public static final String PROPERTY_SUNDAY = "sunday";
    public static final String PROPERTY_MONTHLYOPTION = "monthlyOption";
    public static final String PROPERTY_DAYINMONTH = "dayInMonth";
    public static final String PROPERTY_DAYOFTHEWEEK = "dayOfTheWeek";
    public static final String PROPERTY_FINISHES = "finishes";
    public static final String PROPERTY_FINISHTIME = "finishTime";
    public static final String PROPERTY_FINISHDATE = "finishDate";
    public static final String PROPERTY_DAILYOPTION = "dailyOption";
    public static final String PROPERTY_CRONEXPRESSION = "cronExpression";
    public static final String PROPERTY_PROCESSSET = "processSet";
    public static final String PROPERTY_SCHEDULEPROCESS = "scheduleProcess";
    public static final String PROPERTY_RESCHEDULEPROCESS = "rescheduleProcess";
    public static final String PROPERTY_UNSCHEDULEPROCESS = "unscheduleProcess";
    public static final String PROPERTY_PARAMS = "params";
    public static final String PROPERTY_PROCESSEXECUTIONLIST =
    public ProcessRequest() {
        setDefaultValue(PROPERTY_ACTIVE, true);
        setDefaultValue(PROPERTY_CREATIONDATE, new Date());
        setDefaultValue(PROPERTY_UPDATED, new Date());
        setDefaultValue(PROPERTY_SECURITYBASEDONROLE, true);
        setDefaultValue(PROPERTY_CHANNEL, "Process Scheduler");
        setDefaultValue(PROPERTY_TIMING, "I");
        setDefaultValue(PROPERTY_FREQUENCY, "4");
        setDefaultValue(PROPERTY_DAILYINTERVAL, (long) 1);
        setDefaultValue(PROPERTY_MONDAY, false);
        setDefaultValue(PROPERTY_TUESDAY, false);
        setDefaultValue(PROPERTY_WEDNESDAY, false);
        setDefaultValue(PROPERTY_THURSDAY, false);
        setDefaultValue(PROPERTY_FRIDAY, false);
        setDefaultValue(PROPERTY_SATURDAY, false);
        setDefaultValue(PROPERTY_SUNDAY, false);
        setDefaultValue(PROPERTY_MONTHLYOPTION, "S");
        setDefaultValue(PROPERTY_FINISHES, false);
        setDefaultValue(PROPERTY_DAILYOPTION, "N");
        setDefaultValue(PROPERTY_SCHEDULEPROCESS, false);
        setDefaultValue(PROPERTY_RESCHEDULEPROCESS, false);
        setDefaultValue(PROPERTY_UNSCHEDULEPROCESS, false);
        setDefaultValue(PROPERTY_PROCESSEXECUTIONLIST, new ArrayList<Object>());
    public String getEntityName() {
        return ProcessRequest;
    public String getId() {
        return (String) get(PROPERTY_ID);
    public void setId(String id) {
        set(PROPERTY_ID, id);
    public Client getClient() {
        return (Client) get(PROPERTY_CLIENT);
    public void setClient(Client client) {
        set(PROPERTY_CLIENT, client);
    public Organization getOrganization() {
        return (Organization) get(PROPERTY_ORGANIZATION);
    public void setOrganization(Organization organization) {
        set(PROPERTY_ORGANIZATION, organization);
    public Boolean isActive() {
        return (Boolean) get(PROPERTY_ACTIVE);
    public void setActive(Boolean active) {
        set(PROPERTY_ACTIVE, active);
    public Date getCreationDate() {
        return (Date) get(PROPERTY_CREATIONDATE);
    public void setCreationDate(Date creationDate) {
        set(PROPERTY_CREATIONDATE, creationDate);
    public User getCreatedBy() {
        return (User) get(PROPERTY_CREATEDBY);
    public void setCreatedBy(User createdBy) {
        set(PROPERTY_CREATEDBY, createdBy);
    public Date getUpdated() {
        return (Date) get(PROPERTY_UPDATED);
    public void setUpdated(Date updated) {
        set(PROPERTY_UPDATED, updated);
    public User getUpdatedBy() {
        return (User) get(PROPERTY_UPDATEDBY);
    public void setUpdatedBy(User updatedBy) {
        set(PROPERTY_UPDATEDBY, updatedBy);
    public Process getProcess() {
        return (Process) get(PROPERTY_PROCESS);
    public void setProcess(Process process) {
        set(PROPERTY_PROCESS, process);
    public String getDescription() {
        return (String) get(PROPERTY_DESCRIPTION);
    public void setDescription(String description) {
        set(PROPERTY_DESCRIPTION, description);
    public User getUserContact() {
        return (User) get(PROPERTY_USERCONTACT);
    public void setUserContact(User userContact) {
        set(PROPERTY_USERCONTACT, userContact);
    public Boolean isSecurityBasedOnRole() {
        return (Boolean) get(PROPERTY_SECURITYBASEDONROLE);
    public void setSecurityBasedOnRole(Boolean securityBasedOnRole) {
        set(PROPERTY_SECURITYBASEDONROLE, securityBasedOnRole);
    public String getOpenbravoContext() {
        return (String) get(PROPERTY_OPENBRAVOCONTEXT);
    public void setOpenbravoContext(String openbravoContext) {
        set(PROPERTY_OPENBRAVOCONTEXT, openbravoContext);
    public String getStatus() {
        return (String) get(PROPERTY_STATUS);
    public void setStatus(String status) {
        set(PROPERTY_STATUS, status);
    public Date getNextExecution() {
        return (Date) get(PROPERTY_NEXTEXECUTION);
    public void setNextExecution(Date nextExecution) {
        set(PROPERTY_NEXTEXECUTION, nextExecution);
    public Date getPreviousExecution() {
        return (Date) get(PROPERTY_PREVIOUSEXECUTION);
    public void setPreviousExecution(Date previousExecution) {
        set(PROPERTY_PREVIOUSEXECUTION, previousExecution);
    public Date getFinish() {
        return (Date) get(PROPERTY_FINISH);
    public void setFinish(Date finish) {
        set(PROPERTY_FINISH, finish);
    public String getChannel() {
        return (String) get(PROPERTY_CHANNEL);
    public void setChannel(String channel) {
        set(PROPERTY_CHANNEL, channel);
    public String getTiming() {
        return (String) get(PROPERTY_TIMING);
    public void setTiming(String timing) {
        set(PROPERTY_TIMING, timing);
    public Timestamp getStartTime() {
        return (Timestamp) get(PROPERTY_STARTTIME);
    public void setStartTime(Timestamp startTime) {
        set(PROPERTY_STARTTIME, startTime);
    public Date getStartDate() {
        return (Date) get(PROPERTY_STARTDATE);
    public void setStartDate(Date startDate) {
        set(PROPERTY_STARTDATE, startDate);
    public String getFrequency() {
        return (String) get(PROPERTY_FREQUENCY);
    public void setFrequency(String frequency) {
        set(PROPERTY_FREQUENCY, frequency);
    public Long getIntervalInSeconds() {
        return (Long) get(PROPERTY_INTERVALINSECONDS);
    public void setIntervalInSeconds(Long intervalInSeconds) {
        set(PROPERTY_INTERVALINSECONDS, intervalInSeconds);
    public Long getIntervalInMinutes() {
        return (Long) get(PROPERTY_INTERVALINMINUTES);
    public void setIntervalInMinutes(Long intervalInMinutes) {
        set(PROPERTY_INTERVALINMINUTES, intervalInMinutes);
    public Long getHourlyInterval() {
        return (Long) get(PROPERTY_HOURLYINTERVAL);
    public void setHourlyInterval(Long hourlyInterval) {
        set(PROPERTY_HOURLYINTERVAL, hourlyInterval);
    public Long getDailyInterval() {
        return (Long) get(PROPERTY_DAILYINTERVAL);
    public void setDailyInterval(Long dailyInterval) {
        set(PROPERTY_DAILYINTERVAL, dailyInterval);
    public Long getRepetitions() {
        return (Long) get(PROPERTY_REPETITIONS);
    public void setRepetitions(Long repetitions) {
        set(PROPERTY_REPETITIONS, repetitions);
    public Long getNumRepetitions() {
        return (Long) get(PROPERTY_NUMREPETITIONS);
    public void setNumRepetitions(Long numRepetitions) {
        set(PROPERTY_NUMREPETITIONS, numRepetitions);
    public Long getNumberOfRepetitions() {
        return (Long) get(PROPERTY_NUMBEROFREPETITIONS);
    public void setNumberOfRepetitions(Long numberOfRepetitions) {
        set(PROPERTY_NUMBEROFREPETITIONS, numberOfRepetitions);
    public Boolean isMonday() {
        return (Boolean) get(PROPERTY_MONDAY);
    public void setMonday(Boolean monday) {
        set(PROPERTY_MONDAY, monday);
    public Boolean isTuesday() {
        return (Boolean) get(PROPERTY_TUESDAY);
    public void setTuesday(Boolean tuesday) {
        set(PROPERTY_TUESDAY, tuesday);
    public Boolean isWednesday() {
        return (Boolean) get(PROPERTY_WEDNESDAY);
    public void setWednesday(Boolean wednesday) {
        set(PROPERTY_WEDNESDAY, wednesday);
    public Boolean isThursday() {
        return (Boolean) get(PROPERTY_THURSDAY);
    public void setThursday(Boolean thursday) {
        set(PROPERTY_THURSDAY, thursday);
    public Boolean isFriday() {
        return (Boolean) get(PROPERTY_FRIDAY);
    public void setFriday(Boolean friday) {
        set(PROPERTY_FRIDAY, friday);
    public Boolean isSaturday() {
        return (Boolean) get(PROPERTY_SATURDAY);
    public void setSaturday(Boolean saturday) {
        set(PROPERTY_SATURDAY, saturday);
    public Boolean isSunday() {
        return (Boolean) get(PROPERTY_SUNDAY);
    public void setSunday(Boolean sunday) {
        set(PROPERTY_SUNDAY, sunday);
    public String getMonthlyOption() {
        return (String) get(PROPERTY_MONTHLYOPTION);
    public void setMonthlyOption(String monthlyOption) {
        set(PROPERTY_MONTHLYOPTION, monthlyOption);
    public Long getDayInMonth() {
        return (Long) get(PROPERTY_DAYINMONTH);
    public void setDayInMonth(Long dayInMonth) {
        set(PROPERTY_DAYINMONTH, dayInMonth);
    public String getDayOfTheWeek() {
        return (String) get(PROPERTY_DAYOFTHEWEEK);
    public void setDayOfTheWeek(String dayOfTheWeek) {
        set(PROPERTY_DAYOFTHEWEEK, dayOfTheWeek);
    public Boolean isFinishes() {
        return (Boolean) get(PROPERTY_FINISHES);
    public void setFinishes(Boolean finishes) {
        set(PROPERTY_FINISHES, finishes);
    public Timestamp getFinishTime() {
        return (Timestamp) get(PROPERTY_FINISHTIME);
    public void setFinishTime(Timestamp finishTime) {
        set(PROPERTY_FINISHTIME, finishTime);
    public Date getFinishDate() {
        return (Date) get(PROPERTY_FINISHDATE);
    public void setFinishDate(Date finishDate) {
        set(PROPERTY_FINISHDATE, finishDate);
    public String getDailyOption() {
        return (String) get(PROPERTY_DAILYOPTION);
    public void setDailyOption(String dailyOption) {
        set(PROPERTY_DAILYOPTION, dailyOption);
    public String getCronExpression() {
        return (String) get(PROPERTY_CRONEXPRESSION);
    public void setCronExpression(String cronExpression) {
        set(PROPERTY_CRONEXPRESSION, cronExpression);
    public String getProcessSet() {
        return (String) get(PROPERTY_PROCESSSET);
    public void setProcessSet(String processSet) {
        set(PROPERTY_PROCESSSET, processSet);
    public Boolean isScheduleProcess() {
        return (Boolean) get(PROPERTY_SCHEDULEPROCESS);
    public void setScheduleProcess(Boolean scheduleProcess) {
        set(PROPERTY_SCHEDULEPROCESS, scheduleProcess);
    public Boolean isRescheduleProcess() {
        return (Boolean) get(PROPERTY_RESCHEDULEPROCESS);
    public void setRescheduleProcess(Boolean rescheduleProcess) {
        set(PROPERTY_RESCHEDULEPROCESS, rescheduleProcess);
    public Boolean isUnscheduleProcess() {
        return (Boolean) get(PROPERTY_UNSCHEDULEPROCESS);
    public void setUnscheduleProcess(Boolean unscheduleProcess) {
        set(PROPERTY_UNSCHEDULEPROCESS, unscheduleProcess);
    public String getParams() {
        return (String) get(PROPERTY_PARAMS);
    public void setParams(String params) {
        set(PROPERTY_PARAMS, params);
    public List<ProcessExecution> getProcessExecutionList() {
        return (List<ProcessExecution>) get(PROPERTY_PROCESSEXECUTIONLIST);
    public void setProcessExecutionList(
        List<ProcessExecution> processExecutionList) {
        set(PROPERTY_PROCESSEXECUTIONLIST, processExecutionList);

Retrieved from ""

This page has been accessed 2,085 times. This page was last modified on 2 July 2011, at 21:14. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.