metadata

type Action interface {

	// Description sets description for action
	Description(string) Action

	// GetDescription returns description
	GetDescription() string

	// Field adds or retrieves fields (recursively)
	Field(...string) Field

	// HasField returns whether field is set
	HasField(names ...string) bool

	// GetFieldNames returns names of all fields
	GetFieldNames() []string

	// From inspects given value and makes appropriate steps
	From(v interface{}) Action

	// GetData returns dynamic data (for json etc..)
	GetData() map[string]interface{}

	// MarshalJSON satisfies json marshaller
	MarshalJSON() ([]byte, error)

	// Debug enables debugging
	Debug() Action

	// ParseQueryParam parses
	ParseQueryParam(query string) Action

	// QueryParam returns or adds new query param
	QueryParam(name string) Field

	// RemoveQueryParam removes query param
	RemoveQueryParam(name string) Action

	// GetQueryParamNames returns names of all available query params
	GetQueryParamNames() []string
	// contains filtered or unexported methods
}

type Choice struct {
	Value   interface{} `json:"value"`
	Display string      `json:"display"`
}

type Choices interface {
	// Add adds new choice
	Add(value interface{}, display string) Choices

	// returns choices count
	Count() int

	// Support for marshalling
	MarshalJSON() ([]byte, error)
}

type Field interface {

	// Field method returns field by names (recursively)
	Field(...string) Field

	// returns whether Field has field with given name
	HasField(...string) bool

	// return whether we have fields
	NumFields() int

	// GetFieldNames returns list of fields
	GetFieldNames() []string

	// Description sets help text for given field
	Description(string) Field

	// GetDescription is getter for HelpText
	GetDescription() string

	// Label sets label of field
	Label(string) Field

	// GetLabel is getter for Label
	GetLabel() string

	// RemoveField removes field from fields
	RemoveField(string) (self Field)

	// set required flag to field
	Required(bool) (self Field)

	// returns whether field is required
	IsRequired() bool

	// type is type of field
	Type(string) Field

	// GetType returns field type
	GetType() string

	// From reads target and sets data to field
	From(interface{}) Field

	// Data returns data representation in dynamic fashion (interface{})
	GetData() map[string]interface{}

	// MarshalJSON satisfies json marshaller
	MarshalJSON() ([]byte, error)

	// Choices returns choices
	Choices() Choices

	// Source
	Source(path string) Source

	// Debug enables debugging for metadata
	Debug() Field
	// contains filtered or unexported methods
}

type FieldTypeFunc func(reflect.Type) Field

type Metadata interface {
	// action returns either existing or newly created action
	Action(method string) Action

	// RemoveAction removes action
	RemoveAction(method string) Metadata

	// Name sets name to metadata
	Name(string) Metadata

	// GetName returns name of metadata
	GetName() string

	// Description sets description of metadata
	Description(string) Metadata

	// GetDescription returns description
	GetDescription() string

	// GetData returns dynamic data (for json etc..)
	GetData() map[string]interface{}

	// MarshalJSON satisfies json marshaller
	MarshalJSON() ([]byte, error)

	// Debug enables debugging for metadata
	Debug() Metadata
	// contains filtered or unexported methods
}

type Source interface {

	// Debug sets debug to source
	Debug() Source

	// Action sets action
	Action(action Action) Source

	// GetAction Returns action
	GetAction() Action

	// ResultField points to resultField
	Result(field ...string) Source

	// IsValid returns whether source is setup correct
	IsValid() bool

	// Value sets value field name
	Value(value string) Source

	// GetValue returns value field name
	GetValue() string

	// Display sets display field name
	Display(display string) Source

	// GetDisplay returns display field name
	GetDisplay() string

	// Path sets path to source
	Path(string) Source

	// GetPath returns path set for this source
	GetPath() string

	// Return data
	GetData() map[string]interface{}

	// MarshalJSON satisfies json marshal interface
	MarshalJSON() ([]byte, error)
	// contains filtered or unexported methods
}