### Navigation

- index
- modules |
- next |
- previous |
- Camelot v0.1 documentation »
- Camelot Documentation contents »
- Camelot Documentation »

# Build in data models

Release: | 0.1
Date: | June 12, 2010

Camelot comes with a number of build in data models. To avoid boiler plate models needed in almost any application (like Persons, Addresses, etc.), the developer is encouraged to use these data models as a start for developing custom applications.

## Persons and Organizations

class `camelot.model.authentication.``Address`(**kwargs)
  `city`
    Public-facing descriptor, placed in the mapped class dictionary.
  `city_geographicboundary_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `name`
    Public-facing descriptor, placed in the mapped class dictionary.
  `street1`
    Public-facing descriptor, placed in the mapped class dictionary.
  `street2`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized`
    A combination of InsturmentedAttribute and a regular descriptor.
  `synchronized_assoc_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized_rel`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.authentication.``AddressAdmin`(app_admin, entity)
  Admin with only the Address information and not the Party information

class `camelot.model.authentication.``ContactMechanism`(**kwargs)
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `mechanism`
    Public-facing descriptor, placed in the mapped class dictionary.
  `party_address`
    Public-facing descriptor, placed in the mapped class dictionary.
  `party_address_id`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.authentication.``DirectedDirector`(**kwargs)

  Relation from a directed organization to a director

  `comment`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_from`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_from_party_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_to`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_to_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `from_date`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `partyrelationship_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `represented_by`
    Public-facing descriptor, placed in the mapped class dictionary.
  `row_type`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized`
    A combination of InsturmentedAttribute and a regular descriptor.
  `synchronized_assoc_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized_rel`
    Public-facing descriptor, placed in the mapped class dictionary.
  `thru_date`
    Public-facing descriptor, placed in the mapped class dictionary.
  `title`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.authentication.``EmployerEmployee`(**kwargs)

  Relation from employer to employee

  `comment`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_from`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_from_party_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_to`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_to_party_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `first_name`
    Public-facing descriptor, placed in the mapped class dictionary.
  `from_date`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `last_name`
    Public-facing descriptor, placed in the mapped class dictionary.
  `partyrelationship_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `row_type`
    Public-facing descriptor, placed in the mapped class dictionary.
  `social_security_number`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized`
    A combination of InsturmentedAttribute and a regular descriptor.
  `synchronized_assoc_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized_rel`
    Public-facing descriptor, placed in the mapped class dictionary.
  `thru_date`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.authentication.``Organization`(**kwargs)

  An organization represents any internal or external organization. Organizations can include businesses and groups of individuals

  `addresses`
    Public-facing descriptor, placed in the mapped class dictionary.
  `contact_mechanisms`
    Public-facing descriptor, placed in the mapped class dictionary.
  `customers`
    Public-facing descriptor, placed in the mapped class dictionary.
  `directed_organizations`
    Public-facing descriptor, placed in the mapped class dictionary.
  `directors`
    Public-facing descriptor, placed in the mapped class dictionary.
  `email`
    Public-facing descriptor, placed in the mapped class dictionary.
  `employees`
    Public-facing descriptor, placed in the mapped class dictionary.
  `full_name`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `logo`
    Public-facing descriptor, placed in the mapped class dictionary.
  `name`
    Public-facing descriptor, placed in the mapped class dictionary.
  `party_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `phone`
    Public-facing descriptor, placed in the mapped class dictionary.
  `row_type`
    Public-facing descriptor, placed in the mapped class dictionary.
  `shareholders`
    Public-facing descriptor, placed in the mapped class dictionary.
  `shares`
    Public-facing descriptor, placed in the mapped class dictionary.
  `status`
    Public-facing descriptor, placed in the mapped class dictionary.
  `suppliers`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized`
    A combination of InsturmentedAttribute and a regular descriptor.
  `synchronized_assoc_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized_rel`
    Public-facing descriptor, placed in the mapped class dictionary.
  `tax_id`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.authentication.``Party`(**kwargs)

  Base class for persons and organizations. Use this base class to refer to either persons or organisations in building authentication systems, contact management or CRM

  `addresses`
    Public-facing descriptor, placed in the mapped class dictionary.
  `contact_mechanisms`
    Public-facing descriptor, placed in the mapped class dictionary.
  `directed_organizations`
    Public-facing descriptor, placed in the mapped class dictionary.
  `email`
    Public-facing descriptor, placed in the mapped class dictionary.
  `full_name`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `phone`
    Public-facing descriptor, placed in the mapped class dictionary.
  `row_type`
    Public-facing descriptor, placed in the mapped class dictionary.
  `shares`
    Public-facing descriptor, placed in the mapped class dictionary.
  `status`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized`
    A combination of InsturmentedAttribute and a regular descriptor.
  `synchronized_assoc_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized_rel`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.authentication.``Person`(**kwargs)

  Person represents natural persons

  `addresses`
    Public-facing descriptor, placed in the mapped class dictionary.
  `birthdate`
    Public-facing descriptor, placed in the mapped class dictionary.
  `comment`
    Public-facing descriptor, placed in the mapped class dictionary.
  `contact_mechanisms`
    Public-facing descriptor, placed in the mapped class dictionary.
  `directed_organizations`
    Public-facing descriptor, placed in the mapped class dictionary.
  `email`
    Public-facing descriptor, placed in the mapped class dictionary.
  `employers`
    Public-facing descriptor, placed in the mapped class dictionary.
  `first_name`
    Public-facing descriptor, placed in the mapped class dictionary.
  `full_name`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `is_staff`
    Public-facing descriptor, placed in the mapped class dictionary.
  `is_superuser`
    Public-facing descriptor, placed in the mapped class dictionary.
  `last_name`
    Public-facing descriptor, placed in the mapped class dictionary.
  `martial_status`
    Public-facing descriptor, placed in the mapped class dictionary.
  `middle_name`
    Public-facing descriptor, placed in the mapped class dictionary.
  `party_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `passport_expiry_date`
    Public-facing descriptor, placed in the mapped class dictionary.
  `passport_number`
    Public-facing descriptor, placed in the mapped class dictionary.
  `personal_title`
    Public-facing descriptor, placed in the mapped class dictionary.
  `phone`
    Public-facing descriptor, placed in the mapped class dictionary.
  `picture`
    Public-facing descriptor, placed in the mapped class dictionary.
  `row_type`
    Public-facing descriptor, placed in the mapped class dictionary.
  `sex`
    Public-facing descriptor, placed in the mapped class dictionary.
  `shares`
    Public-facing descriptor, placed in the mapped class dictionary.
  `social_security_number`
    Public-facing descriptor, placed in the mapped class dictionary.
  `status`
    Public-facing descriptor, placed in the mapped class dictionary.
  `suffix`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized`
    A combination of InsturmentedAttribute and a regular descriptor.
  `synchronized_assoc_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized_rel`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.authentication.``RepresentedRepresentor`(**kwargs)

  Relation from a representing party to the person representing the party

  `comment`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_from`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_from_party_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_to`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_to_partyrelationship_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `from_date`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `thru_date`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.authentication.``SharedShareholder`(**kwargs)

  Relation from a shared organization to a shareholder

  `comment`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_from`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_from_party_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_to`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_to_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `from_date`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `partyrelationship_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `row_type`
    Public-facing descriptor, placed in the mapped class dictionary.
  `shares`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized`
    A combination of InsturmentedAttribute and a regular descriptor.
  `synchronized_assoc_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized_rel`
    Public-facing descriptor, placed in the mapped class dictionary.
  `thru_date`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.authentication.``SupplierCustomer`(**kwargs)

  Relation from supplier to customer

  `comment`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_from`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_from_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_to`
    Public-facing descriptor, placed in the mapped class dictionary.
  `established_to_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `from_date`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `partyrelationship_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `row_type`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized`
    A combination of InsturmentedAttribute and a regular descriptor.
  `synchronized_assoc_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `synchronized_rel`
    Public-facing descriptor, placed in the mapped class dictionary.
  `thru_date`
    Public-facing descriptor, placed in the mapped class dictionary.

