com.jamasoftware.contour.dao
Interface DocumentDao


public interface DocumentDao


Method Summary
 void clearDocumentReferencesForRelease(java.lang.Integer releaseId)
           
 void deactivateDocument(Document document)
           
 void deactivateDocumentById(java.lang.Integer id)
           
 void deleteDocument(Document doc)
           
 void deleteDocumentAttachment(Document_Attachment docAtt)
           
 void deleteDocumentAttachment(Document_DocAttach docAtt)
           
 void deleteDocumentAttachments(java.lang.Integer documentId)
           
 void deleteDocumentDocument(Document_Document documentToDocument)
           
 void deleteDocumentKeyLookup(com.jamasoftware.contour.documentKey.domain.DocumentKeyLookup lookup)
           
 void deleteDocumentURL(Document_URL docUrl)
           
 com.jamasoftware.contour.service.search.SearchResults<Document_DocAttach> getAttachmentDocuments(java.lang.Integer documentId, com.jamasoftware.contour.service.search.PageInfo pageInfo)
           
 Document getDocument(java.lang.Integer documentId)
           
 Document getDocument(java.lang.String documentKey, java.lang.Integer projectId)
           
 boolean getDocumentActiveValue(java.lang.Integer documentId)
           
 Document_Attachment getDocumentAttachment(java.lang.Integer docAttId)
           
 java.util.List<Document_Attachment> getDocumentAttachments(java.lang.Integer documentId)
           
 java.util.List<Document_DocAttach> getDocumentAttachments(java.lang.Integer documentId, java.lang.Integer docAttachmentId)
           
 com.jamasoftware.contour.service.search.SearchResults<Document_DocAttach> getDocumentAttachments(java.lang.Integer documentId, com.jamasoftware.contour.service.search.PageInfo pageInfo, com.jamasoftware.contour.service.search.SorterList sorter)
           
 java.util.List<Document_Attachment> getDocumentAttachmentsFor(java.util.List<Attachment> attachments)
           
 java.util.List<Document> getDocumentByIds(java.util.List<java.lang.Integer> docIds)
           
 Document getDocumentByNameAndGroup(java.lang.String name, java.lang.Integer groupId)
          Deprecated. The document.getDocumentGroup relationship is deprecated, so this service method doesn't make sense to use.
 Document_DocAttach getDocumentDocAttachment(java.lang.Integer docAttachId)
           
 java.util.List<Document_Document> getDocumentDocumentList(java.lang.Integer documentId)
           
 com.jamasoftware.contour.documentKey.domain.DocumentKeyLookup getDocumentKeyLookup(java.lang.Integer organizationId, java.lang.String projectKey, java.lang.String setKey)
           
 java.util.List<com.jamasoftware.contour.documentKey.domain.DocumentKeyLookup> getDocumentKeyLookupsForProject(java.lang.String projectKey)
           
 java.util.List<Document> getDocumentListByType(java.lang.Integer documentTypeId, boolean activeOnly, com.jamasoftware.contour.service.search.SorterList sorter)
           
 java.util.List<Document> getDocumentsByNameAndRelease(java.lang.String name, java.lang.String release, java.lang.Integer projectId)
           
 java.util.List<ContourItem> getDocumentsWithOutOfSyncRelationshipsFor(java.lang.Integer projectId)
           
 java.util.List<ContourItem> getDocumentsWithSyncRelationshipsFor(java.lang.Integer projectId)
           
 java.util.List<Document_DocAttach> getDocumentToAttachmentDocumentList(java.lang.Integer documentId)
           
 Document_URL getDocumentURL(java.lang.Integer docUrlId)
           
 java.util.List<Document_URL> getDocumentURLs(java.lang.Integer documentId)
           
 java.util.List<java.lang.Integer> getIdsFor(java.lang.String property, java.lang.Class<?> clazz, java.util.List<java.lang.String> subqueries, java.lang.String inListProperty, java.util.List<java.lang.Integer> inList)
           
 java.lang.Integer getMaxSortOrder(java.lang.Integer parentId, boolean isParentProject)
           
 int getNumOutOfSyncItems(java.lang.Integer projectId)
           
 TestCaseStep getTestCaseStep(java.lang.Integer id)
           
 int getTotalProjectItems(int projectId)
           
 java.util.List<Document> getXProjectLinkReferences(java.lang.Integer documentId)
           
 void replaceLookupById(java.lang.Integer origionalLookupId, Lookup newLookup)
           
 void saveAttachmentRelationship(Document_DocAttach dtod)
           
 void saveDocument(Document document)
           
 void saveDocument(Document doc, boolean useMode)
           
 void saveDocumentAttachment(Document_Attachment docAttach)
           
 void saveDocumentKeyLookup(com.jamasoftware.contour.documentKey.domain.DocumentKeyLookup documentKeyLookup)
           
 void saveDocumentURL(Document_URL docUrl)
           
 java.util.List<java.lang.Object[]> subquerySearchWithProjection(java.lang.String projection, java.lang.Class<?> searchClass, org.apache.lucene.search.Query query)
           
 void updateDocument(Document doc)
           
 

Method Detail

getDocument

Document getDocument(java.lang.Integer documentId)

getDocumentActiveValue

boolean getDocumentActiveValue(java.lang.Integer documentId)

getDocumentByIds

java.util.List<Document> getDocumentByIds(java.util.List<java.lang.Integer> docIds)

getDocument

Document getDocument(java.lang.String documentKey,
                     java.lang.Integer projectId)

getDocumentByNameAndGroup

@Deprecated
Document getDocumentByNameAndGroup(java.lang.String name,
                                              java.lang.Integer groupId)
Deprecated. The document.getDocumentGroup relationship is deprecated, so this service method doesn't make sense to use.


