Model Managers and QuerySets

The following Managers and QuerySets support the various mixins and base classes provided by Django Goodies.

CommonInfoManager

class django_goodies.models.managers.CommonInfoManager

CommonInfoManager is a custom manager for CommonInfoMixin that simply provides access to CommonInfoQuerySet.

CommonInfoQuerySet

class django_goodies.models.managers.CommonInfoQuerySet(*args, **kwargs)

CommonInfoQuerySet provides custom functionality pertaining to the fields provided by CommonInfoMixin.

update(user=None, **kwargs)

Overridden to ensure the user_modified and date_modified fields are always updated. The user argument is required and must be passed a User instance, unless the GOODIES_COMMON_INFO_REQUIRE_USER_ON_SAVE setting is False.

owned_by(user)

Return a queryset of records “owned” by the given user, as per the user_created field. user can be a User instance or an id.

ArchivableManager

class django_goodies.models.managers.ArchivableManager(archived=None)

ArchivableManager is a custom manager for ArchivableMixin. archive is a flag used to dictate the default filter applied on the is_archived field provided by ArchivableMixin. When given as None, no filter will be applied (the manager behaviour will not be altered). When given as True or False, the default queryset provided by the manager will be filtered to archived or unarchived records, respectively.

ArchivableManager provides access to ArchivableQuerySet.

ArchivableQuerySet

class django_goodies.models.managers.ArchivableQuerySet(*args, **kwargs)

ArchivableQuerySet provides custom functionality pertaining to the is_archived field provided by ArchivableMixin.

archive()

Archive all records in the current queryset.

unarchive()

Unarchive all records in the current queryset.

VersioningManager

class django_goodies.models.managers.VersioningManager

VersioningManager is a custom manager for VersioningMixin that simply provides access to VersioningQuerySet.

VersioningQuerySet

class django_goodies.models.managers.VersioningQuerySet(*args, **kwargs)

VersioningQuerySet provides custom functionality pertaining to the version field provided by VersioningMixin.

update(**kwargs)

Overridden to ensure the version field is always updated.