Package com.jamasoftware.velocity.api.sources

Interface DocumentSource

  • All Superinterfaces:
    VelocityDataSource
    public interface DocumentSource
extends VelocityDataSource
    Contains methods to fetch Connect documents/items and their versions/relationships.

    These methods are exposed to Velocity reports on the documentSource object within the global context. Example: $documentSource.getDocument(1)

    • Method Detail

      • getDocument

        Document getDocument​(java.lang.Integer documentId)

      • getDocumentFieldDtoFor

        DocumentTypeFieldDTO getDocumentFieldDtoFor​(java.lang.Integer documentTypeFieldId,
                                            java.lang.Integer projectId)

      • getActiveDocumentIdsInProject

        java.util.List<java.lang.Integer> getActiveDocumentIdsInProject​(java.lang.Integer projectId)

      • getDocumentsWithGlobalId

        java.util.List<ContourItem> getDocumentsWithGlobalId​(java.lang.String globalId,
                                                     java.lang.Integer organizationId)

      • getContourItemIdsForProject

        java.util.List<java.lang.Integer> getContourItemIdsForProject​(java.lang.Integer projectId)

      • getContourItem

        ContourItem getContourItem​(java.lang.Integer contourItemId)

      • getSyncedDocIds

        java.util.List<java.lang.Integer> getSyncedDocIds​(java.util.List<java.lang.Integer> docIds)

      • getDocumentTypeFieldByName

        DocumentTypeField getDocumentTypeFieldByName​(java.lang.String name,
                                             java.lang.Integer documentTypeId)

      • getDocumentTypeFieldListByType

        java.util.List<DocumentTypeField> getDocumentTypeFieldListByType​(java.lang.Integer documentTypeId)

      • getDocumentTypeIdFromDocId

        java.lang.Integer getDocumentTypeIdFromDocId​(java.lang.Integer docId)

      • getDocumentNode

        DocumentNode getDocumentNode​(java.lang.Integer scope,
                             java.lang.Integer refId)

      • getSubTreeIds

        java.util.List<java.lang.Integer> getSubTreeIds​(java.lang.Integer projectId,
                                                java.lang.Integer scope,
                                                java.lang.Integer refId,
                                                java.lang.Integer baselineId)

      • getDocumentNodeForBaseLine

        DocumentNodeDTO getDocumentNodeForBaseLine​(java.lang.Integer scope,
                                           java.lang.Integer refId,
                                           java.lang.Integer baseLineId)

      • getAllDocumentTagsByDocumentId

        java.util.List<DocumentTag> getAllDocumentTagsByDocumentId​(java.lang.Integer docId)

      • getAllTagsByDocumentId

        java.util.List<Tag> getAllTagsByDocumentId​(java.lang.Integer docId)

      • getAllDocumentsByTagId

        java.util.List<DocumentTag> getAllDocumentsByTagId​(java.lang.Integer tagId)

      • getDocumentType

        DocumentType getDocumentType​(java.lang.Integer documentTypeId)

      • areItemsInSync

        boolean areItemsInSync​(java.lang.Integer fromRefId,
                       java.lang.Integer toRefId)

      • getVersionByDocumentId

        Version getVersionByDocumentId​(java.lang.Integer documentId)

      • getVersionByDocAndVersionNumber

        Version getVersionByDocAndVersionNumber​(java.lang.Integer docId,
                                        java.lang.Integer versionNumber)

      • getAllVersionsByDocumentId

        java.util.List<Version> getAllVersionsByDocumentId​(java.lang.Integer documentId)

      • getLookup

        Lookup getLookup​(java.lang.Integer lookupId)

      • getLookupList

        java.util.List<Lookup> getLookupList​(java.lang.Integer type)

      • getLookupIdsByLookupTypes

        java.util.List<java.lang.Integer> getLookupIdsByLookupTypes​(java.util.List<java.lang.Integer> lookupTypeIds)

      • getRelationshipType

        RelationshipType getRelationshipType​(java.lang.Integer typeId)

      • getRelationshipTypeList

        java.util.List<RelationshipType> getRelationshipTypeList​(java.lang.Integer scopeId,
                                                         java.lang.Integer refId)

      • getAllVersionInfoForOriginDocumentId

        java.util.List<VersionInfo> getAllVersionInfoForOriginDocumentId​(java.lang.Integer originDocumentId)

      • getDocumentFieldByName

        DocumentField getDocumentFieldByName​(java.lang.String name,
                                     java.lang.Integer docTypeId)

      • getLookupType

        LookupType getLookupType​(java.lang.Integer lookupTypeId)

      • getBase64Image

        java.lang.String getBase64Image​(java.lang.Integer attachmentId)
                         throws java.io.IOException
        Throws:
        java.io.IOException

      • getUpstreamDocumentIds

        java.util.List<java.lang.Integer> getUpstreamDocumentIds​(java.lang.Integer docId)

      • getAllRelationshipsForDocuments

        java.util.List<DocumentDocument> getAllRelationshipsForDocuments​(java.util.Collection<java.lang.Integer> docIds,
                                                                 boolean onlyIncludeTreeRelationships)

      • getDownstreamDocumentIds

        java.util.List<java.lang.Integer> getDownstreamDocumentIds​(java.lang.Integer docId)

      • getRelationshipsForDocument

        java.util.List<DocumentDocument> getRelationshipsForDocument​(java.lang.Integer documentId,
                                                             boolean isForward)

      • getRelationshipBetweenDocuments

        DocumentDocument getRelationshipBetweenDocuments​(java.lang.Integer fromDocId,
                                                 java.lang.Integer toDocId)

      • getRelationshipsForDocumentAndType

        java.util.List<DocumentDocument> getRelationshipsForDocumentAndType​(java.lang.Integer documentId,
                                                                    java.lang.Integer relatedTypeId,
                                                                    boolean isForward)

      • getItem

        ContourItemDTO getItem​(java.lang.Integer currentVersionItemId,
                       java.lang.Integer versionNumber)
                throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getItem

        ContourItemDTO getItem​(java.lang.Integer itemId)
                throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getItemIdsForDocumentType

        java.util.List<java.lang.Integer> getItemIdsForDocumentType​(java.lang.Integer documentTypeId)

      • getRelationships

        VersionedRelationshipPageResults getRelationships​(java.lang.Integer currentVersionItemId,
                                                  java.lang.Integer baselineId,
                                                  int start,
                                                  int count)
                                           throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getRelationships

        VersionedRelationshipPageResults getRelationships​(java.lang.Integer currentVersionItemId,
                                                  java.lang.String timestamp,
                                                  int start,
                                                  int count)
                                           throws java.lang.Exception
        Throws:
        java.lang.Exception

      • isAncestor

        boolean isAncestor​(java.lang.Integer docId,
                   java.lang.Integer rootDocId)

      • getVersionDocumentId

        java.lang.Integer getVersionDocumentId​(java.lang.Integer originDocumentId,
                                       java.util.Date dateCeiling)

      • getRelationshipsForItemAtTime

        RelationshipDTOSearchResults getRelationshipsForItemAtTime​(java.lang.Integer currentVersionDocumentId,
                                                           java.util.Date timestamp,
                                                           java.lang.Integer start,
                                                           java.lang.Integer count)
                                                    throws java.lang.Exception
        Throws:
        java.lang.Exception

      • getContourItemIds

        java.util.List<java.lang.Integer> getContourItemIds​(java.lang.Integer orgId)

      • getDocumentTypeListForOrganization

        java.util.List<DocumentType> getDocumentTypeListForOrganization​(java.lang.Integer orgId)

      • getAttachment

        Attachment getAttachment​(java.lang.Integer attachmentId)

      • getOrCreateProjectNode

        @Deprecated
