activity.go

package gaia

import (
	"fmt"
	"time"

	"github.com/globalsign/mgo/bson"
	"github.com/mitchellh/copystructure"
	"go.aporeto.io/elemental"
)

// ActivityIdentity represents the Identity of the object.
var ActivityIdentity = elemental.Identity{
	Name:     "activity",
	Category: "activities",
	Package:  "hojo",
	Private:  false,
}

// ActivitiesList represents a list of Activities
type ActivitiesList []*Activity

// Identity returns the identity of the objects in the list.
func (o ActivitiesList) Identity() elemental.Identity {

	return ActivityIdentity
}

// Copy returns a pointer to a copy the ActivitiesList.
func (o ActivitiesList) Copy() elemental.Identifiables {

	copy := append(ActivitiesList{}, o...)
	return &copy
}

// Append appends the objects to the a new copy of the ActivitiesList.
func (o ActivitiesList) Append(objects ...elemental.Identifiable) elemental.Identifiables {

	out := append(ActivitiesList{}, o...)
	for _, obj := range objects {
		out = append(out, obj.(*Activity))
	}

	return out
}

// List converts the object to an elemental.IdentifiablesList.
func (o ActivitiesList) List() elemental.IdentifiablesList {

	out := make(elemental.IdentifiablesList, len(o))
	for i := 0; i < len(o); i++ {
		out[i] = o[i]
	}

	return out
}

// DefaultOrder returns the default ordering fields of the content.
func (o ActivitiesList) DefaultOrder() []string {

	return []string{}
}

// ToSparse returns the ActivitiesList converted to SparseActivitiesList.
// Objects in the list will only contain the given fields. No field means entire field set.
func (o ActivitiesList) ToSparse(fields ...string) elemental.Identifiables {

	out := make(SparseActivitiesList, len(o))
	for i := 0; i < len(o); i++ {
		out[i] = o[i].ToSparse(fields...).(*SparseActivity)
	}

	return out
}

// Version returns the version of the content.
func (o ActivitiesList) Version() int {

	return 1
}

// Activity represents the model of a activity
type Activity struct {
	// Identifier of the object.
	ID string `json:"ID" msgpack:"ID" bson:"-" mapstructure:"ID,omitempty"`

	// Claims of the user who performed the operation.
	Claims interface{} `json:"claims" msgpack:"claims" bson:"claims" mapstructure:"claims,omitempty"`

	// This is deprecated in favor of `diff`.
	Data interface{} `json:"data" msgpack:"data" bson:"data" mapstructure:"data,omitempty"`

	// Time-date stamp of the notification.
	Date time.Time `json:"date" msgpack:"date" bson:"date" mapstructure:"date,omitempty"`

	// Contains the diff of the change.
	Diff string `json:"diff" msgpack:"diff" bson:"diff" mapstructure:"diff,omitempty"`

	// Contains the error.
	Error interface{} `json:"error" msgpack:"error" bson:"error" mapstructure:"error,omitempty"`

	// Message of the notification.
	Message string `json:"message" msgpack:"message" bson:"message" mapstructure:"message,omitempty"`

	// Internal property maintaining migrations information.
	MigrationsLog map[string]string `json:"-" msgpack:"-" bson:"migrationslog,omitempty" mapstructure:"-,omitempty"`

	// Namespace tag attached to an entity.
	Namespace string `json:"namespace" msgpack:"namespace" bson:"namespace" mapstructure:"namespace,omitempty"`

	// Describes what kind of operation the notification represents.
	Operation string `json:"operation" msgpack:"operation" bson:"operation" mapstructure:"operation,omitempty"`

	// This is deprecated in favor of `diff`.
	OriginalData interface{} `json:"originalData" msgpack:"originalData" bson:"originaldata" mapstructure:"originalData,omitempty"`

	// Contains meta information about the source.
	Source string `json:"source" msgpack:"source" bson:"source" mapstructure:"source,omitempty"`

	// The identity of the related object.
	TargetIdentity string `json:"targetIdentity" msgpack:"targetIdentity" bson:"targetidentity" mapstructure:"targetIdentity,omitempty"`

	// geographical hash of the data. This is used for sharding and
	// georedundancy.
	ZHash int `json:"-" msgpack:"-" bson:"zhash" mapstructure:"-,omitempty"`

	// Logical storage zone. Used for sharding.
	Zone int `json:"-" msgpack:"-" bson:"zone" mapstructure:"-,omitempty"`

	ModelVersion int `json:"-" msgpack:"-" bson:"_modelversion"`
}

