service

Documentation

Index

• type AnnotationService
  • func NewAnnotationService(srvP *Params) (*AnnotationService, error)
  • func (s *AnnotationService) AddToAnnotationGroup(ctx context.Context, rta *annotation.AnnotationGroupId) (*annotation.TaggedAnnotationGroup, error)
  • func (s *AnnotationService) CreateAnnotation(ctx context.Context, rta *annotation.NewTaggedAnnotation) (*annotation.TaggedAnnotation, error)
  • func (s *AnnotationService) CreateAnnotationGroup(ctx context.Context, rta *annotation.AnnotationIdList) (*annotation.TaggedAnnotationGroup, error)
  • func (s *AnnotationService) DeleteAnnotation(ctx context.Context, r *annotation.DeleteAnnotationRequest) (*empty.Empty, error)
  • func (s *AnnotationService) DeleteAnnotationGroup(ctx context.Context, r *annotation.GroupEntryId) (*empty.Empty, error)
  • func (srv *AnnotationService) GetAnnotation(ctx context.Context, req *annotation.AnnotationId) (*annotation.TaggedAnnotation, error)
  • func (srv *AnnotationService) GetAnnotationGroup(ctx context.Context, rid *annotation.GroupEntryId) (*annotation.TaggedAnnotationGroup, error)
  • func (srv *AnnotationService) GetAnnotationTag(ctx context.Context, rta *annotation.TagRequest) (*annotation.AnnotationTag, error)
  • func (srv *AnnotationService) GetEntryAnnotation(ctx context.Context, rea *annotation.EntryAnnotationRequest) (*annotation.TaggedAnnotation, error)
  • func (s *AnnotationService) GetGroupResourceName() string
  • func (srv *AnnotationService) ListAnnotationGroups(ctx context.Context, rgp *annotation.ListGroupParameters) (*annotation.TaggedAnnotationGroupCollection, error)
  • func (srv *AnnotationService) ListAnnotations(ctx context.Context, ral *annotation.ListParameters) (*annotation.TaggedAnnotationCollection, error)
  • func (s *AnnotationService) OboJSONFileUpload(stream annotation.TaggedAnnotationService_OboJSONFileUploadServer) error
  • func (s *AnnotationService) UpdateAnnotation(ctx context.Context, rta *annotation.TaggedAnnotationUpdate) (*annotation.TaggedAnnotation, error)
• type Params
• type Validatable

Types

type AnnotationService

type AnnotationService struct {
	*aphgrpc.Service

	annotation.UnimplementedTaggedAnnotationServiceServer
	// contains filtered or unexported fields
}

AnnotationService is the container for managing annotation service definition.

func NewAnnotationService

func NewAnnotationService(srvP *Params) (*AnnotationService, error)

NewAnnotationService is the constructor for creating a new instance of AnnotationService.

func (*AnnotationService) AddToAnnotationGroup

func (s *AnnotationService) AddToAnnotationGroup(
	ctx context.Context, rta *annotation.AnnotationGroupId,
) (*annotation.TaggedAnnotationGroup, error)

func (*AnnotationService) CreateAnnotation

func (s *AnnotationService) CreateAnnotation(
	ctx context.Context,
	rta *annotation.NewTaggedAnnotation,
) (*annotation.TaggedAnnotation, error)

func (*AnnotationService) CreateAnnotationGroup

func (s *AnnotationService) CreateAnnotationGroup(
	ctx context.Context, rta *annotation.AnnotationIdList,
) (*annotation.TaggedAnnotationGroup, error)

func (*AnnotationService) DeleteAnnotation

func (s *AnnotationService) DeleteAnnotation(ctx context.Context, r *annotation.DeleteAnnotationRequest) (*empty.Empty, error)

func (*AnnotationService) DeleteAnnotationGroup

func (s *AnnotationService) DeleteAnnotationGroup(ctx context.Context, r *annotation.GroupEntryId) (*empty.Empty, error)

func (*AnnotationService) GetAnnotation

func (srv *AnnotationService) GetAnnotation(
	ctx context.Context,
	req *annotation.AnnotationId,
) (*annotation.TaggedAnnotation, error)

func (*AnnotationService) GetAnnotationGroup

func (srv *AnnotationService) GetAnnotationGroup(
	ctx context.Context, rid *annotation.GroupEntryId,
) (*annotation.TaggedAnnotationGroup, error)

func (*AnnotationService) GetAnnotationTag

func (srv *AnnotationService) GetAnnotationTag(
	ctx context.Context, rta *annotation.TagRequest,
) (*annotation.AnnotationTag, error)

func (*AnnotationService) GetEntryAnnotation

func (srv *AnnotationService) GetEntryAnnotation(
	ctx context.Context, rea *annotation.EntryAnnotationRequest,
) (*annotation.TaggedAnnotation, error)

func (*AnnotationService) GetGroupResourceName

func (s *AnnotationService) GetGroupResourceName() string

func (*AnnotationService) ListAnnotationGroups

func (srv *AnnotationService) ListAnnotationGroups(
	ctx context.Context, rgp *annotation.ListGroupParameters,
) (*annotation.TaggedAnnotationGroupCollection, error)

func (*AnnotationService) ListAnnotations

func (srv *AnnotationService) ListAnnotations(
	ctx context.Context, ral *annotation.ListParameters,
) (*annotation.TaggedAnnotationCollection, error)

func (*AnnotationService) OboJSONFileUpload

func (s *AnnotationService) OboJSONFileUpload(stream annotation.TaggedAnnotationService_OboJSONFileUploadServer) error

OboJSONFileUpload uploads a obojson formatted file to the server.

func (*AnnotationService) UpdateAnnotation

func (s *AnnotationService) UpdateAnnotation(
	ctx context.Context,
	rta *annotation.TaggedAnnotationUpdate,
) (*annotation.TaggedAnnotation, error)

type Params

type Params struct {
	Repository repository.TaggedAnnotationRepository `validate:"required"`
	Publisher  message.Publisher                     `validate:"required"`
	Options    []aphgrpc.Option                      `validate:"required"`
	Group      string                                `validate:"required"`
}

ServiceParams are the attributes that are required for creating new AnnotationService.

type Validatable

type Validatable interface {
	Validate() error
}