LedgerSMB::DBObject::Employee






LedgerSMB::DBObject::Employee − LedgerSMB class for managing
Employees

This module creates object instances based on LedgerSMB’s
in‐database ORM.

The following method is static:

new ($LedgerSMB object);

save
    Saves an employee.  Inputs required

    entity_id
        May not be undef

    start_date

    end_date

    dob date
        may not be undef

    role
        Not the database role.  Either manager or user

    ssn

    sales

    manager_id

    employee_number

search
    Returns a list of employees matching set criteria:

    employeenumber (exact match)

    startdate_from (start of date range)

    startdate_to (end of date range)

    first_name (partial match)

    middle_name (partial match)

    last_name (partial match)

    notes (partial match)

        Undef values match all values.











                             ‐2‐


set_entity_class
    Sets the entity class to 3.

get_managers
    Retrieves a set of managers and attaches to
    $self−>{all_managers}

save_location
    Saves the location data for the contact.

    Inputs are standard location inputs (line_one, line_two,
    etc)

save_contact
    Saves contact information.  Inputs are standard contact
    inputs:

    entity_id

    contact_class

    contact

    description

    save_bank_account
        Saves a bank account to an employee.

        Standard inputs (entity_id, iban, bic)

    get_metadata()
        This retrieves various information vor building the
        user interface.  Among other things, it sets the
        following properties: $self−>{ar_ap_acc_list} =
        qw(list of ar or ap accounts) $self−>{cash_acc_list}
        = qw(list of cash accounts)

    get Returns the employee record with all the inputs
        required for "save" populated.

        Also populates:

        locations
            List of location info

        contacts
            List of contact info

        notes
            List of notes

        bank account
            List of bank accounts










                             ‐3‐


    save_notes
        Saves a note to an employee entity.

        Standard inputs (note, subject, entity_id)

    delete_contact
        required request variables:

        contact_class_id:  int id of contact class contact:
        text of contact information person_id: int of
        entity_credit_account.id, preferred value

    delete_location
        Deletes a record from the location side.

        Required request variables:

        location_id location_class_id person_id

        Returns true if a record was deleted.  False
        otherwise.

    delete_bank_account
        Deletes a bank account

        Requires:

        entity_id bank_account_id

        Returns true if a record was deleted, false
        otherwise.

get_user_info
    Attaches the user_id and username to the employee
    object.

    If the user does not have manage_users powers, this will
    simply return false

This file is licensed under the Gnu General Public License
version 2, or at your option any later version.  A copy of
the license should have been included with your software.