Interface ITemplateService

Defines the contract for template management operations in the OEMS system.

Namespace: OEMS.Core.Application.ApplicationServiceInterfaces

Assembly: OEMS.Core.dll

Syntax

public interface ITemplateService

Methods

CreateEmailTemplateAsync(Guid, CreateEmailTemplateDto)

Creates a new email template.

Declaration

Task<Guid> CreateEmailTemplateAsync(Guid userId, CreateEmailTemplateDto dto)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user creating the template.
CreateEmailTemplateDto	dto	The email template creation data transfer object.

Returns

Type	Description
Task<Guid>	A task that represents the asynchronous operation. The task result contains the newly created template's identifier.

CreateEventTemplateAsync(Guid, Guid, CreateEventTemplateDto)

Creates a new event template.

Declaration

Task<Guid> CreateEventTemplateAsync(Guid userId, Guid organizationId, CreateEventTemplateDto dto)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user creating the template.
Guid	organizationId	The unique identifier of the organization.
CreateEventTemplateDto	dto	The event template creation data transfer object.

Returns

Type	Description
Task<Guid>	A task that represents the asynchronous operation. The task result contains the newly created template's identifier.

CreateProcessStepTemplateAsync(Guid, CreateProcessStepTemplateDto)

Creates a new process step template.

Declaration

Task<Guid> CreateProcessStepTemplateAsync(Guid userId, CreateProcessStepTemplateDto dto)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user creating the template.
CreateProcessStepTemplateDto	dto	The process step template creation data transfer object.

Returns

Type	Description
Task<Guid>	A task that represents the asynchronous operation. The task result contains the newly created template's identifier.

CreateProcessTemplateAsync(Guid, CreateProcessTemplateDto)

Creates a new process template.

Declaration

Task<Guid> CreateProcessTemplateAsync(Guid userId, CreateProcessTemplateDto dto)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user creating the template.
CreateProcessTemplateDto	dto	The process template creation data transfer object.

Returns

Type	Description
Task<Guid>	A task that represents the asynchronous operation. The task result contains the newly created template's identifier.

DeleteEmailTemplateAsync(Guid, Guid)

Deletes an email template.

Declaration

Task DeleteEmailTemplateAsync(Guid userId, Guid id)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user deleting the template.
Guid	id	The unique identifier of the template to delete.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

DeleteProcessStepTemplateAsync(Guid, Guid)

Deletes a process step template.

Declaration

Task DeleteProcessStepTemplateAsync(Guid userId, Guid id)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user deleting the template.
Guid	id	The unique identifier of the template to delete.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

DeleteProcessTemplateAsync(Guid, Guid)

Deletes a process template.

Declaration

Task DeleteProcessTemplateAsync(Guid userId, Guid id)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user deleting the template.
Guid	id	The unique identifier of the template to delete.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

DeleteTemplateAsync(Guid)

Deletes an event template.

Declaration

Task DeleteTemplateAsync(Guid templateId)

Parameters

Type	Name	Description
Guid	templateId	The unique identifier of the template to delete.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

GetAllEmailTemplatesByOrganizationAsync(Guid)

Retrieves all email templates for a specific organization.

Declaration

Task<IEnumerable<EmailTemplateDto>> GetAllEmailTemplatesByOrganizationAsync(Guid organizationId)

Parameters

Type	Name	Description
Guid	organizationId	The unique identifier of the organization.

Returns

Type	Description
Task<IEnumerable<EmailTemplateDto>>	A task that represents the asynchronous operation. The task result contains a collection of email template data transfer objects.

GetAllProcessStepTemplatesByOrganizationAsync(Guid)

Retrieves all process step templates for a specific organization.

Declaration

Task<IEnumerable<ProcessStepTemplateDto>> GetAllProcessStepTemplatesByOrganizationAsync(Guid organizationId)

Parameters

Type	Name	Description
Guid	organizationId	The unique identifier of the organization.

Returns

Type	Description
Task<IEnumerable<ProcessStepTemplateDto>>	A task that represents the asynchronous operation. The task result contains a collection of process step template data transfer objects.

GetAllProcessTemplatesByOrganizationAsync(Guid)

Retrieves all process templates for a specific organization.

Declaration

Task<IEnumerable<ProcessTemplateDto>> GetAllProcessTemplatesByOrganizationAsync(Guid organizationId)

Parameters

Type	Name	Description
Guid	organizationId	The unique identifier of the organization.

Returns

Type	Description
Task<IEnumerable<ProcessTemplateDto>>	A task that represents the asynchronous operation. The task result contains a collection of process template data transfer objects.

GetEmailTemplatesAsync(Guid, Guid)

Retrieves email templates accessible to a user within an organization.

Declaration

Task<IEnumerable<EmailTemplateDto>> GetEmailTemplatesAsync(Guid userId, Guid organizationId)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user.
Guid	organizationId	The unique identifier of the organization.

Returns

Type	Description
Task<IEnumerable<EmailTemplateDto>>	A task that represents the asynchronous operation. The task result contains a collection of email template data transfer objects.