`camelot.model.authentication.``getCurrentAuthentication`()
  Get the currently logged in person

`camelot.model.authentication.``updateLastLogin`()
  Update the last login of the current person to now

## Auditing

class `camelot.model.memento.``BeforeDelete`(**kwargs)

  The state of the object before it is deleted

  `authentication`
    Public-facing descriptor, placed in the mapped class dictionary.
  `authentication_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `creation_date`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `memento_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `model`
    Public-facing descriptor, placed in the mapped class dictionary.
  `previous_attributes`
    Public-facing descriptor, placed in the mapped class dictionary.
  `primary_key`
    Public-facing descriptor, placed in the mapped class dictionary.
  `row_type`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.memento.``BeforeUpdate`(**kwargs)

  The state of the object before an update took place

  `authentication`
    Public-facing descriptor, placed in the mapped class dictionary.
  `authentication_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `creation_date`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `memento_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `model`
    Public-facing descriptor, placed in the mapped class dictionary.
  `previous_attributes`
    Public-facing descriptor, placed in the mapped class dictionary.
  `primary_key`
    Public-facing descriptor, placed in the mapped class dictionary.
  `row_type`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.memento.``Create`(**kwargs)

  Marks the creation of an object

  `authentication`
    Public-facing descriptor, placed in the mapped class dictionary.
  `authentication_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `creation_date`
    Public-facing descriptor, placed in the mapped class dictionary.
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `memento_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `model`
    Public-facing descriptor, placed in the mapped class dictionary.
  `primary_key`
    Public-facing descriptor, placed in the mapped class dictionary.
  `row_type`
    Public-facing descriptor, placed in the mapped class dictionary.

class `camelot.model.memento.``Memento`(**kwargs)

  Keeps information on the previous state of objects, to keep track of changes and enable restore to that previous state

  `authentication`
    Public-facing descriptor, placed in the mapped class dictionary.
  `authentication_id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `creation_date`
    Public-facing descriptor, placed in the mapped class dictionary.
  `description`
    Change
  `id`
    Public-facing descriptor, placed in the mapped class dictionary.
  `model`
    Public-facing descriptor, placed in the mapped class dictionary.
  `primary_key`
    Public-facing descriptor, placed in the mapped class dictionary.
  `row_type`
    Public-facing descriptor, placed in the mapped class dictionary.

## Synchronization with other applications

### Navigation

- index
- modules |
- next |
- previous |
- Camelot v0.1 documentation »
- Camelot Documentation contents »
- Camelot Documentation »