coordinate

Documentation

Overview

Package coordinate contains API handlers and associated logic for servicing the `/coordinates` API endpoint.

Index

• func Create(w http.ResponseWriter, r *http.Request)
• func Delete(w http.ResponseWriter, r *http.Request)
• func IsValidCoordinateName(str string) bool
• func Read(w http.ResponseWriter, r *http.Request)
• func Update(w http.ResponseWriter, r *http.Request)
• type TOCoordinate
  • func (coord *TOCoordinate) Create() (error, error, int)
  • func (coord *TOCoordinate) Delete() (error, error, int)
  • func (*TOCoordinate) DeleteQuery() string
  • func (coordinate TOCoordinate) GetAuditName() string
  • func (coordinate TOCoordinate) GetKeyFieldsInfo() []api.KeyFieldInfo
  • func (coordinate TOCoordinate) GetKeys() (map[string]interface{}, bool)
  • func (coordinate *TOCoordinate) GetLastUpdated() (*time.Time, bool, error)
  • func (coordinate TOCoordinate) GetType() string
  • func (*TOCoordinate) InsertQuery() string
  • func (*TOCoordinate) NewReadObj() interface{}
  • func (*TOCoordinate) ParamColumns() map[string]dbhelpers.WhereColumnInfo
  • func (coord *TOCoordinate) Read(h http.Header, useIMS bool) ([]interface{}, error, error, int, *time.Time)
  • func (*TOCoordinate) SelectMaxLastUpdatedQuery(where, orderBy, pagination, _ string) string
  • func (*TOCoordinate) SelectQuery() string
  • func (coordinate *TOCoordinate) SetKeys(keys map[string]interface{})
  • func (coordinate *TOCoordinate) SetLastUpdated(t tc.TimeNoMod)
  • func (coord *TOCoordinate) Update(h http.Header) (error, error, int)
  • func (*TOCoordinate) UpdateQuery() string
  • func (coordinate TOCoordinate) Validate() (error, error)

Functions

func Create

func Create(w http.ResponseWriter, r *http.Request)

Create is the handler for POST requests made to the /coordinates API (in APIv5 and later).

func Delete

func Delete(w http.ResponseWriter, r *http.Request)

Delete is the handler for PUT requests made to the /coordinates API (in API v5 and later).

func IsValidCoordinateName

func IsValidCoordinateName(str string) bool

IsValidCoordinateName returns true if the name contains only characters valid for a Coordinate name. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func Read

func Read(w http.ResponseWriter, r *http.Request)

Read is the handler for GET requests made to the /coordinates API (in APIv5 and later).

func Update

func Update(w http.ResponseWriter, r *http.Request)

Update is the handler for PUT requests made to the /coordinates API (in API v5 and later).

Types

type TOCoordinate

type TOCoordinate struct {
	api.APIInfoImpl `json:"-"`
	tc.CoordinateNullable
}

TOCoordinate is a "CRUDer"-based API wrapper for Coordinate objects. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (*TOCoordinate) Create

func (coord *TOCoordinate) Create() (error, error, int)

Create implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" Create function.

func (*TOCoordinate) Delete

func (coord *TOCoordinate) Delete() (error, error, int)

Delete implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (*TOCoordinate) DeleteQuery

func (*TOCoordinate) DeleteQuery() string

DeleteQuery implements a "CRUD"er interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (TOCoordinate) GetAuditName

func (coordinate TOCoordinate) GetAuditName() string

GetAuditName implements a "CRUD"er interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (TOCoordinate) GetKeyFieldsInfo

func (coordinate TOCoordinate) GetKeyFieldsInfo() []api.KeyFieldInfo

GetKeyFieldsInfo implements a "CRUD"er interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (TOCoordinate) GetKeys

func (coordinate TOCoordinate) GetKeys() (map[string]interface{}, bool)

GetKeys implements the Identifier and Validator interfaces. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (*TOCoordinate) GetLastUpdated

func (coordinate *TOCoordinate) GetLastUpdated() (*time.Time, bool, error)

GetLastUpdated implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (TOCoordinate) GetType

func (coordinate TOCoordinate) GetType() string

GetType implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (*TOCoordinate) InsertQuery

func (*TOCoordinate) InsertQuery() string

InsertQuery implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (*TOCoordinate) NewReadObj

func (*TOCoordinate) NewReadObj() interface{}

NewReadObj implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (*TOCoordinate) ParamColumns

func (*TOCoordinate) ParamColumns() map[string]dbhelpers.WhereColumnInfo

ParamColumns implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (*TOCoordinate) Read

func (coord *TOCoordinate) Read(h http.Header, useIMS bool) ([]interface{}, error, error, int, *time.Time)

Read implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" Read function.

func (*TOCoordinate) SelectMaxLastUpdatedQuery

func (*TOCoordinate) SelectMaxLastUpdatedQuery(where, orderBy, pagination, _ string) string

SelectMaxLastUpdatedQuery implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (*TOCoordinate) SelectQuery

func (*TOCoordinate) SelectQuery() string

SelectQuery implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (*TOCoordinate) SetKeys

func (coordinate *TOCoordinate) SetKeys(keys map[string]interface{})

SetKeys implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (*TOCoordinate) SetLastUpdated

func (coordinate *TOCoordinate) SetLastUpdated(t tc.TimeNoMod)

SetLastUpdated implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (*TOCoordinate) Update

func (coord *TOCoordinate) Update(h http.Header) (error, error, int)

Update implements a "CRUDer" interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" Update function.

func (*TOCoordinate) UpdateQuery

func (*TOCoordinate) UpdateQuery() string

UpdateQuery implements a "CRUD"er interface. Deprecated: All future Coordinate versions should use the non-"CRUDer" methodology.

func (TOCoordinate) Validate

func (coordinate TOCoordinate) Validate() (error, error)

Validate fulfills the api.Validator interface. Deprecated: All future Coordinate versions should use non-"CRUDer" validation.