// NewActivity returns a new *Activity
func NewActivity() *Activity {

	return &Activity{
		ModelVersion:  1,
		MigrationsLog: map[string]string{},
	}
}

// Identity returns the Identity of the object.
func (o *Activity) Identity() elemental.Identity {

	return ActivityIdentity
}

// Identifier returns the value of the object's unique identifier.
func (o *Activity) Identifier() string {

	return o.ID
}

// SetIdentifier sets the value of the object's unique identifier.
func (o *Activity) SetIdentifier(id string) {

	o.ID = id
}

// GetBSON implements the bson marshaling interface.
// This is used to transparently convert ID to MongoDBID as ObectID.
func (o *Activity) GetBSON() (interface{}, error) {

	if o == nil {
		return nil, nil
	}

	s := &mongoAttributesActivity{}

	if o.ID != "" {
		s.ID = bson.ObjectIdHex(o.ID)
	}
	s.Claims = o.Claims
	s.Data = o.Data
	s.Date = o.Date
	s.Diff = o.Diff
	s.Error = o.Error
	s.Message = o.Message
	s.MigrationsLog = o.MigrationsLog
	s.Namespace = o.Namespace
	s.Operation = o.Operation
	s.OriginalData = o.OriginalData
	s.Source = o.Source
	s.TargetIdentity = o.TargetIdentity
	s.ZHash = o.ZHash
	s.Zone = o.Zone

	return s, nil
}

// SetBSON implements the bson marshaling interface.
// This is used to transparently convert ID to MongoDBID as ObectID.
func (o *Activity) SetBSON(raw bson.Raw) error {

	if o == nil {
		return nil
	}

	s := &mongoAttributesActivity{}
	if err := raw.Unmarshal(s); err != nil {
		return err
	}

	o.ID = s.ID.Hex()
	o.Claims = s.Claims
	o.Data = s.Data
	o.Date = s.Date
	o.Diff = s.Diff
	o.Error = s.Error
	o.Message = s.Message
	o.MigrationsLog = s.MigrationsLog
	o.Namespace = s.Namespace
	o.Operation = s.Operation
	o.OriginalData = s.OriginalData
	o.Source = s.Source
	o.TargetIdentity = s.TargetIdentity
	o.ZHash = s.ZHash
	o.Zone = s.Zone

	return nil
}

// Version returns the hardcoded version of the model.
func (o *Activity) Version() int {

	return 1
}

// BleveType implements the bleve.Classifier Interface.
func (o *Activity) BleveType() string {

	return "activity"
}

// DefaultOrder returns the list of default ordering fields.
func (o *Activity) DefaultOrder() []string {

	return []string{}
}

// Doc returns the documentation for the object
func (o *Activity) Doc() string {

	return `Contains logs of all the activity that happened in a namespace. All successful
or
failed actions will be available, errors, as well as the claims of
the user who triggered the actions. This log is capped and only keeps the last
50,000 entries by default.`
}

func (o *Activity) String() string {

	return fmt.Sprintf("<%s:%s>", o.Identity().Name, o.Identifier())
}

// GetMigrationsLog returns the MigrationsLog of the receiver.
func (o *Activity) GetMigrationsLog() map[string]string {

	return o.MigrationsLog
}

// SetMigrationsLog sets the property MigrationsLog of the receiver using the given value.
func (o *Activity) SetMigrationsLog(migrationsLog map[string]string) {

	o.MigrationsLog = migrationsLog
}

// GetNamespace returns the Namespace of the receiver.
func (o *Activity) GetNamespace() string {

	return o.Namespace
}

// SetNamespace sets the property Namespace of the receiver using the given value.
func (o *Activity) SetNamespace(namespace string) {

	o.Namespace = namespace
}

// GetZHash returns the ZHash of the receiver.
func (o *Activity) GetZHash() int {

	return o.ZHash
}

// SetZHash sets the property ZHash of the receiver using the given value.
func (o *Activity) SetZHash(zHash int) {

	o.ZHash = zHash
}

// GetZone returns the Zone of the receiver.
func (o *Activity) GetZone() int {

	return o.Zone
}

// SetZone sets the property Zone of the receiver using the given value.
func (o *Activity) SetZone(zone int) {

	o.Zone = zone
}

