Package com.jamasoftware.velocity.api.sources

Interface DocumentSource

public interface DocumentSource

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 Summary

Modifier and Type	Method	Description
boolean	areItemsInSync(Integer fromRefId, Integer toRefId)
List<Integer>	getActiveDocumentIdsInProject(Integer projectId)
List<Integer>	getAllBaselineDocumentNodeIds(List<Integer> baselineIds)
List<DocumentTag>	getAllDocumentsByTagId(Integer tagId)
List<DocumentTag>	getAllDocumentTagsByDocumentId(Integer docId)
Map<Integer,String>	getAllDocumentTypesMap(Integer orgId)
Map<Integer,Long>	getAllItemTypesCount(Integer projectId)
List<DocumentDocument>	getAllRelationshipsForDocuments(Collection<Integer> docIds, boolean onlyIncludeTreeRelationships)
Integer	getAllSuspectRelationshipsForProject(Integer projectId)
List<Tag>	getAllTagsByDocumentId(Integer docId)
List<VersionInfo>	getAllVersionInfoForOriginDocumentId(Integer originDocumentId)
List<Version>	getAllVersionsByDocumentId(Integer documentId)
Attachment	getAttachment(Integer attachmentId)
String	getBase64Image(Integer attachmentId)
ContourItem	getContourItem(Integer contourItemId)
List<Integer>	getContourItemIds(Integer orgId)
List<Integer>	getContourItemIdsForProject(Integer projectId)
List<Integer>	getDocTypesForOrg(Integer orgId)
Document	getDocument(Integer documentId)
List<DocumentDocAttach>	getDocument_DocAttachments(Integer docId)
DocumentField	getDocumentFieldByName(String name, Integer docTypeId)
DocumentTypeFieldDTO	getDocumentFieldDtoFor(Integer documentTypeFieldId, Integer projectId)
DocumentGroup	getDocumentGroup(Integer groupId)
List<DocumentInfo>	getDocumentInfoList(Integer documentTypeId, Integer projectId, Integer limit)
List<Document>	getDocumentListByType(Integer documentTypeId, boolean activeOnly, Object ignored)
DocumentNode	getDocumentNode(Integer scope, Integer refId)
DocumentNodeDTO	getDocumentNodeForBaseLine(Integer scope, Integer refId, Integer baseLineId)
List<ContourItem>	getDocumentsWithGlobalId(String globalId, Integer organizationId)
DocumentType	getDocumentType(Integer documentTypeId)
DocumentTypeField	getDocumentTypeField(Integer documentTypeFieldId)
DocumentTypeField	getDocumentTypeFieldByName(String name, Integer documentTypeId)
List<DocumentTypeField>	getDocumentTypeFieldListByType(Integer documentTypeId)
Integer	getDocumentTypeIdFromDocId(Integer docId)
List<DocumentType>	getDocumentTypeListForOrganization(Integer orgId)
List<DocumentUrl>	getDocumentURLs(Integer documentId)
List<Integer>	getDownstreamDocumentIds(Integer docId)
ContourItemDTO	getItem(Integer itemId)
ContourItemDTO	getItem(Integer currentVersionItemId, Integer versionNumber)
List<Integer>	getItemIdsForDocumentType(Integer documentTypeId)
Lookup	getLookup(Integer lookupId)
List<Integer>	getLookupIdsByLookupTypes(List<Integer> lookupTypeIds)
List<Lookup>	getLookupList(Integer type)
LookupType	getLookupType(Integer lookupTypeId)
DocumentNode	getOrCreateProjectNode(Integer projectId)	Deprecated.
DocumentDocument	getRelationshipBetweenDocuments(Integer fromDocId, Integer toDocId)
long	getRelationshipCountForDocumentAndType(Integer documentId, Integer relatedTypeId, boolean isForward)
VersionedRelationshipPageResults	getRelationships(Integer currentVersionItemId, Integer baselineId, int start, int count)
VersionedRelationshipPageResults	getRelationships(Integer currentVersionItemId, String timestamp, int start, int count)
List<DocumentDocument>	getRelationshipsForDocument(Integer documentId, boolean isForward)
List<DocumentDocument>	getRelationshipsForDocumentAndType(Integer documentId, Integer relatedTypeId, boolean isForward)
RelationshipDTOSearchResults	getRelationshipsForItemAtTime(Integer currentVersionDocumentId, Date timestamp, Integer start, Integer count)
RelationshipType	getRelationshipType(Integer typeId)
List<Integer>	getSubTreeIds(Integer projectId, Integer scope, Integer refId, Integer baselineId)
List<Integer>	getSyncedDocIds(List<Integer> docIds)
List<Integer>	getUpstreamDocumentIds(Integer docId)
Version	getVersionByDocAndVersionNumber(Integer docId, Integer versionNumber)
Version	getVersionByDocumentId(Integer documentId)
Integer	getVersionDocumentId(Integer originDocumentId, Date dateCeiling)
Version	getVersionTiedToEventEntry(EventEntry eventEntry)
boolean	isAncestor(Integer docId, Integer rootDocId)
boolean	isSyncItem(ContourItem item)

