apitenant

Documentation

Index

• type TOTenant
  • func (ten *TOTenant) Create() (error, error, int)
  • func (ten *TOTenant) Delete() (error, error, int)
  • func (ten TOTenant) GetAuditName() string
  • func (ten TOTenant) GetID() (int, bool)
  • func (ten TOTenant) GetKeyFieldsInfo() []api.KeyFieldInfo
  • func (ten TOTenant) GetKeys() (map[string]interface{}, bool)
  • func (ten *TOTenant) GetLastUpdated() (*time.Time, bool, error)
  • func (ten TOTenant) GetType() string
  • func (ten *TOTenant) InsertQuery() string
  • func (ten *TOTenant) IsTenantAuthorized(user *auth.CurrentUser) (bool, error)
  • func (ten *TOTenant) NewReadObj() interface{}
  • func (ten *TOTenant) ParamColumns() map[string]dbhelpers.WhereColumnInfo
  • func (ten *TOTenant) Read(h http.Header, useIMS bool) ([]interface{}, error, error, int, *time.Time)
  • func (ten *TOTenant) SelectMaxLastUpdatedQuery(where, orderBy, pagination, tableName string) string
  • func (ten *TOTenant) SelectQuery() string
  • func (ten *TOTenant) SetKeys(keys map[string]interface{})
  • func (ten *TOTenant) SetLastUpdated(t tc.TimeNoMod)
  • func (ten *TOTenant) Update(h http.Header) (error, error, int)
  • func (ten *TOTenant) UpdateQuery() string
  • func (ten TOTenant) Validate() error

Types

type TOTenant

type TOTenant struct {
	api.APIInfoImpl `json:"-"`
	tc.TenantNullable
}

TOTenant provides a local type against which to define methods

func (*TOTenant) Create

func (ten *TOTenant) Create() (error, error, int)

func (*TOTenant) Delete

func (ten *TOTenant) Delete() (error, error, int)

func (TOTenant) GetAuditName

func (ten TOTenant) GetAuditName() string

GetAuditName returns a unique identifier Part of the Identifier interface

func (TOTenant) GetID

func (ten TOTenant) GetID() (int, bool)

GetID wraps the ID member with null checking Part of the Identifier interface

func (TOTenant) GetKeyFieldsInfo

func (ten TOTenant) GetKeyFieldsInfo() []api.KeyFieldInfo

GetKeyFieldsInfo identifies types of the key fields

func (TOTenant) GetKeys

func (ten TOTenant) GetKeys() (map[string]interface{}, bool)

GetKeys returns values of keys

func (*TOTenant) GetLastUpdated

func (ten *TOTenant) GetLastUpdated() (*time.Time, bool, error)

func (TOTenant) GetType

func (ten TOTenant) GetType() string

GetType returns the name of the type for messages Part of the Identifier interface

func (*TOTenant) InsertQuery

func (ten *TOTenant) InsertQuery() string

func (*TOTenant) IsTenantAuthorized

func (ten *TOTenant) IsTenantAuthorized(user *auth.CurrentUser) (bool, error)

IsTenantAuthorized implements the Tenantable interface for TOTenant returns true if the user has access on this tenant and on the ParentID if changed.

func (*TOTenant) NewReadObj

func (ten *TOTenant) NewReadObj() interface{}

func (*TOTenant) ParamColumns

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

func (*TOTenant) Read

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

func (*TOTenant) SelectMaxLastUpdatedQuery

func (ten *TOTenant) SelectMaxLastUpdatedQuery(where, orderBy, pagination, tableName string) string

func (*TOTenant) SelectQuery

func (ten *TOTenant) SelectQuery() string

func (*TOTenant) SetKeys

func (ten *TOTenant) SetKeys(keys map[string]interface{})

SetKeys allows CreateHandler to assign id once object is created. Part of the Identifier interface

func (*TOTenant) SetLastUpdated

func (ten *TOTenant) SetLastUpdated(t tc.TimeNoMod)

func (*TOTenant) Update

func (ten *TOTenant) Update(h http.Header) (error, error, int)

Update wraps tenant validation and the generic API Update call into a single call.

func (*TOTenant) UpdateQuery

func (ten *TOTenant) UpdateQuery() string

func (TOTenant) Validate

func (ten TOTenant) Validate() error

Validate fulfills the api.Validator interface