Package com.logicaldoc.core.metadata
Interface TemplateDAO
- All Superinterfaces:
PersistentObjectDAO<Template>
- All Known Implementing Classes:
HibernateTemplateDAO
This class is a DAO-service for document templates.
- Version:
- 1.0
- Author:
- Marco Meschieri - LogicalDOC
-
Field Summary
Fields inherited from interface com.logicaldoc.core.PersistentObjectDAO
ENTITY
-
Method Summary
Modifier and TypeMethodDescriptionCreates a clone of an existing templateint
countDocs
(long id) Counts the total number of documents using this templatefindByName
(String name, long tenantId) This method finds a template by namefindByType
(int type, long tenantId) This method finds a template by typegetEnabledPermissions
(long templateId, long userId) Finds all permissions of a user enabled on the specified templatevoid
initialize
(Template template) Initialises lazy loaded data such as collectionsboolean
isReadEnable
(long templateId, long userId) This method is looking up for read rights for a template and an userboolean
isWriteEnable
(long templateId, long userId) Returns if a template is writable for a userMethods inherited from interface com.logicaldoc.core.PersistentObjectDAO
bulkUpdate, delete, delete, deleteAll, deleteAll, findAll, findAll, findAllIds, findAllIds, findById, findById, findByObjectQuery, findByQuery, findByWhere, findByWhere, findIdsByWhere, findIdsByWhere, getDatabaseMetadata, getDbms, isOracle, jdbcUpdate, jdbcUpdate, query, query, queryForDouble, queryForDouble, queryForInt, queryForList, queryForList, queryForList, queryForLong, queryForLong, queryForObject, queryForRowSet, queryForRowSet, queryForString, store
-
Method Details
-
findByName
This method finds a template by name- Parameters:
name
- Name of the templatetenantId
- ID of the owning tenant- Returns:
- Template with given name
- Throws:
PersistenceException
- Error in the data layer
-
clone
Creates a clone of an existing template- Parameters:
id
- Identifier of the original templatecloneName
- Name of the cloned template- Returns:
- the created clone
- Throws:
PersistenceException
- Error in the data layer
-
countDocs
Counts the total number of documents using this template- Parameters:
id
- The template ID- Returns:
- the documents count
- Throws:
PersistenceException
- Error in the data layer
-
findByType
This method finds a template by type- Parameters:
type
- Type of the templatetenantId
- ID of the owning tenant- Returns:
- Template with given type
- Throws:
PersistenceException
- Error in the data layer
-
getEnabledPermissions
Finds all permissions of a user enabled on the specified template- Parameters:
templateId
- ID of the templateuserId
- ID of the user- Returns:
- Collection of enabled permissions
-
isWriteEnable
boolean isWriteEnable(long templateId, long userId) Returns if a template is writable for a user- Parameters:
templateId
- check this templateuserId
- privileges for this should be checked- Returns:
- if the user can edit the template
-
isReadEnable
boolean isReadEnable(long templateId, long userId) This method is looking up for read rights for a template and an user- Parameters:
templateId
- ID of the templateuserId
- ID of the user- Returns:
- if the user can access the template
-
initialize
Description copied from interface:PersistentObjectDAO
Initialises lazy loaded data such as collections- Specified by:
initialize
in interfacePersistentObjectDAO<Template>
- Parameters:
template
- The entity to be initialised
-