getDocumentsByNameAndRelease

java.util.List<Document> getDocumentsByNameAndRelease(java.lang.String name,
                                                      java.lang.String release,
                                                      java.lang.Integer projectId)

saveDocument

void saveDocument(Document document)

saveDocument

void saveDocument(Document doc,
                  boolean useMode)

deleteDocument

void deleteDocument(Document doc)

deactivateDocument

void deactivateDocument(Document document)

deactivateDocumentById

void deactivateDocumentById(java.lang.Integer id)

clearDocumentReferencesForRelease

void clearDocumentReferencesForRelease(java.lang.Integer releaseId)

getDocumentAttachments

com.jamasoftware.contour.service.search.SearchResults<Document_DocAttach> getDocumentAttachments(java.lang.Integer documentId,
                                                                                                 com.jamasoftware.contour.service.search.PageInfo pageInfo,
                                                                                                 com.jamasoftware.contour.service.search.SorterList sorter)

getAttachmentDocuments

com.jamasoftware.contour.service.search.SearchResults<Document_DocAttach> getAttachmentDocuments(java.lang.Integer documentId,
                                                                                                 com.jamasoftware.contour.service.search.PageInfo pageInfo)

getDocumentDocAttachment

Document_DocAttach getDocumentDocAttachment(java.lang.Integer docAttachId)

saveDocumentAttachment

void saveDocumentAttachment(Document_Attachment docAttach)

getDocumentAttachment

Document_Attachment getDocumentAttachment(java.lang.Integer docAttId)

getDocumentAttachments

java.util.List<Document_Attachment> getDocumentAttachments(java.lang.Integer documentId)

getDocumentAttachments

java.util.List<Document_DocAttach> getDocumentAttachments(java.lang.Integer documentId,
                                                          java.lang.Integer docAttachmentId)

deleteDocumentAttachment

void deleteDocumentAttachment(Document_Attachment docAtt)

deleteDocumentAttachment

void deleteDocumentAttachment(Document_DocAttach docAtt)

deleteDocumentAttachments

void deleteDocumentAttachments(java.lang.Integer documentId)

getDocumentURLs

java.util.List<Document_URL> getDocumentURLs(java.lang.Integer documentId)

getDocumentURL

Document_URL getDocumentURL(java.lang.Integer docUrlId)

saveDocumentURL

void saveDocumentURL(Document_URL docUrl)

deleteDocumentURL

void deleteDocumentURL(Document_URL docUrl)

saveAttachmentRelationship

void saveAttachmentRelationship(Document_DocAttach dtod)

deleteDocumentDocument

void deleteDocumentDocument(Document_Document documentToDocument)

getDocumentDocumentList

java.util.List<Document_Document> getDocumentDocumentList(java.lang.Integer documentId)

getDocumentToAttachmentDocumentList

java.util.List<Document_DocAttach> getDocumentToAttachmentDocumentList(java.lang.Integer documentId)

getXProjectLinkReferences

java.util.List<Document> getXProjectLinkReferences(java.lang.Integer documentId)

getMaxSortOrder

java.lang.Integer getMaxSortOrder(java.lang.Integer parentId,
                                  boolean isParentProject)

getDocumentListByType

java.util.List<Document> getDocumentListByType(java.lang.Integer documentTypeId,
                                               boolean activeOnly,
                                               com.jamasoftware.contour.service.search.SorterList sorter)

updateDocument

void updateDocument(Document doc)

replaceLookupById

void replaceLookupById(java.lang.Integer origionalLookupId,
                       Lookup newLookup)

getTotalProjectItems

int getTotalProjectItems(int projectId)

getIdsFor

java.util.List<java.lang.Integer> getIdsFor(java.lang.String property,
                                            java.lang.Class<?> clazz,
                                            java.util.List<java.lang.String> subqueries,
                                            java.lang.String inListProperty,
                                            java.util.List<java.lang.Integer> inList)

subquerySearchWithProjection

java.util.List<java.lang.Object[]> subquerySearchWithProjection(java.lang.String projection,
                                                                java.lang.Class<?> searchClass,
                                                                org.apache.lucene.search.Query query)

getDocumentKeyLookup

com.jamasoftware.contour.documentKey.domain.DocumentKeyLookup getDocumentKeyLookup(java.lang.Integer organizationId,
                                                                                   java.lang.String projectKey,
                                                                                   java.lang.String setKey)

saveDocumentKeyLookup

void saveDocumentKeyLookup(com.jamasoftware.contour.documentKey.domain.DocumentKeyLookup documentKeyLookup)

getDocumentKeyLookupsForProject

java.util.List<com.jamasoftware.contour.documentKey.domain.DocumentKeyLookup> getDocumentKeyLookupsForProject(java.lang.String projectKey)

deleteDocumentKeyLookup

void deleteDocumentKeyLookup(com.jamasoftware.contour.documentKey.domain.DocumentKeyLookup lookup)

getDocumentAttachmentsFor

java.util.List<Document_Attachment> getDocumentAttachmentsFor(java.util.List<Attachment> attachments)

getTestCaseStep

TestCaseStep getTestCaseStep(java.lang.Integer id)

getDocumentsWithOutOfSyncRelationshipsFor

java.util.List<ContourItem> getDocumentsWithOutOfSyncRelationshipsFor(java.lang.Integer projectId)

getDocumentsWithSyncRelationshipsFor

java.util.List<ContourItem> getDocumentsWithSyncRelationshipsFor(java.lang.Integer projectId)

getNumOutOfSyncItems

int getNumOutOfSyncItems(java.lang.Integer projectId)


Copyright (c) 2010 Jama Software, Inc. All Rights Reserved.