// ToSparse returns the sparse version of the model.
// The returned object will only contain the given fields. No field means entire field set.
func (o *Activity) ToSparse(fields ...string) elemental.SparseIdentifiable {

	if len(fields) == 0 {
		// nolint: goimports
		return &SparseActivity{
			ID:             &o.ID,
			Claims:         &o.Claims,
			Data:           &o.Data,
			Date:           &o.Date,
			Diff:           &o.Diff,
			Error:          &o.Error,
			Message:        &o.Message,
			MigrationsLog:  &o.MigrationsLog,
			Namespace:      &o.Namespace,
			Operation:      &o.Operation,
			OriginalData:   &o.OriginalData,
			Source:         &o.Source,
			TargetIdentity: &o.TargetIdentity,
			ZHash:          &o.ZHash,
			Zone:           &o.Zone,
		}
	}

	sp := &SparseActivity{}
	for _, f := range fields {
		switch f {
		case "ID":
			sp.ID = &(o.ID)
		case "claims":
			sp.Claims = &(o.Claims)
		case "data":
			sp.Data = &(o.Data)
		case "date":
			sp.Date = &(o.Date)
		case "diff":
			sp.Diff = &(o.Diff)
		case "error":
			sp.Error = &(o.Error)
		case "message":
			sp.Message = &(o.Message)
		case "migrationsLog":
			sp.MigrationsLog = &(o.MigrationsLog)
		case "namespace":
			sp.Namespace = &(o.Namespace)
		case "operation":
			sp.Operation = &(o.Operation)
		case "originalData":
			sp.OriginalData = &(o.OriginalData)
		case "source":
			sp.Source = &(o.Source)
		case "targetIdentity":
			sp.TargetIdentity = &(o.TargetIdentity)
		case "zHash":
			sp.ZHash = &(o.ZHash)
		case "zone":
			sp.Zone = &(o.Zone)
		}
	}

	return sp
}

// Patch apply the non nil value of a *SparseActivity to the object.
func (o *Activity) Patch(sparse elemental.SparseIdentifiable) {
	if !sparse.Identity().IsEqual(o.Identity()) {
		panic("cannot patch from a parse with different identity")
	}

	so := sparse.(*SparseActivity)
	if so.ID != nil {
		o.ID = *so.ID
	}
	if so.Claims != nil {
		o.Claims = *so.Claims
	}
	if so.Data != nil {
		o.Data = *so.Data
	}
	if so.Date != nil {
		o.Date = *so.Date
	}
	if so.Diff != nil {
		o.Diff = *so.Diff
	}
	if so.Error != nil {
		o.Error = *so.Error
	}
	if so.Message != nil {
		o.Message = *so.Message
	}
	if so.MigrationsLog != nil {
		o.MigrationsLog = *so.MigrationsLog
	}
	if so.Namespace != nil {
		o.Namespace = *so.Namespace
	}
	if so.Operation != nil {
		o.Operation = *so.Operation
	}
	if so.OriginalData != nil {
		o.OriginalData = *so.OriginalData
	}
	if so.Source != nil {
		o.Source = *so.Source
	}
	if so.TargetIdentity != nil {
		o.TargetIdentity = *so.TargetIdentity
	}
	if so.ZHash != nil {
		o.ZHash = *so.ZHash
	}
	if so.Zone != nil {
		o.Zone = *so.Zone
	}
}

// DeepCopy returns a deep copy if the Activity.
func (o *Activity) DeepCopy() *Activity {

	if o == nil {
		return nil
	}

	out := &Activity{}
	o.DeepCopyInto(out)

	return out
}

// DeepCopyInto copies the receiver into the given *Activity.
func (o *Activity) DeepCopyInto(out *Activity) {

	target, err := copystructure.Copy(o)
	if err != nil {
		panic(fmt.Sprintf("Unable to deepcopy Activity: %s", err))
	}

	*out = *target.(*Activity)
}

// Validate valides the current information stored into the structure.
func (o *Activity) Validate() error {

	errors := elemental.Errors{}
	requiredErrors := elemental.Errors{}

	if len(requiredErrors) > 0 {
		return requiredErrors
	}

	if len(errors) > 0 {
		return errors
	}

	return nil
}

// SpecificationForAttribute returns the AttributeSpecification for the given attribute name key.
func (*Activity) SpecificationForAttribute(name string) elemental.AttributeSpecification {

	if v, ok := ActivityAttributesMap[name]; ok {
		return v
	}

	// We could not find it, so let's check on the lower case indexed spec map
	return ActivityLowerCaseAttributesMap[name]
}