DocumentNode getOrCreateProjectNode​(java.lang.Integer projectId)
        Deprecated.
        Added for compatibiliy. This is a READ ONLY method. No objects will be created
        Parameters:
        projectId - The ID of the project
        Returns:
        The project document matching the given id

      • getDocTypesForOrg

        java.util.List<java.lang.Integer> getDocTypesForOrg​(java.lang.Integer orgId)

      • getAllBaselineDocumentNodeIds

        java.util.List<java.lang.Integer> getAllBaselineDocumentNodeIds​(java.util.List<java.lang.Integer> baselineIds)

      • getDocumentURLs

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

      • getAllSuspectRelationshipsForProject

        java.lang.Integer getAllSuspectRelationshipsForProject​(java.lang.Integer projectId)

      • getDocumentTypeField

        DocumentTypeField getDocumentTypeField​(java.lang.Integer documentTypeFieldId)

      • getDocumentListByType

        java.util.List<Document> getDocumentListByType​(java.lang.Integer documentTypeId,
                                               boolean activeOnly,
                                               java.lang.Object ignored)

      • getDocument_DocAttachments

        java.util.List<DocumentDocAttach> getDocument_DocAttachments​(java.lang.Integer docId)

      • getVersionTiedToEventEntry

        Version getVersionTiedToEventEntry​(EventEntry eventEntry)

      • getAllItemTypesCount

        java.util.Map<java.lang.Integer,​java.lang.Long> getAllItemTypesCount​(java.lang.Integer projectId)

      • getAllDocumentTypesMap

        java.util.Map<java.lang.Integer,​java.lang.String> getAllDocumentTypesMap​(java.lang.Integer orgId)

      • getDocumentInfoList

        java.util.List<DocumentInfo> getDocumentInfoList​(java.lang.Integer documentTypeId,
                                                 java.lang.Integer projectId,
                                                 java.lang.Integer limit)

      • getRelationshipCountForDocumentAndType

        long getRelationshipCountForDocumentAndType​(java.lang.Integer documentId,
                                            java.lang.Integer relatedTypeId,
                                            boolean isForward)

      • getDocumentGroup

        DocumentGroup getDocumentGroup​(java.lang.Integer groupId)

      • getChangeRequestAssociationsFromAssociatedItem

        java.util.List<ChangeRequestAssociation> getChangeRequestAssociationsFromAssociatedItem​(java.lang.Integer associatedItemId,
                                                                                        boolean activeOnly)

      • getRenameTagsToLabels

        java.lang.String getRenameTagsToLabels()