Method Detail

getDocument

Document getDocument(Integer documentId)

getDocumentFieldDtoFor

DocumentTypeFieldDTO getDocumentFieldDtoFor(Integer documentTypeFieldId,
                                            Integer projectId)

getActiveDocumentIdsInProject

List<Integer> getActiveDocumentIdsInProject(Integer projectId)

getDocumentsWithGlobalId

List<ContourItem> getDocumentsWithGlobalId(String globalId,
                                           Integer organizationId)

getContourItemIdsForProject

List<Integer> getContourItemIdsForProject(Integer projectId)

getContourItem

ContourItem getContourItem(Integer contourItemId)

getSyncedDocIds

List<Integer> getSyncedDocIds(List<Integer> docIds)

isSyncItem

boolean isSyncItem(ContourItem item)

getDocumentTypeFieldByName

DocumentTypeField getDocumentTypeFieldByName(String name,
                                             Integer documentTypeId)

getDocumentTypeFieldListByType

List<DocumentTypeField> getDocumentTypeFieldListByType(Integer documentTypeId)

getDocumentTypeIdFromDocId

Integer getDocumentTypeIdFromDocId(Integer docId)

getDocumentNode

DocumentNode getDocumentNode(Integer scope,
                             Integer refId)

getSubTreeIds

List<Integer> getSubTreeIds(Integer projectId,
                            Integer scope,
                            Integer refId,
                            Integer baselineId)

getDocumentNodeForBaseLine

DocumentNodeDTO getDocumentNodeForBaseLine(Integer scope,
                                           Integer refId,
                                           Integer baseLineId)

getAllDocumentTagsByDocumentId

List<DocumentTag> getAllDocumentTagsByDocumentId(Integer docId)

getAllTagsByDocumentId

List<Tag> getAllTagsByDocumentId(Integer docId)

getAllDocumentsByTagId

List<DocumentTag> getAllDocumentsByTagId(Integer tagId)

getDocumentType

DocumentType getDocumentType(Integer documentTypeId)

areItemsInSync

boolean areItemsInSync(Integer fromRefId,
                       Integer toRefId)

getVersionByDocumentId

Version getVersionByDocumentId(Integer documentId)

getVersionByDocAndVersionNumber

Version getVersionByDocAndVersionNumber(Integer docId,
                                        Integer versionNumber)

getAllVersionsByDocumentId

List<Version> getAllVersionsByDocumentId(Integer documentId)

getLookup

Lookup getLookup(Integer lookupId)

getLookupList

List<Lookup> getLookupList(Integer type)

getLookupIdsByLookupTypes

List<Integer> getLookupIdsByLookupTypes(List<Integer> lookupTypeIds)

getRelationshipType

RelationshipType getRelationshipType(Integer typeId)

getAllVersionInfoForOriginDocumentId

List<VersionInfo> getAllVersionInfoForOriginDocumentId(Integer originDocumentId)

getDocumentFieldByName

DocumentField getDocumentFieldByName(String name,
                                     Integer docTypeId)

