Package gen :: Package lib :: Module ldsord :: Class LdsOrd
[frames] | no frames]

Class LdsOrd

source code


Class that contains information about LDS Ordinances.

LDS ordinances are similar to events, but have very specific additional information related to data collected by the Church of Jesus Christ of Latter Day Saints (Mormon church). The LDS church is the largest source of genealogical information in the United States.

Instance Methods
 
__init__(self, source=None)
Create a LDS Ordinance instance.
source code
 
serialize(self)
Convert the object to a serialized tuple of data.
source code
 
unserialize(self, data)
Convert a serialized tuple of data to an object.
source code
list
get_text_data_list(self)
Return the list of all textual attributes of the object.
source code
list
get_text_data_child_list(self)
Return the list of child objects that may carry textual data.
source code
list
get_note_child_list(self)
Return the list of child secondary objects that may refer notes.
source code
list
get_referenced_handles(self)
Return the list of (classname, handle) tuples for all directly referenced primary objects.
source code
list
get_handle_referents(self)
Return the list of child objects which may, directly or through their children, reference primary objects.
source code
tuple
get_type(self)
Return the type of the Event.
source code
 
set_type(self, ord_type)
Set the type of the LdsOrd to the passed (int,str) tuple.
source code
 
set_family_handle(self, family)
Set the Family database handle associated with the LDS ordinance.
source code
 
get_family_handle(self)
Get the Family database handle associated with the LDS ordinance.
source code
 
set_status(self, val)
Set the status of the LDS ordinance.
source code
 
get_status(self)
Get the status of the LDS ordinance.
source code
 
set_temple(self, temple)
Set the temple assocated with the ordinance.
source code
 
get_temple(self)
Get the temple assocated with the ordinance.
source code
 
is_empty(self)
Return 1 if the ordinance is actually empty.
source code
 
are_equal(self, other)
Return 1 if the specified ordinance is the same as the instance.
source code
 
type2xml(self)
Return type-representing string suitable for XML.
source code
 
type2str(self)
Return type-representing string suitable for UI (translated).
source code
 
set_type_from_xml(self, xml_str)
Set type based on a given string from XML.
source code
 
status2xml(self)
Return status-representing string suitable for XML.
source code
 
status2str(self)
Return status-representing string suitable for UI (translated).
source code
 
set_status_from_xml(self, xml_str)
Set status based on a given string from XML.
source code

Inherited from secondaryobj.SecondaryObject: is_equal

Inherited from baseobj.BaseObject: get_referenced_handles_recursively, matches_regexp, matches_string

Inherited from srcbase.SourceBase: add_source_reference, get_source_references, get_sourcref_child_list, has_source_reference, remove_source_references, replace_source_references, set_source_reference_list

Inherited from notebase.NoteBase: add_note, get_note_list, get_referenced_note_handles, remove_note, set_note_list

Inherited from datebase.DateBase: get_date_object, set_date_object

Inherited from placebase.PlaceBase: get_place_handle, set_place_handle

Inherited from privacybase.PrivacyBase: get_privacy, set_privacy

Class Variables
  BAPTISM = 0
  ENDOWMENT = 1
  SEAL_TO_PARENTS = 2
  SEAL_TO_SPOUSE = 3
  CONFIRMATION = 4
  DEFAULT_TYPE = 0
  STATUS_NONE = 0
  STATUS_BIC = 1
  STATUS_CANCELED = 2
  STATUS_CHILD = 3
  STATUS_CLEARED = 4
  STATUS_COMPLETED = 5
  STATUS_DNS = 6
  STATUS_INFANT = 7
  STATUS_PRE_1970 = 8
  STATUS_QUALIFIED = 9
  STATUS_DNS_CAN = 10
  STATUS_STILLBORN = 11
  STATUS_SUBMITTED = 12
  STATUS_UNCLEARED = 13
  DEFAULT_STATUS = 0
Method Details

__init__(self, source=None)
(Constructor)

source code 

Create a LDS Ordinance instance.

Parameters:
  • source - Object used to initialize the new object
Overrides: privacybase.PrivacyBase.__init__

serialize(self)

source code 

Convert the object to a serialized tuple of data.

Overrides: privacybase.PrivacyBase.serialize

unserialize(self, data)

source code 

Convert a serialized tuple of data to an object.

Overrides: privacybase.PrivacyBase.unserialize

get_text_data_list(self)

source code 

Return the list of all textual attributes of the object.

Returns: list
Returns the list of all textual attributes of the object.
Overrides: baseobj.BaseObject.get_text_data_list

get_text_data_child_list(self)

source code 

Return the list of child objects that may carry textual data.

Returns: list
Returns the list of child objects that may carry textual data.
Overrides: baseobj.BaseObject.get_text_data_child_list

get_note_child_list(self)

source code 

Return the list of child secondary objects that may refer notes.

Returns: list
Returns the list of child secondary child objects that may refer notes.
Overrides: notebase.NoteBase.get_note_child_list

get_referenced_handles(self)

source code 

Return the list of (classname, handle) tuples for all directly referenced primary objects.

Returns: list
List of (classname, handle) tuples for referenced objects.
Overrides: baseobj.BaseObject.get_referenced_handles

get_handle_referents(self)

source code 

Return the list of child objects which may, directly or through their children, reference primary objects.

Returns: list
Returns the list of objects refereincing primary objects.
Overrides: baseobj.BaseObject.get_handle_referents

get_type(self)

source code 

Return the type of the Event.

Returns: tuple
Type of the Event

set_type(self, ord_type)

source code 

Set the type of the LdsOrd to the passed (int,str) tuple.

Parameters:
  • ord_type (tuple) - Type to assign to the LdsOrd

set_status(self, val)

source code 

Set the status of the LDS ordinance.

The status is a text string that matches a predefined set of strings.

set_type_from_xml(self, xml_str)

source code 

Set type based on a given string from XML.

Return boolean on success.

set_status_from_xml(self, xml_str)

source code 

Set status based on a given string from XML.

Return boolean on success.