// AttributeSpecifications returns the full attribute specifications map.
func (*Activity) AttributeSpecifications() map[string]elemental.AttributeSpecification {

	return ActivityAttributesMap
}

// ValueForAttribute returns the value for the given attribute.
// This is a very advanced function that you should not need but in some
// very specific use cases.
func (o *Activity) ValueForAttribute(name string) interface{} {

	switch name {
	case "ID":
		return o.ID
	case "claims":
		return o.Claims
	case "data":
		return o.Data
	case "date":
		return o.Date
	case "diff":
		return o.Diff
	case "error":
		return o.Error
	case "message":
		return o.Message
	case "migrationsLog":
		return o.MigrationsLog
	case "namespace":
		return o.Namespace
	case "operation":
		return o.Operation
	case "originalData":
		return o.OriginalData
	case "source":
		return o.Source
	case "targetIdentity":
		return o.TargetIdentity
	case "zHash":
		return o.ZHash
	case "zone":
		return o.Zone
	}

	return nil
}

// ActivityAttributesMap represents the map of attribute for Activity.
var ActivityAttributesMap = map[string]elemental.AttributeSpecification{
	"ID": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "_id",
		ConvertedName:  "ID",
		Description:    `Identifier of the object.`,
		Exposed:        true,
		Filterable:     true,
		Identifier:     true,
		Name:           "ID",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"Claims": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "claims",
		ConvertedName:  "Claims",
		Description:    `Claims of the user who performed the operation.`,
		Exposed:        true,
		Name:           "claims",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "object",
	},
	"Data": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "data",
		ConvertedName:  "Data",
		Deprecated:     true,
		Description:    `This is deprecated in favor of ` + "`" + `diff` + "`" + `.`,
		Exposed:        true,
		Name:           "data",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "object",
	},
	"Date": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "date",
		ConvertedName:  "Date",
		Description:    `Time-date stamp of the notification.`,
		Exposed:        true,
		Name:           "date",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "time",
	},
	"Diff": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "diff",
		ConvertedName:  "Diff",
		Description:    `Contains the diff of the change.`,
		Exposed:        true,
		Name:           "diff",
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"Error": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "error",
		ConvertedName:  "Error",
		Description:    `Contains the error.`,
		Exposed:        true,
		Name:           "error",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "object",
	},
	"Message": {
		AllowedChoices: []string{},
		BSONFieldName:  "message",
		ConvertedName:  "Message",
		Description:    `Message of the notification.`,
		Exposed:        true,
		Name:           "message",
		Orderable:      true,
		Stored:         true,
		Type:           "string",
	},
	"MigrationsLog": {
		AllowedChoices: []string{},
		BSONFieldName:  "migrationslog",
		ConvertedName:  "MigrationsLog",
		Description:    `Internal property maintaining migrations information.`,
		Getter:         true,
		Name:           "migrationsLog",
		Setter:         true,
		Stored:         true,
		SubType:        "map[string]string",
		Type:           "external",
	},
	"Namespace": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "namespace",
		ConvertedName:  "Namespace",
		Description:    `Namespace tag attached to an entity.`,
		Exposed:        true,
		Filterable:     true,
		Getter:         true,
		Name:           "namespace",
		Orderable:      true,
		ReadOnly:       true,
		Setter:         true,
		Stored:         true,
		Type:           "string",
	},
	"Operation": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "operation",
		ConvertedName:  "Operation",
		Description:    `Describes what kind of operation the notification represents.`,
		Exposed:        true,
		Filterable:     true,
		Name:           "operation",
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"OriginalData": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "originaldata",
		ConvertedName:  "OriginalData",
		Deprecated:     true,
		Description:    `This is deprecated in favor of ` + "`" + `diff` + "`" + `.`,
		Exposed:        true,
		Name:           "originalData",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "object",
	},
	"Source": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "source",
		ConvertedName:  "Source",
		Description:    `Contains meta information about the source.`,
		Exposed:        true,
		Filterable:     true,
		Name:           "source",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"TargetIdentity": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "targetidentity",
		ConvertedName:  "TargetIdentity",
		Description:    `The identity of the related object.`,
		Exposed:        true,
		Filterable:     true,
		Name:           "targetIdentity",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"ZHash": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "zhash",
		ConvertedName:  "ZHash",
		Description: `geographical hash of the data. This is used for sharding and
georedundancy.`,
		Getter:   true,
		Name:     "zHash",
		ReadOnly: true,
		Setter:   true,
		Stored:   true,
		Type:     "integer",
	},
	"Zone": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "zone",
		ConvertedName:  "Zone",
		Description:    `Logical storage zone. Used for sharding.`,
		Getter:         true,
		Name:           "zone",
		ReadOnly:       true,
		Setter:         true,
		Stored:         true,
		Transient:      true,
		Type:           "integer",
	},
}

