hudson.plugins.sfee.webservice

Interface DocumentAppSoap

All Superinterfaces:

Remote

All Known Implementing Classes:

DocumentAppSoapBindingStub

public interface DocumentAppSoap
extends Remote

Method Summary

Methods

Modifier and Type	Method and Description
DocumentSoapDO	createDocument(String sessionId, String parentId, String title, String description, String versionComment, String status, boolean createLocked, String fileName, String mimeType, String fileId, String associationId, String associationDesc)
DocumentFolderSoapDO	createDocumentFolder(String sessionId, String parentId, String title, String description)
DocumentSoapDO	createDocumentWithUrl(String sessionId, String parentId, String title, String description, String versionComment, String status, boolean createLocked, String fileUrl, String associationId, String associationDesc)
DocumentReviewSoapDO	createReview(String sessionId, String documentId, int version, String title, String description, Calendar dueDate, String[] requiredReviewers, String[] optionalReviewers, boolean attachDocument)
void	deleteDocument(String sessionId, String documentId)
void	deleteDocumentFolder(String sessionId, String folderId)
DocumentSoapList	findDocuments(String sessionId, String queryString, String projectId, boolean searchAttachments, boolean currentVersionsOnly)
DocumentReviewSoapList	getAssignedDocumentReviewList(String sessionId, String username)
DocumentSoapDO	getDocumentData(String sessionId, String documentId, int documentVersion)
String	getDocumentFileId(String sessionId, String documentId, int documentVersion)
DocumentFolderSoapDO	getDocumentFolderData(String sessionId, String folderId)
DocumentFolderSoapList	getDocumentFolderList(String sessionId, String parentId, boolean recursive)
DocumentSoapList	getDocumentList(String sessionId, String parentId, SoapFilter[] filters)
DocumentReviewSoapList	getDocumentReviewList(String sessionId, String containerId, SoapFilter[] filters)
DocumentSoapDO	moveDocument(String sessionId, String documentId, String targetFolderId)
DocumentFolderSoapDO	moveDocumentFolder(String sessionId, String folderId, String destFolderId)
void	setDocumentData(String sessionId, DocumentSoapDO documentData, String fileId)
void	setDocumentDataWithAssociation(String sessionId, DocumentSoapDO documentData, String fileId, String associationId, String associationComment)
void	setDocumentFolderData(String sessionId, DocumentFolderSoapDO documentFolderData)

Method Detail

createDocument

DocumentSoapDO createDocument(String sessionId,
                            String parentId,
                            String title,
                            String description,
                            String versionComment,
                            String status,
                            boolean createLocked,
                            String fileName,
                            String mimeType,
                            String fileId,
                            String associationId,
                            String associationDesc)
                              throws RemoteException,
                                     InvalidAssociationFault,
                                     IllegalArgumentFault,
                                     NoSuchObjectFault,
                                     InvalidSessionFault,
                                     SystemFault,
                                     PermissionDeniedFault

Throws:

RemoteException

InvalidAssociationFault

IllegalArgumentFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

deleteDocumentFolder

void deleteDocumentFolder(String sessionId,
                        String folderId)
                          throws RemoteException,
                                 IllegalArgumentFault,
                                 NoSuchObjectFault,
                                 InvalidSessionFault,
                                 InvalidOperationFault,
                                 SystemFault,
                                 PermissionDeniedFault

Throws:

RemoteException

IllegalArgumentFault

NoSuchObjectFault

InvalidSessionFault

InvalidOperationFault

SystemFault

PermissionDeniedFault

moveDocumentFolder

DocumentFolderSoapDO moveDocumentFolder(String sessionId,
                                      String folderId,
                                      String destFolderId)
                                        throws RemoteException,
                                               NoSuchObjectFault,
                                               InvalidSessionFault,
                                               SystemFault,
                                               PermissionDeniedFault

Throws:

RemoteException

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

getDocumentData

DocumentSoapDO getDocumentData(String sessionId,
                             String documentId,
                             int documentVersion)
                               throws RemoteException,
                                      NoSuchVersionFault,
                                      NoSuchObjectFault,
                                      InvalidSessionFault,
                                      SystemFault,
                                      PermissionDeniedFault

Throws:

RemoteException

NoSuchVersionFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

setDocumentData

void setDocumentData(String sessionId,
                   DocumentSoapDO documentData,
                   String fileId)
                     throws RemoteException,
                            InvalidDocumentContentFault,
                            VersionMismatchFault,
                            IllegalArgumentFault,
                            NoSuchObjectFault,
                            InvalidSessionFault,
                            SystemFault,
                            PermissionDeniedFault

Throws:

RemoteException

InvalidDocumentContentFault

VersionMismatchFault

IllegalArgumentFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

setDocumentDataWithAssociation

void setDocumentDataWithAssociation(String sessionId,
                                  DocumentSoapDO documentData,
                                  String fileId,
                                  String associationId,
                                  String associationComment)
                                    throws RemoteException,
                                           InvalidAssociationFault,
                                           InvalidDocumentContentFault,
                                           VersionMismatchFault,
                                           IllegalArgumentFault,
                                           NoSuchObjectFault,
                                           InvalidSessionFault,
                                           SystemFault,
                                           PermissionDeniedFault

Throws:

RemoteException

InvalidAssociationFault

InvalidDocumentContentFault

VersionMismatchFault

IllegalArgumentFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

setDocumentFolderData

