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

ERP/3.0/Developers Guide/Reference/Entity Model/C External System

This article is protected against manual editing because it is automatically generated from Openbravo meta-data. Learn more about writing and translating such documents.
Back button.png   Back to ERP/3.0/Developers_Guide/Reference/Entity_Model#C_External_System


C_External_System

Defines the configuration for communicating with an external system

To the database table (C_External_System) of this entity.

Properties

Note:

Property Column Constraints Type Description
id* C_External_System_ID Mandatory
Max Length: 32
java.lang.String Keeps the configuration data that is required to communicate with an external system
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.
description Description Max Length: 255
java.lang.String A description is limited to 255 characters.
connectivityProcess Connectivity_Process java.lang.Boolean A process that checks the connectivity with an external system. It is used to validate the configuration data of an external system.
name# Name Mandatory
Max Length: 60
java.lang.String A more descriptive identifier (that does need to be unique) of a record/document that is used as a default search option along with the search key (that is unique and mostly shorter). It is up to 60 characters in length.
protocol AD_Protocol_ID Mandatory
ADProtocol References a communication protocol
externalSystemHttpList C_External_System_Http


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 http://www.openbravo.com/legal/license.html
  * 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-2020 Openbravo SLU
  * All Rights Reserved.
  * Contributor(s):  ______________________________________.
  ************************************************************************
 */
 package org.openbravo.service.externalsystem;
 
 import java.util.ArrayList;
 import java.util.Date;
 import java.util.List;
 
 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.ad.access.User;
 import org.openbravo.model.ad.system.Client;
 import org.openbravo.model.ad.utility.Protocol;
 import org.openbravo.model.common.enterprise.Organization;
 /**
  * Entity class for entity C_External_System (stored in table C_External_System).
  * <br>
  * Help: {@literal Defines the configuration for communicating with an external system}
  * <br>
  * NOTE: This class should not be instantiated directly. To instantiate this
  * class the {@link org.openbravo.base.provider.OBProvider} should be used.
  */
 public class ExternalSystemData extends BaseOBObject implements Traceable, ClientEnabled, OrganizationEnabled, ActiveEnabled {
     private static final long serialVersionUID = 1L;
     public static final String TABLE_NAME = "C_External_System";
     public static final String ENTITY_NAME = "C_External_System";
 
     /**
      * Property id stored in column C_External_System_ID in table C_External_System<br>
      * Help: {@literal Keeps the configuration data that is required to communicate with an external system}
      * 
      */
     public static final String PROPERTY_ID = "id";
 
     /**
      * Property client stored in column AD_Client_ID in table C_External_System 
      * @see ClientEnabled 
      * 
      */
     public static final String PROPERTY_CLIENT = "client";
 
     /**
      * Property organization stored in column AD_Org_ID in table C_External_System 
      * @see OrganizationEnabled 
      * 
      */
     public static final String PROPERTY_ORGANIZATION = "organization";
 
     /**
      * Property active stored in column Isactive in table C_External_System 
      * @see ActiveEnabled 
      * 
      */
     public static final String PROPERTY_ACTIVE = "active";
 
     /**
      * Property creationDate stored in column Created in table C_External_System 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATIONDATE = "creationDate";
 
     /**
      * Property createdBy stored in column Createdby in table C_External_System 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_CREATEDBY = "createdBy";
 
     /**
      * Property updated stored in column Updated in table C_External_System 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATED = "updated";
 
     /**
      * Property updatedBy stored in column Updatedby in table C_External_System 
      * @see Traceable 
      * 
      */
     public static final String PROPERTY_UPDATEDBY = "updatedBy";
 
     /**
      * Property description stored in column Description in table C_External_System<br>
      * Help: {@literal A description is limited to 255 characters.}
      * 
      */
     public static final String PROPERTY_DESCRIPTION = "description";
 
     /**
      * Property connectivityProcess stored in column Connectivity_Process in table C_External_System<br>
      * Help: {@literal A process that checks the connectivity with an external system. It is used to validate the
      *       configuration data of an external system.}
      * 
      */
     public static final String PROPERTY_CONNECTIVITYPROCESS = "connectivityProcess";
 
     /**
      * Property name stored in column Name in table C_External_System 
      * 
      */
     public static final String PROPERTY_NAME = "name";
 
     /**
      * Property protocol stored in column AD_Protocol_ID in table C_External_System<br>
      * Help: {@literal References a communication protocol}
      * 
      */
     public static final String PROPERTY_PROTOCOL = "protocol";
 
     /**
      * Property externalSystemHttpList stored in table C_External_System
      * 
      */
     public static final String PROPERTY_EXTERNALSYSTEMHTTPLIST = "externalSystemHttpList";
 
 
     public ExternalSystemData() {
         setDefaultValue(PROPERTY_ACTIVE, true);
         setDefaultValue(PROPERTY_CONNECTIVITYPROCESS, false);
         setDefaultValue(PROPERTY_EXTERNALSYSTEMHTTPLIST, new ArrayList<Object>());
     }
 
     @Override
     public String getEntityName() {
         return ENTITY_NAME;
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_ID
      * 
      */
     public String getId() {
         return (String) get(PROPERTY_ID);
     }
     /**
      * @see ExternalSystemData#PROPERTY_ID
      * 
      */
     public void setId(String id) {
         set(PROPERTY_ID, id);
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_CLIENT
      * 
      */
     public Client getClient() {
         return (Client) get(PROPERTY_CLIENT);
     }
     /**
      * @see ExternalSystemData#PROPERTY_CLIENT
      * 
      */
     public void setClient(Client client) {
         set(PROPERTY_CLIENT, client);
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_ORGANIZATION
      * 
      */
     public Organization getOrganization() {
         return (Organization) get(PROPERTY_ORGANIZATION);
     }
     /**
      * @see ExternalSystemData#PROPERTY_ORGANIZATION
      * 
      */
     public void setOrganization(Organization organization) {
         set(PROPERTY_ORGANIZATION, organization);
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_ACTIVE
      * 
      */
     public Boolean isActive() {
         return (Boolean) get(PROPERTY_ACTIVE);
     }
     /**
      * @see ExternalSystemData#PROPERTY_ACTIVE
      * 
      */
     public void setActive(Boolean active) {
         set(PROPERTY_ACTIVE, active);
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_CREATIONDATE
      * 
      */
     public Date getCreationDate() {
         return (Date) get(PROPERTY_CREATIONDATE);
     }
     /**
      * @see ExternalSystemData#PROPERTY_CREATIONDATE
      * 
      */
     public void setCreationDate(Date creationDate) {
         set(PROPERTY_CREATIONDATE, creationDate);
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_CREATEDBY
      * 
      */
     public User getCreatedBy() {
         return (User) get(PROPERTY_CREATEDBY);
     }
     /**
      * @see ExternalSystemData#PROPERTY_CREATEDBY
      * 
      */
     public void setCreatedBy(User createdBy) {
         set(PROPERTY_CREATEDBY, createdBy);
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_UPDATED
      * 
      */
     public Date getUpdated() {
         return (Date) get(PROPERTY_UPDATED);
     }
     /**
      * @see ExternalSystemData#PROPERTY_UPDATED
      * 
      */
     public void setUpdated(Date updated) {
         set(PROPERTY_UPDATED, updated);
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_UPDATEDBY
      * 
      */
     public User getUpdatedBy() {
         return (User) get(PROPERTY_UPDATEDBY);
     }
     /**
      * @see ExternalSystemData#PROPERTY_UPDATEDBY
      * 
      */
     public void setUpdatedBy(User updatedBy) {
         set(PROPERTY_UPDATEDBY, updatedBy);
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_DESCRIPTION
      * 
      */
     public String getDescription() {
         return (String) get(PROPERTY_DESCRIPTION);
     }
     /**
      * @see ExternalSystemData#PROPERTY_DESCRIPTION
      * 
      */
     public void setDescription(String description) {
         set(PROPERTY_DESCRIPTION, description);
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_CONNECTIVITYPROCESS
      * 
      */
     public Boolean isConnectivityProcess() {
         return (Boolean) get(PROPERTY_CONNECTIVITYPROCESS);
     }
     /**
      * @see ExternalSystemData#PROPERTY_CONNECTIVITYPROCESS
      * 
      */
     public void setConnectivityProcess(Boolean connectivityProcess) {
         set(PROPERTY_CONNECTIVITYPROCESS, connectivityProcess);
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_NAME
      * 
      */
     public String getName() {
         return (String) get(PROPERTY_NAME);
     }
     /**
      * @see ExternalSystemData#PROPERTY_NAME
      * 
      */
     public void setName(String name) {
         set(PROPERTY_NAME, name);
     }
 
     /**
      * @see ExternalSystemData#PROPERTY_PROTOCOL
      * 
      */
     public Protocol getProtocol() {
         return (Protocol) get(PROPERTY_PROTOCOL);
     }
     /**
      * @see ExternalSystemData#PROPERTY_PROTOCOL
      * 
      */
     public void setProtocol(Protocol protocol) {
         set(PROPERTY_PROTOCOL, protocol);
     }
 
     /**
      * Help: {@literal Allows to define the configuration of a HTTP or HTTPS connection with an external system}<br>
      * @see HttpExternalSystemData
      * 
      */
     @SuppressWarnings("unchecked")
     public List<HttpExternalSystemData> getExternalSystemHttpList() {
       return (List<HttpExternalSystemData>) get(PROPERTY_EXTERNALSYSTEMHTTPLIST);
     }
 
     /**
      * Help: {@literal Allows to define the configuration of a HTTP or HTTPS connection with an external system}<br>
      * @see HttpExternalSystemData
      * 
      */
     public void setExternalSystemHttpList(List<HttpExternalSystemData> externalSystemHttpList) {
         set(PROPERTY_EXTERNALSYSTEMHTTPLIST, externalSystemHttpList);
     }
 
 }

Retrieved from "http://wiki.openbravo.com/wiki/ERP/3.0/Developers_Guide/Reference/Entity_Model/C_External_System"

This page has been accessed 260 times. This page was last modified on 22 August 2023, at 09:29. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.