model

type Index struct {
	// Name of the Index.
	Name string
	// FieldName is the name of the field this constraint applies on.
	// This is used for annotating errors.
	// Use JSON path notation (foo.bar.baz) for nested fields.
	FieldName string
	// Type is the type of the Index.
	Type TypeIndex
	// ForeignType denotes the type of the foreign object.
	// This must be populated for IndexForeign and otherwise must be empty.
	ForeignType Type
	// Value is the value of the field for this Index.
	Value string
}

type Object interface {
	ID() string
	Type() Type
	Resource() Resource
	Validate(ctx context.Context) error
	Indexes() []Index
	ProcessDefaults(ctx context.Context) error

	// SetResource replaces the object's underlining resource with the provided resource.
	SetResource(Resource) error
}

type ObjectList interface {
	Type() Type
	Add(Object)
	GetAll() []Object
	// GetTotalCount returns the count of objects in the underlying store across all pages.
	GetTotalCount() int
	SetTotalCount(count int)
	SetNextPage(pageNum int)
	GetNextPage() int
}

type ObjectWithResourceDTO interface {
	// MarshalResourceJSON is just like json.Marshaler, but specifically
	// for marshalling the resource for use in the persistence store.
	MarshalResourceJSON() ([]byte, error)

	// UnmarshalResourceJSON is just like json.Unmarshaler, but specifically for unmarshalling
	// a resource's JSON representation outputted by MarshalResourceJSON().
	UnmarshalResourceJSON([]byte) error
}

type Registry interface{}

type Resource interface {
	proto.Message
}

type Type string

type TypeIndex string