|
Primavera Integration API 6.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface DocumentManager
Provides access to the Document Management repository.
Method Summary | |
---|---|
DocumentProperties |
assignDocumentSecurityPolicy(DocumentId documentId,
DocumentManagementSecurityPolicy policy)
Assign a security policy to a document. |
FolderProperties |
assignFolderSecurityPolicy(FolderId folderId,
DocumentManagementSecurityPolicy policy)
Assign a security policy to a folder. |
VersionProperties |
checkIn(VersionId versionId,
CheckInOptions options,
File content)
Checks in a checked out document with the content. |
VersionProperties |
checkIn(VersionId versionId,
CheckInOptions options,
InputStream content,
long streamLength)
Deprecated. As of release 5.0, use use checkIn(VersionId, CheckInOptions, String, InputStream, long) |
VersionProperties |
checkIn(VersionId versionId,
CheckInOptions options,
String contentPathAndName,
InputStream content,
long streamLength)
Checks in a checked out document with the content. |
VersionProperties |
checkOut(VersionId versionId,
File content)
Checks out a version of a document and puts the document content into the object provided. |
VersionProperties |
checkOut(VersionId versionId,
OutputStream content)
Checks out a version of a document and puts the document content into the object provided. |
VersionProperties |
checkOutLatestVersion(DocumentId documentId,
File content)
Checks out the latest version of a document and puts the document content into the object provided. |
VersionProperties |
checkOutLatestVersion(DocumentId documentId,
OutputStream content)
Checks out the latest version of a document and puts the document content into the object provided. |
DocumentProperties |
convertDocumentFromPrivateToProject(Document pmDocument,
FolderId destination,
DocumentId privateDocumentId)
Converts an existing private collaboration document to a Project Management collaboration document. |
DocumentProperties |
convertDocumentFromPrivateToProject(ObjectId documentObjectId,
FolderId destination,
DocumentId privateDocumentId)
Converts an existing private collaboration document to a Project Management collaboration document, linking the collaboration document to an existing Project Management document. |
DocumentProperties |
convertDocumentFromProjectToPrivate(DocumentId documentId)
Converts an existing project collaboration document to a private collaboration document. |
DocumentProperties |
convertDocumentFromProjectToPrivate(ObjectId documentObjectId)
Converts an existing project collaboration document to a private collaboration document. |
FolderProperties |
createFolder(FolderId parentFolderId,
String folderName)
Creates a subfolder under the parent folder. |
DocumentProperties |
createProjectDocument(Document pmDocument,
FolderId locationFolderId,
File contents)
Creates a ProjectManagment document and uploads the file associated with the document. |
DocumentProperties |
createProjectDocument(Document pmDocument,
FolderId locationFolderId,
String fileName,
InputStream content,
long streamLength)
Creates a ProjectManagment document and uploads the file associated with the document. |
void |
deleteDocument(DocumentId documentId)
Deletes a document. |
void |
deleteFolder(FolderId folderId)
Deletes a folder. |
void |
deleteVersion(VersionId versionId)
Deletes a version of a project or private document. |
VersionProperties |
download(VersionId versionId,
File content)
Downloads a version of a document without checking out. |
VersionProperties |
download(VersionId versionId,
OutputStream content)
Downloads a version of a document without checking out. |
VersionProperties |
downloadLatestVersion(DocumentId documentId,
File content)
Downloads the latest version of a document without checking out. |
VersionProperties |
downloadLatestVersion(DocumentId documentId,
OutputStream content)
Downloads the latest version of a document without checking out. |
boolean |
isDocumentCheckedOut(DocumentId documentId)
Determines if any version of a document is checked out. |
boolean |
isStrictVersioningOn()
Determines if Strict versioning is on. |
VersionProperties[] |
loadCheckedOutVersions(DocumentId documentId)
Provides information about any versions of a document that are checked out. |
FolderProperties[] |
loadChildFolders(FolderId folderId)
Loads all the subfolders of a given folder. |
DocumentProperties |
loadDocument(DocumentId documentId)
Loads the properties of the document based on the collaboration id of the document. |
DocumentProperties |
loadDocument(ObjectId docObjId)
Loads the properties of the document based on the ObjectId from the Project Management Database. |
DocumentProperties[] |
loadDocuments(FolderId folderId)
Loads all the properties of all the documents in the folder. |
FolderProperties |
loadFolder(DocumentId documentId)
Gets the properties of the folder containing the document. |
FolderProperties |
loadFolder(FolderId folderId)
Gets the properties of the folder specified. |
HistoryEventProperties[] |
loadHistoryEvents(DocumentId documentId)
Loads all the history objects associated with the document. |
VersionProperties |
loadLatestVersion(DocumentId documentId)
Gets the latest version of the document. |
FolderProperties |
loadParentFolder(FolderId folderId)
Loads the properties of the parent folder. |
DocumentProperties[] |
loadPrivateDocuments()
Gets all private documents for the current user. |
FolderProperties |
loadRootFolder(ObjectId projectObjectId)
Loads the base or root folder for a Project. |
VersionProperties |
loadVersion(VersionId versionId)
Loads the properties of the version. |
VersionProperties[] |
loadVersions(DocumentId documentId)
Loads versions of a document. |
DocumentProperties |
moveDocument(DocumentId targetDocumentId,
FolderId destinationFolderId)
Moves a document from its current folder to another NOTE: moving a document from one folder to another alters the DocumentId value. |
FolderProperties |
moveFolder(FolderId targetFolderId,
FolderId destinationFolderId)
Moves a folder from one location to another. |
FolderProperties |
renameFolder(FolderId targetFolderId,
String newName)
Renames the folder. |
DocumentProperties |
renamePrivateDocument(DocumentId targetDocumentId,
String newName)
Renames the document. |
VersionProperties |
undoCheckOut(VersionId versionId)
Removes the checkout of a version. |
DocumentProperties |
uploadPrivateDocument(String description,
File content)
Creates a private document, accessible only the user. |
DocumentProperties |
uploadPrivateDocument(String title,
String description,
InputStream content,
long streamLength)
Creates a private document, accessible only the user. |
DocumentProperties |
uploadProjectDocument(ObjectId docObjId,
FolderId locationFolderId,
File content)
Uploads a file into the document management repository for an existing Document in the Project Management database. |
DocumentProperties |
uploadProjectDocument(ObjectId docObjId,
FolderId locationFolderId,
String fileName,
InputStream content,
long streamLength)
Uploads a file into the document management repository for an existing Document in the Project Management database. |
Method Detail |
---|
VersionProperties[] loadCheckedOutVersions(DocumentId documentId) throws ServerException, ClientException, NetworkException
documentId
- unique identifier for a document
ServerException
- if documentId not found or an error occurs
ClientException
- if documentId is null
NetworkException
- if a problem occurred in the network layerboolean isDocumentCheckedOut(DocumentId documentId) throws ServerException, ClientException, NetworkException
documentId
- unique identifier for a document
ServerException
- if documentId not found or an error occurs
ClientException
- if documentId is null
NetworkException
- if a problem occurred in the network layerVersionProperties loadLatestVersion(DocumentId documentId) throws ServerException, ClientException, NetworkException
documentId
- unique identifier for a document
ServerException
- if document not found or an error occurs
ClientException
- if documentId is null
NetworkException
- if a problem occurred in the network layerboolean isStrictVersioningOn()
@Deprecated VersionProperties checkIn(VersionId versionId, CheckInOptions options, InputStream content, long streamLength) throws ServerException, ClientException, NetworkException
checkIn(VersionId, CheckInOptions, String, InputStream, long)
versionId
- unique identifier for a versionoptions
- options for checking incontent
- the potentially revised contentstreamLength
- the size of the content to include in the checkin.
ServerException
- if version is not checked out or is checked out by another user or
the stream cannot be read.
ClientException
- if input data is invalid (null) or if options are invalid
NetworkException
- if a problem occurred in the network layerVersionProperties checkIn(VersionId versionId, CheckInOptions options, String contentPathAndName, InputStream content, long streamLength) throws ServerException, ClientException, NetworkException
versionId
- unique identifier for a versionoptions
- options for checking incontentPathAndName
- the path and name of the contentcontent
- the potentially revised contentstreamLength
- the size of the content to include in the checkin.
ServerException
- if version is not checked out or is checked out by another user or
the stream cannot be read.
ClientException
- if input data is invalid (null) or if options are invalid
NetworkException
- if a problem occurred in the network layerVersionProperties checkIn(VersionId versionId, CheckInOptions options, File content) throws ServerException, ClientException, NetworkException
versionId
- unique identifier for a versionoptions
- options for checking incontent
- the potentially revised content
ServerException
- if version is not checked out or is checked out by another user or
the file cannot be read.
ClientException
- if requred input data is invalid or null
NetworkException
- if a problem occurred in the network layerVersionProperties checkOut(VersionId versionId, OutputStream content) throws ServerException, ClientException, NetworkException
versionId
- unique identifier for a versioncontent
- container for the content of the document
ServerException
- if version not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerVersionProperties checkOut(VersionId versionId, File content) throws ServerException, ClientException, NetworkException
versionId
- unique identifier for a versioncontent
- container for the content of the document
ServerException
- if version not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerVersionProperties checkOutLatestVersion(DocumentId documentId, OutputStream content) throws ServerException, ClientException, NetworkException
documentId
- unique identifier for a documentcontent
- container for the content of the document
ServerException
- if document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerVersionProperties checkOutLatestVersion(DocumentId documentId, File content) throws ServerException, ClientException, NetworkException
documentId
- unique identifier for a documentcontent
- container for the content of the document
ServerException
- if document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties convertDocumentFromPrivateToProject(Document pmDocument, FolderId destination, DocumentId privateDocumentId) throws ServerException, ClientException, NetworkException
pmDocument
- data container with fields populated, but that does not yet exist in the
database (did not call create method).destination
- folder in which to place the collaboration document; uses project root
folder if nullprivateDocumentId
- the document to convert
ServerException
- if privateDocumentId not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties convertDocumentFromPrivateToProject(ObjectId documentObjectId, FolderId destination, DocumentId privateDocumentId) throws ServerException, ClientException, NetworkException
documentObjectId
- the Project Management object id for the document to convertdestination
- folder in which to place the collaboration document; uses project root
folder if nullprivateDocumentId
- the existing private collaboration document to convert
ServerException
- if privateDocumentId not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties convertDocumentFromProjectToPrivate(DocumentId documentId) throws ServerException, ClientException, NetworkException
documentId
- the collaboration id for the document to convert
ServerException
- if data not found, document is not a collaboration document, or an
error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties convertDocumentFromProjectToPrivate(ObjectId documentObjectId) throws ServerException, ClientException, NetworkException
documentObjectId
- the Project Management object id for the document to convert (the
document must be a collaboration document)
ServerException
- if Document not found, document is not a collaboration document, or
an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerFolderProperties createFolder(FolderId parentFolderId, String folderName) throws ServerException, ClientException, NetworkException
parentFolderId
- the folder to contain the new folder.folderName
- the name of the new folder
ServerException
- if parent folder not found or an error occurs
ClientException
- if any input value is null or name is too long
NetworkException
- if a problem occurred in the network layerDocumentProperties createProjectDocument(Document pmDocument, FolderId locationFolderId, File contents) throws ServerException, ClientException, NetworkException
pmDocument
- data container with fields populated, but that does not yet exist in the
database (did not call create method).locationFolderId
- null value puts document in project root foldercontents
- the actual document file
ServerException
- if Document already exists or if pmDocument cannot be created
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layeruploadProjectDocument(com.primavera.common.value.ObjectId,
FolderId, java.io.File)
DocumentProperties createProjectDocument(Document pmDocument, FolderId locationFolderId, String fileName, InputStream content, long streamLength) throws ServerException, ClientException, NetworkException
pmDocument
- data container with fields populated, but that does not yet exist in the
database (did not call create method).locationFolderId
- null value puts document in project root folderfileName
- the value to store in the collaboration server as the file name.content
- the content of the documentstreamLength
- the length of the content to be included
ServerException
- if Document already exists or if pmDocument cannot be created
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layeruploadProjectDocument(com.primavera.common.value.ObjectId, FolderId, String, java.io.InputStream, long)
void deleteDocument(DocumentId documentId) throws ServerException, ClientException, NetworkException
documentId
-
ServerException
- if document not found, the user is not allowed to delete the
document, or an error occurs
ClientException
- if documentId is null
NetworkException
- if a problem occurred in the network layervoid deleteFolder(FolderId folderId) throws ServerException, ClientException, NetworkException
folderId
- the identifier of the folder to delete
ServerException
- if folder not found, folder contains documents or subfolders, or an
error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layervoid deleteVersion(VersionId versionId) throws ServerException, ClientException, NetworkException
versionId
- the version to delete
ServerException
- if version not found, trying to delete the first version of a
project document, or an error occurs
ClientException
- if required input parameters are null or strict versioning is
enabled.
NetworkException
- if a problem occurred in the network layerVersionProperties downloadLatestVersion(DocumentId documentId, File content) throws ServerException, ClientException, NetworkException
documentId
- the unique identifier for the documentcontent
- the container for the document content
ServerException
- if document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerVersionProperties download(VersionId versionId, OutputStream content) throws ServerException, ClientException, NetworkException
versionId
- the unique identifier of the version to checkoutcontent
- the container for the document content
ServerException
- if version not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerVersionProperties download(VersionId versionId, File content) throws ServerException, ClientException, NetworkException
versionId
- the unique identifier of the version to checkoutcontent
- the container for the document content
ServerException
- if version not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerVersionProperties downloadLatestVersion(DocumentId documentId, OutputStream content) throws ServerException, ClientException, NetworkException
documentId
- the unique identifier for the documentcontent
- the container for the document content
ServerException
- if document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerFolderProperties[] loadChildFolders(FolderId folderId) throws ServerException, ClientException, NetworkException
folderId
- the folder on which to load the subfolders
ServerException
- if folder not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties loadDocument(DocumentId documentId) throws ServerException, ClientException, NetworkException
documentId
- the document on which to get properties
ServerException
- if document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties loadDocument(ObjectId docObjId) throws ServerException, ClientException, NetworkException
docObjId
- the ObjectId for the Document in the Project Management database
ServerException
- if document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties[] loadDocuments(FolderId folderId) throws ServerException, ClientException, NetworkException
folderId
- the folder that contains all the documents
ServerException
- if folder not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerFolderProperties loadFolder(DocumentId documentId) throws ServerException, ClientException, NetworkException
documentId
- the document
ServerException
- if document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerFolderProperties loadFolder(FolderId folderId) throws ServerException, ClientException, NetworkException
folderId
- the folder to provide data for
ServerException
- if folder not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerHistoryEventProperties[] loadHistoryEvents(DocumentId documentId) throws ServerException, ClientException, NetworkException
documentId
- the document on which to provide history
ServerException
- if document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerFolderProperties loadParentFolder(FolderId folderId) throws ServerException, ClientException, NetworkException
folderId
- the folder on which to find its parent's properties.
ServerException
- if folder not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties[] loadPrivateDocuments() throws ServerException, ClientException, NetworkException
ServerException
- if an error occurs.
ClientException
NetworkException
- if a problem occurred in the network layerFolderProperties loadRootFolder(ObjectId projectObjectId) throws ServerException, ClientException, NetworkException
projectObjectId
- the ObjectId for a project
ServerException
- if project not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerVersionProperties loadVersion(VersionId versionId) throws ServerException, ClientException, NetworkException
versionId
- the version on which to get properties
ServerException
- if version not found or an error occurs
ClientException
- if versionId is null
NetworkException
- if a problem occurred in the network layerVersionProperties[] loadVersions(DocumentId documentId) throws ServerException, ClientException, NetworkException
documentId
- the document for which to load versions
ServerException
- if document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties moveDocument(DocumentId targetDocumentId, FolderId destinationFolderId) throws ServerException, ClientException, NetworkException
targetDocumentId
- the document to movedestinationFolderId
- the folder to which the document is moved
ServerException
- if document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerFolderProperties moveFolder(FolderId targetFolderId, FolderId destinationFolderId) throws ServerException, ClientException, NetworkException
targetFolderId
- the folder to movedestinationFolderId
- the folder to which the folder is moved
ServerException
- if folder not found, destination is not contained in same project,
or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerFolderProperties renameFolder(FolderId targetFolderId, String newName) throws ServerException, ClientException, NetworkException
targetFolderId
- the folder to renamenewName
- the new name for the folder
ServerException
- if folder not found or an error occurs
ClientException
- if required input parameters are null or name is too long.
NetworkException
- if a problem occurred in the network layerDocumentProperties renamePrivateDocument(DocumentId targetDocumentId, String newName) throws ServerException, ClientException, NetworkException
targetDocumentId
- the document to renamenewName
- the new name
ServerException
- if document not found, the document is not a private document, or
an error occurs
ClientException
- if required input parameters are null or name is too long.
NetworkException
- if a problem occurred in the network layerVersionProperties undoCheckOut(VersionId versionId) throws ServerException, ClientException, NetworkException
versionId
- the unique identifer for the version on which to act.
ServerException
- if version not found or an error occurs
ClientException
- if versionId is null
NetworkException
- if a problem occurred in the network layerDocumentProperties uploadPrivateDocument(String title, String description, InputStream content, long streamLength) throws ServerException, ClientException, NetworkException
title
- the value to store in the collaboration server as the title.description
- the description of the contentcontent
- the document content to be added to the collaboration server.streamLength
- the length of the content to be included
ServerException
- if an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties uploadPrivateDocument(String description, File content) throws ServerException, ClientException, NetworkException
description
- the description of the contentcontent
- the document content to be added to the collaboration server.
ServerException
- if an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties uploadProjectDocument(ObjectId docObjId, FolderId locationFolderId, File content) throws ServerException, ClientException, NetworkException
docObjId
- the ObjectId for the Document in the Project Management databaselocationFolderId
- the location for the collaboration document; uses the root if this
value is nullcontent
- the document content to be added to the collaboration server.
ServerException
- if folder or document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties uploadProjectDocument(ObjectId docObjId, FolderId locationFolderId, String fileName, InputStream content, long streamLength) throws ServerException, ClientException, NetworkException
docObjId
- the ObjectId for the Document in the Project Management databaselocationFolderId
- the location for the collaboration document; uses the root if this
value is nullfileName
- the value to store in the collaboration server as the file name.content
- the document content to be added to the collaboration server.streamLength
- the length of the content to be included
ServerException
- if document or folder not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerDocumentProperties assignDocumentSecurityPolicy(DocumentId documentId, DocumentManagementSecurityPolicy policy) throws ServerException, ClientException, NetworkException
documentId
- the document on which to assign the specified security policypolicy
- the value to assign
ServerException
- if document not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layerFolderProperties assignFolderSecurityPolicy(FolderId folderId, DocumentManagementSecurityPolicy policy) throws ServerException, ClientException, NetworkException
folderId
- the folder on which to assign the specified security policypolicy
- the value to assign
ServerException
- if folder not found or an error occurs
ClientException
- if required input parameters are null
NetworkException
- if a problem occurred in the network layer
|
Primavera Integration API 6.1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |