Package com.bytedesk.core.document

Class DocumentRestService

java.lang.Object

com.bytedesk.core.base.BaseRestService<T,TRequest,TResponse>

com.bytedesk.core.base.BaseRestServiceWithExport<DocumentEntity,DocumentRequest,DocumentResponse,DocumentExcel>

com.bytedesk.core.document.DocumentRestService

@Service
public class DocumentRestService
extends BaseRestServiceWithExport<DocumentEntity,DocumentRequest,DocumentResponse,DocumentExcel>

Field Summary

Fields

Modifier and Type	Field	Description
private final AuthService	authService
private final DocumentRepository	documentRepository
private final org.modelmapper.ModelMapper	modelMapper
private final PermissionService	permissionService
private final UidUtils	uidUtils

Constructor Summary

Constructors

Constructor	Description
DocumentRestService()

Method Summary

Modifier and Type	Method	Description
DocumentExcel	convertToExcel(DocumentEntity entity)	转换为Excel对象 子类必须实现此方法
DocumentResponse	convertToResponse(DocumentEntity entity)
DocumentResponse	create(DocumentRequest request)
private DocumentResponse	createInternal(DocumentRequest request, boolean skipPermissionCheck)
protected org.springframework.data.jpa.domain.Specification<DocumentEntity>	createSpecification(DocumentRequest request)	创建Specification对象，子类必须实现 用于queryByOrg的通用实现
DocumentResponse	createSystemDocument(DocumentRequest request)
void	delete(DocumentRequest request)
void	deleteByUid(String uid)
protected DocumentEntity	doSave(DocumentEntity entity)	子类实现具体的保存逻辑
protected org.springframework.data.domain.Page<DocumentEntity>	executePageQuery(org.springframework.data.jpa.domain.Specification<DocumentEntity> spec, org.springframework.data.domain.Pageable pageable)	执行分页查询，子类必须实现 用于queryByOrg的通用实现
Boolean	existsByUid(String uid)
Optional<DocumentEntity>	findByNameAndOrgUidAndType(String name, String orgUid, String type)
Optional<DocumentEntity>	findByUid(String uid)
DocumentEntity	handleOptimisticLockingFailureException(org.springframework.orm.ObjectOptimisticLockingFailureException e, DocumentEntity entity)
void	initDocuments(String orgUid)
org.springframework.data.domain.Page<DocumentResponse>	queryByOrg(DocumentRequest request)	通用的queryByOrg实现 子类如果有特殊逻辑可以重写此方法
org.springframework.data.domain.Page<DocumentEntity>	queryByOrgEntity(DocumentRequest request)	查询实体对象（用于Excel导出） 子类必须实现此方法
org.springframework.data.domain.Page<DocumentResponse>	queryByUser(DocumentRequest request)	通用的queryByUser实现 子类如果有特殊逻辑可以重写此方法
DocumentResponse	update(DocumentRequest request)

Methods inherited from class com.bytedesk.core.base.BaseRestService

deleteByOrgUid, findByOrgUid, getUidFromRequest, queryByUid, recover, save, setUserUidToRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

documentRepository

private final DocumentRepository documentRepository

modelMapper

private final org.modelmapper.ModelMapper modelMapper

uidUtils

private final UidUtils uidUtils

authService

private final AuthService authService

permissionService

private final PermissionService permissionService

Constructor Details

DocumentRestService

public DocumentRestService()

Method Details

queryByOrgEntity

public org.springframework.data.domain.Page<DocumentEntity> queryByOrgEntity(DocumentRequest request)

Description copied from class: BaseRestServiceWithExport

查询实体对象（用于Excel导出） 子类必须实现此方法

Overrides:

queryByOrgEntity in class BaseRestServiceWithExport<DocumentEntity,DocumentRequest,DocumentResponse,DocumentExcel>

queryByOrg

public org.springframework.data.domain.Page<DocumentResponse> queryByOrg(DocumentRequest request)

Description copied from class: BaseRestService

通用的queryByOrg实现 子类如果有特殊逻辑可以重写此方法

Overrides:

queryByOrg in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

queryByUser

public org.springframework.data.domain.Page<DocumentResponse> queryByUser(DocumentRequest request)

Description copied from class: BaseRestService

通用的queryByUser实现 子类如果有特殊逻辑可以重写此方法

Overrides:

queryByUser in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

findByUid

@Cacheable(value="document",
           key="#uid",
           unless="#result==null")
public Optional<DocumentEntity> findByUid(String uid)

Specified by:

findByUid in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

findByNameAndOrgUidAndType

@Cacheable(value="document",
           key="#name + \'_\' + #orgUid + \'_\' + #type",
           unless="#result==null")
public Optional<DocumentEntity> findByNameAndOrgUidAndType(String name,
 String orgUid,
 String type)

existsByUid

public Boolean existsByUid(String uid)

create

@Transactional
public DocumentResponse create(DocumentRequest request)

Specified by:

create in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

createSystemDocument

@Transactional
public DocumentResponse createSystemDocument(DocumentRequest request)

createInternal

private DocumentResponse createInternal(DocumentRequest request,
 boolean skipPermissionCheck)

update

@Transactional
public DocumentResponse update(DocumentRequest request)

Specified by:

update in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

doSave

protected DocumentEntity doSave(DocumentEntity entity)

Description copied from class: BaseRestService

子类实现具体的保存逻辑

Specified by:

doSave in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

handleOptimisticLockingFailureException

public DocumentEntity handleOptimisticLockingFailureException(org.springframework.orm.ObjectOptimisticLockingFailureException e,
 DocumentEntity entity)

Specified by:

handleOptimisticLockingFailureException in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

deleteByUid

@Transactional
public void deleteByUid(String uid)

Specified by:

deleteByUid in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

delete

public void delete(DocumentRequest request)

Specified by:

delete in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

convertToResponse

public DocumentResponse convertToResponse(DocumentEntity entity)

Specified by:

convertToResponse in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

convertToExcel

public DocumentExcel convertToExcel(DocumentEntity entity)

Description copied from class: BaseRestServiceWithExport

转换为Excel对象 子类必须实现此方法

Specified by:

convertToExcel in class BaseRestServiceWithExport<DocumentEntity,DocumentRequest,DocumentResponse,DocumentExcel>

createSpecification

protected org.springframework.data.jpa.domain.Specification<DocumentEntity> createSpecification(DocumentRequest request)

Description copied from class: BaseRestService

创建Specification对象，子类必须实现 用于queryByOrg的通用实现

Specified by:

createSpecification in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

executePageQuery

protected org.springframework.data.domain.Page<DocumentEntity> executePageQuery(org.springframework.data.jpa.domain.Specification<DocumentEntity> spec,
 org.springframework.data.domain.Pageable pageable)

Description copied from class: BaseRestService

执行分页查询，子类必须实现 用于queryByOrg的通用实现

Specified by:

executePageQuery in class BaseRestService<DocumentEntity,DocumentRequest,DocumentResponse>

initDocuments

public void initDocuments(String orgUid)