getLookupType

LookupType getLookupType(Integer lookupTypeId)

getBase64Image

String getBase64Image(Integer attachmentId)
               throws IOException

Throws:

IOException

getUpstreamDocumentIds

List<Integer> getUpstreamDocumentIds(Integer docId)

getAllRelationshipsForDocuments

List<DocumentDocument> getAllRelationshipsForDocuments(Collection<Integer> docIds,
                                                       boolean onlyIncludeTreeRelationships)

getDownstreamDocumentIds

List<Integer> getDownstreamDocumentIds(Integer docId)

getRelationshipsForDocument

List<DocumentDocument> getRelationshipsForDocument(Integer documentId,
                                                   boolean isForward)

getRelationshipBetweenDocuments

DocumentDocument getRelationshipBetweenDocuments(Integer fromDocId,
                                                 Integer toDocId)

getRelationshipsForDocumentAndType

List<DocumentDocument> getRelationshipsForDocumentAndType(Integer documentId,
                                                          Integer relatedTypeId,
                                                          boolean isForward)

getItem

ContourItemDTO getItem(Integer currentVersionItemId,
                       Integer versionNumber)

getItem

ContourItemDTO getItem(Integer itemId)

getItemIdsForDocumentType

List<Integer> getItemIdsForDocumentType(Integer documentTypeId)

getRelationships

VersionedRelationshipPageResults getRelationships(Integer currentVersionItemId,
                                                  Integer baselineId,
                                                  int start,
                                                  int count)
                                           throws Exception

Throws:

Exception

getRelationships

VersionedRelationshipPageResults getRelationships(Integer currentVersionItemId,
                                                  String timestamp,
                                                  int start,
                                                  int count)

isAncestor

boolean isAncestor(Integer docId,
                   Integer rootDocId)

getVersionDocumentId

Integer getVersionDocumentId(Integer originDocumentId,
                             Date dateCeiling)

getRelationshipsForItemAtTime

RelationshipDTOSearchResults getRelationshipsForItemAtTime(Integer currentVersionDocumentId,
                                                           Date timestamp,
                                                           Integer start,
                                                           Integer count)
                                                    throws Exception

Throws:

Exception

getContourItemIds

List<Integer> getContourItemIds(Integer orgId)

getDocumentTypeListForOrganization

List<DocumentType> getDocumentTypeListForOrganization(Integer orgId)

getAttachment

Attachment getAttachment(Integer attachmentId)

getOrCreateProjectNode

@Deprecated
DocumentNode getOrCreateProjectNode(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

List<Integer> getDocTypesForOrg(Integer orgId)

getAllBaselineDocumentNodeIds

List<Integer> getAllBaselineDocumentNodeIds(List<Integer> baselineIds)

getDocumentURLs

List<DocumentUrl> getDocumentURLs(Integer documentId)

getAllSuspectRelationshipsForProject

Integer getAllSuspectRelationshipsForProject(Integer projectId)

getDocumentTypeField

DocumentTypeField getDocumentTypeField(Integer documentTypeFieldId)

getDocumentListByType

List<Document> getDocumentListByType(Integer documentTypeId,
                                     boolean activeOnly,
                                     Object ignored)

getDocument_DocAttachments

List<DocumentDocAttach> getDocument_DocAttachments(Integer docId)

getVersionTiedToEventEntry

Version getVersionTiedToEventEntry(EventEntry eventEntry)

getAllItemTypesCount

Map<Integer,Long> getAllItemTypesCount(Integer projectId)

getAllDocumentTypesMap

Map<Integer,String> getAllDocumentTypesMap(Integer orgId)

getDocumentInfoList

List<DocumentInfo> getDocumentInfoList(Integer documentTypeId,
                                       Integer projectId,
                                       Integer limit)

getRelationshipCountForDocumentAndType

long getRelationshipCountForDocumentAndType(Integer documentId,
                                            Integer relatedTypeId,
                                            boolean isForward)

getDocumentGroup

DocumentGroup getDocumentGroup(Integer groupId)