// ActivityLowerCaseAttributesMap represents the map of attribute for Activity.
var ActivityLowerCaseAttributesMap = map[string]elemental.AttributeSpecification{
	"id": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "_id",
		ConvertedName:  "ID",
		Description:    `Identifier of the object.`,
		Exposed:        true,
		Filterable:     true,
		Identifier:     true,
		Name:           "ID",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"claims": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "claims",
		ConvertedName:  "Claims",
		Description:    `Claims of the user who performed the operation.`,
		Exposed:        true,
		Name:           "claims",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "object",
	},
	"data": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "data",
		ConvertedName:  "Data",
		Deprecated:     true,
		Description:    `This is deprecated in favor of ` + "`" + `diff` + "`" + `.`,
		Exposed:        true,
		Name:           "data",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "object",
	},
	"date": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "date",
		ConvertedName:  "Date",
		Description:    `Time-date stamp of the notification.`,
		Exposed:        true,
		Name:           "date",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "time",
	},
	"diff": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "diff",
		ConvertedName:  "Diff",
		Description:    `Contains the diff of the change.`,
		Exposed:        true,
		Name:           "diff",
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"error": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "error",
		ConvertedName:  "Error",
		Description:    `Contains the error.`,
		Exposed:        true,
		Name:           "error",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "object",
	},
	"message": {
		AllowedChoices: []string{},
		BSONFieldName:  "message",
		ConvertedName:  "Message",
		Description:    `Message of the notification.`,
		Exposed:        true,
		Name:           "message",
		Orderable:      true,
		Stored:         true,
		Type:           "string",
	},
	"migrationslog": {
		AllowedChoices: []string{},
		BSONFieldName:  "migrationslog",
		ConvertedName:  "MigrationsLog",
		Description:    `Internal property maintaining migrations information.`,
		Getter:         true,
		Name:           "migrationsLog",
		Setter:         true,
		Stored:         true,
		SubType:        "map[string]string",
		Type:           "external",
	},
	"namespace": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "namespace",
		ConvertedName:  "Namespace",
		Description:    `Namespace tag attached to an entity.`,
		Exposed:        true,
		Filterable:     true,
		Getter:         true,
		Name:           "namespace",
		Orderable:      true,
		ReadOnly:       true,
		Setter:         true,
		Stored:         true,
		Type:           "string",
	},
	"operation": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "operation",
		ConvertedName:  "Operation",
		Description:    `Describes what kind of operation the notification represents.`,
		Exposed:        true,
		Filterable:     true,
		Name:           "operation",
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"originaldata": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "originaldata",
		ConvertedName:  "OriginalData",
		Deprecated:     true,
		Description:    `This is deprecated in favor of ` + "`" + `diff` + "`" + `.`,
		Exposed:        true,
		Name:           "originalData",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "object",
	},
	"source": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "source",
		ConvertedName:  "Source",
		Description:    `Contains meta information about the source.`,
		Exposed:        true,
		Filterable:     true,
		Name:           "source",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"targetidentity": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "targetidentity",
		ConvertedName:  "TargetIdentity",
		Description:    `The identity of the related object.`,
		Exposed:        true,
		Filterable:     true,
		Name:           "targetIdentity",
		Orderable:      true,
		ReadOnly:       true,
		Stored:         true,
		Type:           "string",
	},
	"zhash": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "zhash",
		ConvertedName:  "ZHash",
		Description: `geographical hash of the data. This is used for sharding and
georedundancy.`,
		Getter:   true,
		Name:     "zHash",
		ReadOnly: true,
		Setter:   true,
		Stored:   true,
		Type:     "integer",
	},
	"zone": {
		AllowedChoices: []string{},
		Autogenerated:  true,
		BSONFieldName:  "zone",
		ConvertedName:  "Zone",
		Description:    `Logical storage zone. Used for sharding.`,
		Getter:         true,
		Name:           "zone",
		ReadOnly:       true,
		Setter:         true,
		Stored:         true,
		Transient:      true,
		Type:           "integer",
	},
}

// SparseActivitiesList represents a list of SparseActivities
type SparseActivitiesList []*SparseActivity

