View source | View content page | Page history | Printable version   
Toolbox
Main Page
Upload file
What links here
Recent changes
Help

PDF Books
Show collection (0 pages)
Collections help

Search

Projects:JavaDoc Improvements/Specs

Contents

Goal

This project objective is improving JavaDoc for generated entities and properties.

Functional Requirements

This project will not add new functional features.

Technical Specs

Project Tasks

This project tasks have been split in several issues.

Decisions Taken

Several technical decisions have been made in regards to this project.

Help over property:

    ...
    /**
    * {@literal An alert that has been raised.}
    */
    public static final String PROPERTY_ID = "id";
    /**
    * {@literal A Client is a company or a legal entity. You cannot share data between Clients.}
    */
    public static final String PROPERTY_CLIENT = "client";
    /**
    * {@literal An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations.}
    */
    public static final String PROPERTY_ORGANIZATION = "organization";
    /**
    * {@literal 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.}
    */
    public static final String PROPERTY_ACTIVE = "active";
 
...
 
    /**
     * Getter for property id 
     * (stored in column AD_Alert_ID in table AD_Alert)
     */
    public String getId() {
        return (String) get(PROPERTY_ID);
    }
	
    /**
     * Setter for property id 
     * (stored in column AD_Alert_ID in table AD_Alert)
     */
    public void setId(String id) {
        set(PROPERTY_ID, id);
    }
 
    /**
     * Getter for property client 
     * (stored in column AD_Client_ID in table AD_Alert)
     */
    public Client getClient() {
        return (Client) get(PROPERTY_CLIENT);
    }

Retrieved from "http://wiki.openbravo.com/wiki/Projects:JavaDoc_Improvements/Specs"

This page has been accessed 159 times. This page was last modified on 26 August 2019, at 12:27. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.