GetEventTemplatesAsync(Guid, Guid)

Retrieves event templates accessible to a user within an organization.

Declaration

Task<IEnumerable<EventTemplateDto>> GetEventTemplatesAsync(Guid userId, Guid organizationId)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user.
Guid	organizationId	The unique identifier of the organization.

Returns

Type	Description
Task<IEnumerable<EventTemplateDto>>	A task that represents the asynchronous operation. The task result contains a collection of event template data transfer objects.

GetEventTemplatesByOrganizationAsync(Guid)

Retrieves all event templates for a specific organization.

Declaration

Task<List<EventTemplateDto>> GetEventTemplatesByOrganizationAsync(Guid organizationId)

Parameters

Type	Name	Description
Guid	organizationId	The unique identifier of the organization.

Returns

Type	Description
Task<List<EventTemplateDto>>	A task that represents the asynchronous operation. The task result contains a list of event template data transfer objects.

GetOrganizationsForUserAsync(Guid)

Retrieves all organization identifiers that a user has access to.

Declaration

Task<List<Guid>> GetOrganizationsForUserAsync(Guid userId)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user.

Returns

Type	Description
Task<List<Guid>>	A task that represents the asynchronous operation. The task result contains a list of organization identifiers.

GetProcessStepTemplateByIdAsync(Guid, Guid)

Retrieves a specific process step template by its identifier.

Declaration

Task<ProcessStepTemplateDto> GetProcessStepTemplateByIdAsync(Guid userId, Guid id)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user requesting the template.
Guid	id	The unique identifier of the process step template.

Returns

Type	Description
Task<ProcessStepTemplateDto>	A task that represents the asynchronous operation. The task result contains the process step template data transfer object.

GetProcessStepTemplatesByProcessTemplateIdAsync(Guid, Guid)

Retrieves all process step templates for a specific process template.

Declaration

Task<IEnumerable<ProcessStepTemplateDto>> GetProcessStepTemplatesByProcessTemplateIdAsync(Guid userId, Guid processTemplateId)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user requesting the templates.
Guid	processTemplateId	The unique identifier of the process template.

Returns

Type	Description
Task<IEnumerable<ProcessStepTemplateDto>>	A task that represents the asynchronous operation. The task result contains a collection of process step template data transfer objects.

GetProcessTemplateByIdAsync(Guid, Guid)

Retrieves a specific process template by its identifier.

Declaration

Task<ProcessTemplateDto> GetProcessTemplateByIdAsync(Guid userId, Guid id)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user requesting the template.
Guid	id	The unique identifier of the process template.

Returns

Type	Description
Task<ProcessTemplateDto>	A task that represents the asynchronous operation. The task result contains the process template data transfer object.

GetProcessTemplatesAsync(Guid, Guid)

Retrieves process templates accessible to a user within an organization.

Declaration

Task<IEnumerable<ProcessTemplateDto>> GetProcessTemplatesAsync(Guid userId, Guid organizationId)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user.
Guid	organizationId	The unique identifier of the organization.

Returns

Type	Description
Task<IEnumerable<ProcessTemplateDto>>	A task that represents the asynchronous operation. The task result contains a collection of process template data transfer objects.

UpdateEmailTemplateAsync(Guid, UpdateEmailTemplateDto)

Updates an existing email template.

Declaration

Task UpdateEmailTemplateAsync(Guid userId, UpdateEmailTemplateDto dto)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user updating the template.
UpdateEmailTemplateDto	dto	The email template update data transfer object.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

UpdateProcessStepTemplateAsync(Guid, UpdateProcessStepTemplateDto)

Updates an existing process step template.

Declaration

Task UpdateProcessStepTemplateAsync(Guid userId, UpdateProcessStepTemplateDto dto)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user updating the template.
UpdateProcessStepTemplateDto	dto	The process step template update data transfer object.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

UpdateProcessStepTemplateSequenceAsync(Guid, Guid, int)

Updates the sequence order of a process step template.

Declaration

Task UpdateProcessStepTemplateSequenceAsync(Guid userId, Guid id, int newSequence)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user updating the sequence.
Guid	id	The unique identifier of the process step template.
int	newSequence	The new sequence number for the process step.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

UpdateProcessTemplateAsync(Guid, UpdateProcessTemplateDto)

Updates an existing process template.

Declaration

Task UpdateProcessTemplateAsync(Guid userId, UpdateProcessTemplateDto dto)

Parameters

Type	Name	Description
Guid	userId	The unique identifier of the user updating the template.
UpdateProcessTemplateDto	dto	The process template update data transfer object.

Returns

Type	Description
Task	A task that represents the asynchronous operation.

UpdateTemplateAsync(Guid, UpdateEventTemplateDto)

Updates an existing event template.

Declaration

Task UpdateTemplateAsync(Guid templateId, UpdateEventTemplateDto dto)

Parameters

Type	Name	Description
Guid	templateId	The unique identifier of the template to update.
UpdateEventTemplateDto	dto	The event template update data transfer object.

Returns

Type	Description
Task	A task that represents the asynchronous operation.