// Identity returns the identity of the objects in the list.
func (o SparseActivitiesList) Identity() elemental.Identity {

	return ActivityIdentity
}

// Copy returns a pointer to a copy the SparseActivitiesList.
func (o SparseActivitiesList) Copy() elemental.Identifiables {

	copy := append(SparseActivitiesList{}, o...)
	return &copy
}

// Append appends the objects to the a new copy of the SparseActivitiesList.
func (o SparseActivitiesList) Append(objects ...elemental.Identifiable) elemental.Identifiables {

	out := append(SparseActivitiesList{}, o...)
	for _, obj := range objects {
		out = append(out, obj.(*SparseActivity))
	}

	return out
}

// List converts the object to an elemental.IdentifiablesList.
func (o SparseActivitiesList) List() elemental.IdentifiablesList {

	out := make(elemental.IdentifiablesList, len(o))
	for i := 0; i < len(o); i++ {
		out[i] = o[i]
	}

	return out
}

// DefaultOrder returns the default ordering fields of the content.
func (o SparseActivitiesList) DefaultOrder() []string {

	return []string{}
}

// ToPlain returns the SparseActivitiesList converted to ActivitiesList.
func (o SparseActivitiesList) ToPlain() elemental.IdentifiablesList {

	out := make(elemental.IdentifiablesList, len(o))
	for i := 0; i < len(o); i++ {
		out[i] = o[i].ToPlain()
	}

	return out
}

// Version returns the version of the content.
func (o SparseActivitiesList) Version() int {

	return 1
}

// SparseActivity represents the sparse version of a activity.
type SparseActivity struct {
	// Identifier of the object.
	ID *string `json:"ID,omitempty" msgpack:"ID,omitempty" bson:"-" mapstructure:"ID,omitempty"`

	// Claims of the user who performed the operation.
	Claims *interface{} `json:"claims,omitempty" msgpack:"claims,omitempty" bson:"claims,omitempty" mapstructure:"claims,omitempty"`

	// This is deprecated in favor of `diff`.
	Data *interface{} `json:"data,omitempty" msgpack:"data,omitempty" bson:"data,omitempty" mapstructure:"data,omitempty"`

	// Time-date stamp of the notification.
	Date *time.Time `json:"date,omitempty" msgpack:"date,omitempty" bson:"date,omitempty" mapstructure:"date,omitempty"`

	// Contains the diff of the change.
	Diff *string `json:"diff,omitempty" msgpack:"diff,omitempty" bson:"diff,omitempty" mapstructure:"diff,omitempty"`

	// Contains the error.
	Error *interface{} `json:"error,omitempty" msgpack:"error,omitempty" bson:"error,omitempty" mapstructure:"error,omitempty"`

	// Message of the notification.
	Message *string `json:"message,omitempty" msgpack:"message,omitempty" bson:"message,omitempty" mapstructure:"message,omitempty"`

	// Internal property maintaining migrations information.
	MigrationsLog *map[string]string `json:"-" msgpack:"-" bson:"migrationslog,omitempty" mapstructure:"-,omitempty"`

	// Namespace tag attached to an entity.
	Namespace *string `json:"namespace,omitempty" msgpack:"namespace,omitempty" bson:"namespace,omitempty" mapstructure:"namespace,omitempty"`

	// Describes what kind of operation the notification represents.
	Operation *string `json:"operation,omitempty" msgpack:"operation,omitempty" bson:"operation,omitempty" mapstructure:"operation,omitempty"`

	// This is deprecated in favor of `diff`.
	OriginalData *interface{} `json:"originalData,omitempty" msgpack:"originalData,omitempty" bson:"originaldata,omitempty" mapstructure:"originalData,omitempty"`

	// Contains meta information about the source.
	Source *string `json:"source,omitempty" msgpack:"source,omitempty" bson:"source,omitempty" mapstructure:"source,omitempty"`

	// The identity of the related object.
	TargetIdentity *string `json:"targetIdentity,omitempty" msgpack:"targetIdentity,omitempty" bson:"targetidentity,omitempty" mapstructure:"targetIdentity,omitempty"`

	// geographical hash of the data. This is used for sharding and
	// georedundancy.
	ZHash *int `json:"-" msgpack:"-" bson:"zhash,omitempty" mapstructure:"-,omitempty"`

	// Logical storage zone. Used for sharding.
	Zone *int `json:"-" msgpack:"-" bson:"zone,omitempty" mapstructure:"-,omitempty"`

	ModelVersion int `json:"-" msgpack:"-" bson:"_modelversion"`
}

