IPrintTemplateService
Defines the Vendr Print Template service
public interface IPrintTemplateService : ICachedEntityService<PrintTemplateReadOnly>, IServiceInheritance
- interface ICachedEntityService<TEntityType>
- interface IService
Namespace
Methods
DeletePrintTemplate (1 of 2)
Deletes a PrintTemplate
public void DeletePrintTemplate(Guid id)Parameters
| Parameter | Description |
|---|---|
id |
The ID of the PrintTemplate to delete |
DeletePrintTemplate (2 of 2)
Deletes a PrintTemplate
public void DeletePrintTemplate(PrintTemplate entity)Parameters
| Parameter | Description |
|---|---|
entity |
The PrintTemplate to delete |
GetPrintTemplate (1 of 2)
Get a PrintTemplateReadOnly entity by ID
public PrintTemplateReadOnly GetPrintTemplate(Guid id)Parameters
| Parameter | Description |
|---|---|
id |
The ID of the PrintTemplateReadOnly entity to fetch |
Returns
A PrintTemplateReadOnly entity
GetPrintTemplate (2 of 2)
Get a PrintTemplateReadOnly entity by Store and Alias
public PrintTemplateReadOnly GetPrintTemplate(Guid storeId, string alias)Parameters
| Parameter | Description |
|---|---|
storeId |
The ID of the Store the PrintTemplateReadOnly entity belongs to |
alias |
The Alias of the PrintTemplateReadOnly entity to fetch |
Returns
A PrintTemplateReadOnly entity
GetPrintTemplates (1 of 2)
Get a list of all PrintTemplateReadOnly entities from the given Store
public IEnumerable<PrintTemplateReadOnly> GetPrintTemplates(Guid storeId)Parameters
| Parameter | Description |
|---|---|
storeId |
The ID of the Store the PrintTemplateReadOnly entities belong to |
Returns
A list of PrintTemplateReadOnly entities
GetPrintTemplates (2 of 2)
Get a list of PrintTemplateReadOnly entities with the given IDs
public IEnumerable<PrintTemplateReadOnly> GetPrintTemplates(Guid[] ids)Parameters
| Parameter | Description |
|---|---|
ids |
The IDs of the PrintTemplateReadOnly entities to fetch |
Returns
A list of PrintTemplateReadOnly entities
PrintTemplateExists
Check to see if a PrintTemplateReadOnly exists in the given Store with the given Alias
public bool PrintTemplateExists(Guid storeId, string alias)Parameters
| Parameter | Description |
|---|---|
storeId |
The ID of the Store the PrintTemplateReadOnly entity belongs to |
alias |
The Alias of the PrintTemplateReadOnly entity to check |
Returns
Returns true if the PrintTemplateReadOnly exists, otherwise returns false.
SavePrintTemplate
Saves a PrintTemplate
public void SavePrintTemplate(PrintTemplate entity)Parameters
| Parameter | Description |
|---|---|
entity |
The PrintTemplate to save |
SortPrintTemplates
Sorts a list of PrintTemplate entities by ID according to the order of those IDs
public void SortPrintTemplates(Guid[] sortedIds)Parameters
| Parameter | Description |
|---|---|
sortedIds |
The IDs of the PrintTemplate entities to sort, in the order by which to sort them |