onadata.apps.main.models package

Submodules

onadata.apps.main.models.audit module

class onadata.apps.main.models.audit.Audit(id, json)

Bases: django.db.models.base.Model

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception Audit.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

Audit.objects = <django.db.models.manager.Manager object>
class onadata.apps.main.models.audit.AuditLog(data)

Bases: object

ACCOUNT = u'account'
CREATED_ON = u'created_on'
DEFAULT_BATCHSIZE = 1000
classmethod query_data(username, query=None, fields=None, sort=None, start=0, limit=1000, count=False)
classmethod query_iterator(sql, fields=None, params=[], count=False)
save()

onadata.apps.main.models.google_oath module

class onadata.apps.main.models.google_oath.TokenStorageModel(id, credential)

Bases: django.db.models.base.Model

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception TokenStorageModel.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

TokenStorageModel.credential

A placeholder class that provides a way to set the attribute on the model.

TokenStorageModel.id

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

TokenStorageModel.objects = <django.db.models.manager.Manager object>

onadata.apps.main.models.meta_data module

class onadata.apps.main.models.meta_data.MetaData(id, data_type, data_value, data_file, data_file_type, file_hash, date_created, date_modified, deleted_at, content_type, object_id)

Bases: django.db.models.base.Model

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception MetaData.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

MetaData.content_object

Provide a generic many-to-one relation through the content_type and object_id fields.

This class also doubles as an accessor to the related object (similar to ForwardManyToOneDescriptor) by adding itself as a model attribute.

MetaData.content_type

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

static MetaData.data_license(content_object, data_value=None)
static MetaData.enketo_preview_url(content_object, data_value=None)
static MetaData.enketo_url(content_object, data_value=None)
static MetaData.external_export(content_object, data_value=None)
MetaData.external_export_name
MetaData.external_export_template
MetaData.external_export_url
static MetaData.form_license(content_object, data_value=None)
static MetaData.get_google_sheet_details(obj)

Converts a metadata google sheet value, which contains data that is pipe separated, to a dictionary e.g ‘valueA a | valueB b’ to { ‘valueA’: ‘a’, ‘valueB’: ‘b’} :param content_object_pk: xform primary key :return dictionary containing google sheet details

MetaData.hash
MetaData.is_linked_dataset
static MetaData.mapbox_layer_upload(content_object, data=None)
static MetaData.media_add_uri(content_object, uri)

Add a uri as a media resource

static MetaData.media_upload(content_object, data_file=None, download=False)
MetaData.objects = <django.db.models.manager.Manager object>
static MetaData.published_by_formbuilder(content_object, data_value=None)
MetaData.save(*args, **kwargs)
static MetaData.set_google_sheet_details(content_object, data_value=None)
static MetaData.source(content_object, data_value=None, data_file=None)
static MetaData.supporting_docs(content_object, data_file=None)
static MetaData.textit(content_object, data_value=None)

Add a textit auth token flow uuid and default contact uuid

static MetaData.xform_meta_permission(content_object, data_value=None)
onadata.apps.main.models.meta_data.clear_cached_metadata_instance_object(sender, instance=None, created=False, **kwargs)
onadata.apps.main.models.meta_data.create_media(media)

Download media link

onadata.apps.main.models.meta_data.get_default_content_type()
onadata.apps.main.models.meta_data.is_valid_url(uri)
onadata.apps.main.models.meta_data.media_resources(media_list, download=False)

List of MetaData objects of type media

@param media_list - list of MetaData objects of type media @param download - boolean, when True downloads media files when media.data_value is a valid url

return a list of MetaData objects

onadata.apps.main.models.meta_data.save_metadata(metadata_obj)
onadata.apps.main.models.meta_data.type_for_form(content_object, data_type)
onadata.apps.main.models.meta_data.unique_type_for_form(content_object, data_type, data_value=None, data_file=None)

Ensure that each metadata object has unique xform and data_type fields

return the metadata object

onadata.apps.main.models.meta_data.update_attached_object(sender, instance=None, created=False, **kwargs)
onadata.apps.main.models.meta_data.upload_to(instance, filename)

onadata.apps.main.models.user_profile module

class onadata.apps.main.models.user_profile.UserProfile(id, user, name, city, country, organization, home_page, twitter, description, require_auth, address, phonenumber, created_by, num_of_submissions, metadata, date_modified)

Bases: django.db.models.base.Model

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception UserProfile.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

UserProfile.created_by

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

UserProfile.get_country_display(*moreargs, **morekwargs)
UserProfile.get_next_by_date_modified(*moreargs, **morekwargs)
UserProfile.get_previous_by_date_modified(*moreargs, **morekwargs)
UserProfile.gravatar
UserProfile.gravatar_exists
UserProfile.objects = <django.db.models.manager.Manager object>
UserProfile.organizationprofile

Accessor to the related object on the reverse side of a one-to-one relation.

In the example:

class Restaurant(Model):
    place = OneToOneField(Place, related_name='restaurant')

place.restaurant is a ReverseOneToOneDescriptor instance.

UserProfile.twitter_clean
UserProfile.user

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

UserProfile.userprofilegroupobjectpermission_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

UserProfile.userprofileuserobjectpermission_set

Accessor to the related objects manager on the reverse side of a many-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

parent.children is a ReverseManyToOneDescriptor instance.

Most of the implementation is delegated to a dynamically defined manager class built by create_forward_many_to_many_manager() defined below.

class onadata.apps.main.models.user_profile.UserProfileGroupObjectPermission(*args, **kwargs)

Bases: guardian.models.GroupObjectPermissionBase

Guardian model to create direct foreign keys.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception UserProfileGroupObjectPermission.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

UserProfileGroupObjectPermission.content_object

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

UserProfileGroupObjectPermission.group

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

UserProfileGroupObjectPermission.objects = <guardian.managers.GroupObjectPermissionManager object>
UserProfileGroupObjectPermission.permission

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

class onadata.apps.main.models.user_profile.UserProfileUserObjectPermission(*args, **kwargs)

Bases: guardian.models.UserObjectPermissionBase

Guardian model to create direct foreign keys.

exception DoesNotExist

Bases: django.core.exceptions.ObjectDoesNotExist

exception UserProfileUserObjectPermission.MultipleObjectsReturned

Bases: django.core.exceptions.MultipleObjectsReturned

UserProfileUserObjectPermission.content_object

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

UserProfileUserObjectPermission.objects = <guardian.managers.UserObjectPermissionManager object>
UserProfileUserObjectPermission.permission

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

UserProfileUserObjectPermission.user

Accessor to the related object on the forward side of a many-to-one or one-to-one relation.

In the example:

class Child(Model):
    parent = ForeignKey(Parent, related_name='children')

child.parent is a ForwardManyToOneDescriptor instance.

onadata.apps.main.models.user_profile.create_auth_token(sender, instance=None, created=False, **kwargs)
onadata.apps.main.models.user_profile.set_kpi_formbuilder_permissions(sender, instance=None, created=False, **kwargs)
onadata.apps.main.models.user_profile.set_object_permissions(sender, instance=None, created=False, **kwargs)

Module contents