void setDocumentFolderData(String sessionId,
                         DocumentFolderSoapDO documentFolderData)
                           throws RemoteException,
                                  VersionMismatchFault,
                                  IllegalArgumentFault,
                                  NoSuchObjectFault,
                                  InvalidSessionFault,
                                  SystemFault,
                                  PermissionDeniedFault

Throws:

RemoteException

VersionMismatchFault

IllegalArgumentFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

deleteDocument

void deleteDocument(String sessionId,
                  String documentId)
                    throws RemoteException,
                           NoSuchObjectFault,
                           InvalidSessionFault,
                           SystemFault,
                           PermissionDeniedFault

Throws:

RemoteException

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

moveDocument

DocumentSoapDO moveDocument(String sessionId,
                          String documentId,
                          String targetFolderId)
                            throws RemoteException,
                                   NoSuchObjectFault,
                                   InvalidSessionFault,
                                   SystemFault,
                                   PermissionDeniedFault

Throws:

RemoteException

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

createDocumentFolder

DocumentFolderSoapDO createDocumentFolder(String sessionId,
                                        String parentId,
                                        String title,
                                        String description)
                                          throws RemoteException,
                                                 IllegalArgumentFault,
                                                 ObjectAlreadyExistsFault,
                                                 NoSuchObjectFault,
                                                 InvalidSessionFault,
                                                 SystemFault,
                                                 PermissionDeniedFault

Throws:

RemoteException

IllegalArgumentFault

ObjectAlreadyExistsFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

getDocumentFolderData

DocumentFolderSoapDO getDocumentFolderData(String sessionId,
                                         String folderId)
                                           throws RemoteException,
                                                  IllegalArgumentFault,
                                                  NoSuchObjectFault,
                                                  InvalidSessionFault,
                                                  SystemFault,
                                                  PermissionDeniedFault

Throws:

RemoteException

IllegalArgumentFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

createReview

DocumentReviewSoapDO createReview(String sessionId,
                                String documentId,
                                int version,
                                String title,
                                String description,
                                Calendar dueDate,
                                String[] requiredReviewers,
                                String[] optionalReviewers,
                                boolean attachDocument)
                                  throws RemoteException,
                                         IllegalArgumentFault,
                                         ObjectAlreadyExistsFault,
                                         NoSuchObjectFault,
                                         InvalidSessionFault,
                                         SystemFault,
                                         PermissionDeniedFault

Throws:

RemoteException

IllegalArgumentFault

ObjectAlreadyExistsFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

getDocumentFolderList

DocumentFolderSoapList getDocumentFolderList(String sessionId,
                                           String parentId,
                                           boolean recursive)
                                             throws RemoteException,
                                                    NoSuchObjectFault,
                                                    InvalidSessionFault,
                                                    SystemFault,
                                                    PermissionDeniedFault

Throws:

RemoteException

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

getAssignedDocumentReviewList

DocumentReviewSoapList getAssignedDocumentReviewList(String sessionId,
                                                   String username)
                                                     throws RemoteException,
                                                            NoSuchObjectFault,
                                                            InvalidSessionFault,
                                                            SystemFault,
                                                            PermissionDeniedFault

Throws:

RemoteException

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

getDocumentReviewList

DocumentReviewSoapList getDocumentReviewList(String sessionId,
                                           String containerId,
                                           SoapFilter[] filters)
                                             throws RemoteException,
                                                    InvalidFilterFault,
                                                    NoSuchObjectFault,
                                                    InvalidSessionFault,
                                                    SystemFault,
                                                    PermissionDeniedFault

Throws:

RemoteException

InvalidFilterFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

getDocumentList

DocumentSoapList getDocumentList(String sessionId,
                               String parentId,
                               SoapFilter[] filters)
                                 throws RemoteException,
                                        InvalidFilterFault,
                                        NoSuchObjectFault,
                                        InvalidSessionFault,
                                        SystemFault,
                                        PermissionDeniedFault

Throws:

RemoteException

InvalidFilterFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

findDocuments

DocumentSoapList findDocuments(String sessionId,
                             String queryString,
                             String projectId,
                             boolean searchAttachments,
                             boolean currentVersionsOnly)
                               throws RemoteException,
                                      SearchQuerySyntaxFault,
                                      NoSuchObjectFault,
                                      InvalidSessionFault,
                                      SystemFault

Throws:

RemoteException

SearchQuerySyntaxFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

createDocumentWithUrl

DocumentSoapDO createDocumentWithUrl(String sessionId,
                                   String parentId,
                                   String title,
                                   String description,
                                   String versionComment,
                                   String status,
                                   boolean createLocked,
                                   String fileUrl,
                                   String associationId,
                                   String associationDesc)
                                     throws RemoteException,
                                            InvalidAssociationFault,
                                            InvalidDocumentContentFault,
                                            IllegalArgumentFault,
                                            NoSuchObjectFault,
                                            InvalidSessionFault,
                                            SystemFault,
                                            PermissionDeniedFault

Throws:

RemoteException

InvalidAssociationFault

InvalidDocumentContentFault

IllegalArgumentFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault

getDocumentFileId

String getDocumentFileId(String sessionId,
                       String documentId,
                       int documentVersion)
                         throws RemoteException,
                                NoSuchVersionFault,
                                NoSuchObjectFault,
                                InvalidSessionFault,
                                SystemFault,
                                PermissionDeniedFault

Throws:

RemoteException

NoSuchVersionFault

NoSuchObjectFault

InvalidSessionFault

SystemFault

PermissionDeniedFault