// NewSparseActivity returns a new  SparseActivity.
func NewSparseActivity() *SparseActivity {
	return &SparseActivity{}
}

// Identity returns the Identity of the sparse object.
func (o *SparseActivity) Identity() elemental.Identity {

	return ActivityIdentity
}

// Identifier returns the value of the sparse object's unique identifier.
func (o *SparseActivity) Identifier() string {

	if o.ID == nil {
		return ""
	}
	return *o.ID
}

// SetIdentifier sets the value of the sparse object's unique identifier.
func (o *SparseActivity) SetIdentifier(id string) {

	if id != "" {
		o.ID = &id
	} else {
		o.ID = nil
	}
}

// GetBSON implements the bson marshaling interface.
// This is used to transparently convert ID to MongoDBID as ObectID.
func (o *SparseActivity) GetBSON() (interface{}, error) {

	if o == nil {
		return nil, nil
	}

	s := &mongoAttributesSparseActivity{}

	if o.ID != nil {
		s.ID = bson.ObjectIdHex(*o.ID)
	}
	if o.Claims != nil {
		s.Claims = o.Claims
	}
	if o.Data != nil {
		s.Data = o.Data
	}
	if o.Date != nil {
		s.Date = o.Date
	}
	if o.Diff != nil {
		s.Diff = o.Diff
	}
	if o.Error != nil {
		s.Error = o.Error
	}
	if o.Message != nil {
		s.Message = o.Message
	}
	if o.MigrationsLog != nil {
		s.MigrationsLog = o.MigrationsLog
	}
	if o.Namespace != nil {
		s.Namespace = o.Namespace
	}
	if o.Operation != nil {
		s.Operation = o.Operation
	}
	if o.OriginalData != nil {
		s.OriginalData = o.OriginalData
	}
	if o.Source != nil {
		s.Source = o.Source
	}
	if o.TargetIdentity != nil {
		s.TargetIdentity = o.TargetIdentity
	}
	if o.ZHash != nil {
		s.ZHash = o.ZHash
	}
	if o.Zone != nil {
		s.Zone = o.Zone
	}

	return s, nil
}

// SetBSON implements the bson marshaling interface.
// This is used to transparently convert ID to MongoDBID as ObectID.
func (o *SparseActivity) SetBSON(raw bson.Raw) error {

	if o == nil {
		return nil
	}

	s := &mongoAttributesSparseActivity{}
	if err := raw.Unmarshal(s); err != nil {
		return err
	}

	id := s.ID.Hex()
	o.ID = &id
	if s.Claims != nil {
		o.Claims = s.Claims
	}
	if s.Data != nil {
		o.Data = s.Data
	}
	if s.Date != nil {
		o.Date = s.Date
	}
	if s.Diff != nil {
		o.Diff = s.Diff
	}
	if s.Error != nil {
		o.Error = s.Error
	}
	if s.Message != nil {
		o.Message = s.Message
	}
	if s.MigrationsLog != nil {
		o.MigrationsLog = s.MigrationsLog
	}
	if s.Namespace != nil {
		o.Namespace = s.Namespace
	}
	if s.Operation != nil {
		o.Operation = s.Operation
	}
	if s.OriginalData != nil {
		o.OriginalData = s.OriginalData
	}
	if s.Source != nil {
		o.Source = s.Source
	}
	if s.TargetIdentity != nil {
		o.TargetIdentity = s.TargetIdentity
	}
	if s.ZHash != nil {
		o.ZHash = s.ZHash
	}
	if s.Zone != nil {
		o.Zone = s.Zone
	}

	return nil
}

// Version returns the hardcoded version of the model.
func (o *SparseActivity) Version() int {

	return 1
}

// ToPlain returns the plain version of the sparse model.
func (o *SparseActivity) ToPlain() elemental.PlainIdentifiable {

	out := NewActivity()
	if o.ID != nil {
		out.ID = *o.ID
	}
	if o.Claims != nil {
		out.Claims = *o.Claims
	}
	if o.Data != nil {
		out.Data = *o.Data
	}
	if o.Date != nil {
		out.Date = *o.Date
	}
	if o.Diff != nil {
		out.Diff = *o.Diff
	}
	if o.Error != nil {
		out.Error = *o.Error
	}
	if o.Message != nil {
		out.Message = *o.Message
	}
	if o.MigrationsLog != nil {
		out.MigrationsLog = *o.MigrationsLog
	}
	if o.Namespace != nil {
		out.Namespace = *o.Namespace
	}
	if o.Operation != nil {
		out.Operation = *o.Operation
	}
	if o.OriginalData != nil {
		out.OriginalData = *o.OriginalData
	}
	if o.Source != nil {
		out.Source = *o.Source
	}
	if o.TargetIdentity != nil {
		out.TargetIdentity = *o.TargetIdentity
	}
	if o.ZHash != nil {
		out.ZHash = *o.ZHash
	}
	if o.Zone != nil {
		out.Zone = *o.Zone
	}

	return out
}

