Interface B2BDocumentService

All Known Implementing Classes:
DefaultB2BDocumentService

public interface B2BDocumentService
Provides services for B2BDocument business logic/domain
  • Method Details

    • findDocuments

      Finds all B2BDocumentModel filtered by the query. The resulting list only contains document associated to the current user's B2BUnit.
      Parameters:
      query - paged document query
      Returns:
      result : a SeachPageData< B2BDocumentModel > containing documents.
    • getOpenDocuments

      SearchResult<B2BDocumentModel> getOpenDocuments(B2BUnitModel unit)
      Return all open documents for a given B2B Unit.
      Parameters:
      unit - the B2B unit.
      Returns:
      result : a SeachPageData< B2BDocumentModel > containing open documents.
    • getOpenDocuments

      SearchResult<B2BDocumentModel> getOpenDocuments(MediaModel mediaModel)
      Returns all open documents for a given documentMediaModel
      Parameters:
      mediaModel - the media model
      Returns:
      result : a SeachPageData< B2BDocumentModel > containing open documents.
    • deleteB2BDocumentFiles

      void deleteB2BDocumentFiles(int numberOfDays, List<B2BDocumentTypeModel> documentTypes, List<DocumentStatus> documentStatuses)
      Deletes documents based on the supplied criteria.
      Parameters:
      numberOfDays - elapsed days since the document media's creation time
      documentTypes - a list of document types
      documentStatuses - a list of document statuses
    • getPagedDocumentsForUnit

      SearchPageData<B2BDocumentModel> getPagedDocumentsForUnit(String b2bUnitCode, PageableData pageableData, List<DefaultCriteria> criteriaList)
      Returns paged documents for the given unit
      Parameters:
      b2bUnitCode - the unit code
      pageableData - the pageable data
      criteriaList - the list of criteria objects
      Returns:
      result : a SeachPageData< B2BDocumentModel > containing documents from the given unit.
    • getDocumentByIdForUnit

      B2BDocumentModel getDocumentByIdForUnit(String b2bUnitCode, String documentNumber)
      Returns a Document Model for a given unit, document identifier
      Parameters:
      b2bUnitCode - the unit code
      documentNumber - the document identifier
      Returns:
      result : a B2BDocumentModel of the retrieved document