// GetMigrationsLog returns the MigrationsLog of the receiver.
func (o *SparseActivity) GetMigrationsLog() (out map[string]string) {

	if o.MigrationsLog == nil {
		return
	}

	return *o.MigrationsLog
}

// SetMigrationsLog sets the property MigrationsLog of the receiver using the address of the given value.
func (o *SparseActivity) SetMigrationsLog(migrationsLog map[string]string) {

	o.MigrationsLog = &migrationsLog
}

// GetNamespace returns the Namespace of the receiver.
func (o *SparseActivity) GetNamespace() (out string) {

	if o.Namespace == nil {
		return
	}

	return *o.Namespace
}

// SetNamespace sets the property Namespace of the receiver using the address of the given value.
func (o *SparseActivity) SetNamespace(namespace string) {

	o.Namespace = &namespace
}

// GetZHash returns the ZHash of the receiver.
func (o *SparseActivity) GetZHash() (out int) {

	if o.ZHash == nil {
		return
	}

	return *o.ZHash
}

// SetZHash sets the property ZHash of the receiver using the address of the given value.
func (o *SparseActivity) SetZHash(zHash int) {

	o.ZHash = &zHash
}

// GetZone returns the Zone of the receiver.
func (o *SparseActivity) GetZone() (out int) {

	if o.Zone == nil {
		return
	}

	return *o.Zone
}

// SetZone sets the property Zone of the receiver using the address of the given value.
func (o *SparseActivity) SetZone(zone int) {

	o.Zone = &zone
}

// DeepCopy returns a deep copy if the SparseActivity.
func (o *SparseActivity) DeepCopy() *SparseActivity {

	if o == nil {
		return nil
	}

	out := &SparseActivity{}
	o.DeepCopyInto(out)

	return out
}

// DeepCopyInto copies the receiver into the given *SparseActivity.
func (o *SparseActivity) DeepCopyInto(out *SparseActivity) {

	target, err := copystructure.Copy(o)
	if err != nil {
		panic(fmt.Sprintf("Unable to deepcopy SparseActivity: %s", err))
	}

	*out = *target.(*SparseActivity)
}

type mongoAttributesActivity struct {
	ID             bson.ObjectId     `bson:"_id,omitempty"`
	Claims         interface{}       `bson:"claims"`
	Data           interface{}       `bson:"data"`
	Date           time.Time         `bson:"date"`
	Diff           string            `bson:"diff"`
	Error          interface{}       `bson:"error"`
	Message        string            `bson:"message"`
	MigrationsLog  map[string]string `bson:"migrationslog,omitempty"`
	Namespace      string            `bson:"namespace"`
	Operation      string            `bson:"operation"`
	OriginalData   interface{}       `bson:"originaldata"`
	Source         string            `bson:"source"`
	TargetIdentity string            `bson:"targetidentity"`
	ZHash          int               `bson:"zhash"`
	Zone           int               `bson:"zone"`
}
type mongoAttributesSparseActivity struct {
	ID             bson.ObjectId      `bson:"_id,omitempty"`
	Claims         *interface{}       `bson:"claims,omitempty"`
	Data           *interface{}       `bson:"data,omitempty"`
	Date           *time.Time         `bson:"date,omitempty"`
	Diff           *string            `bson:"diff,omitempty"`
	Error          *interface{}       `bson:"error,omitempty"`
	Message        *string            `bson:"message,omitempty"`
	MigrationsLog  *map[string]string `bson:"migrationslog,omitempty"`
	Namespace      *string            `bson:"namespace,omitempty"`
	Operation      *string            `bson:"operation,omitempty"`
	OriginalData   *interface{}       `bson:"originaldata,omitempty"`
	Source         *string            `bson:"source,omitempty"`
	TargetIdentity *string            `bson:"targetidentity,omitempty"`
	ZHash          *int               `bson:"zhash,omitempty"`
	Zone           *int               `bson:"zone,omitempty"`
}