Interface IWikiAppSoap
- All Known Implementing Classes:
WikiAppSoap
,WikiAppSoapMockStub
,WikiAppSoapStub
public interface IWikiAppSoap
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Attaches the uploaded file to the specified wiki page.void
addAttachments
(String sessionId, String wikiPageId, AttachmentSoapDO[] attachments) Attaches the uploaded file to the specified wiki page.createWikiPage
(String sessionId, String projectId, String name, String wikiText, String versionComment) Creates a new wiki page with the specified name, text, etc.void
deleteWikiPage
(String sessionId, String wikiPageId) Deletes a wiki page.getFormattedWikiPageText
(String sessionId, String wikiPageId) Gets specified wiki page text in formatted (HTML) form.getWikiPageData
(String sessionId, String wikiPageId) Gets specified wiki page data.getWikiPageDataByName
(String sessionId, String projectId, String wikiPageName) Gets specified wiki page text in formatted (HTML) form.getWikiPageList
(String sessionId, String projectId) Lists all wiki pages that have contents within a project.void
setWikiPageData
(String sessionId, WikiPageSoapDO wikiPageData) Sets specified wiki page data.
-
Method Details
-
createWikiPage
WikiPageSoapDO createWikiPage(String sessionId, String projectId, String name, String wikiText, String versionComment) throws RemoteException Creates a new wiki page with the specified name, text, etc.- Parameters:
sessionId
- SOAP session id.projectId
- Project in which to create a wiki page.name
- Wiki page name.wikiText
- Wiki text for the page.versionComment
- Wiki page version comment.- Returns:
- Wiki page data object.
- Throws:
InvalidSessionFault
- when the sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when the specified object is invalid.IllegalArgumentFault
- when one or more of the parameters are invalid.ObjectAlreadyExistsFault
- when a page with the specified name already exists in the projectSystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.3
-
deleteWikiPage
Deletes a wiki page.- Parameters:
sessionId
- User session id.wikiPageId
- Wiki page id.- Throws:
InvalidSessionFault
- when the sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when the specified object is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.3
-
getWikiPageData
Gets specified wiki page data.- Parameters:
sessionId
- User session id.wikiPageId
- Wiki page id.- Returns:
- Wiki page data object.
- Throws:
IllegalArgumentFault
- when the method argument(s) are invalidInvalidSessionFault
- when the sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when the specified object is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.3
-
getFormattedWikiPageText
Gets specified wiki page text in formatted (HTML) form.- Parameters:
sessionId
- User session id.wikiPageId
- Wiki page id.- Returns:
- Wiki page text in formatted form.
- Throws:
IllegalArgumentFault
- when the method argument(s) are invalidInvalidSessionFault
- when the sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when the specified object is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.3
-
getWikiPageDataByName
WikiPageSoapDO getWikiPageDataByName(String sessionId, String projectId, String wikiPageName) throws RemoteException Gets specified wiki page text in formatted (HTML) form. "HomePage" is the default Wiki application home page.- Parameters:
sessionId
- User session id.projectId
- Project id.wikiPageName
- Name of the wiki page.- Returns:
- Wiki page text in formatted form.
- Throws:
IllegalArgumentFault
- when the method argument(s) are invalidInvalidSessionFault
- when the sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when the specified object is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.3
-
getWikiPageList
Lists all wiki pages that have contents within a project.- Parameters:
sessionId
- User session id.projectId
- Project id.- Returns:
- wiki page list
- Throws:
IllegalArgumentFault
- when the method argument(s) are invalidInvalidSessionFault
- when the sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when the specified object is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.3 SP1 HOTFIX1
-
setWikiPageData
Sets specified wiki page data.- Parameters:
sessionId
- User session id.wikiPageData
- Wiki page data object.- Throws:
InvalidSessionFault
- when the sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when the specified object is invalid.IllegalArgumentFault
- when wiki page data information is invalid.VersionMismatchFault
- when wiki page data is stale.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.3
-
addAttachment
void addAttachment(String sessionId, String wikiPageId, String fileId, String filename, String mimetype) throws RemoteException Attaches the uploaded file to the specified wiki page.- Parameters:
sessionId
- User session id.wikiPageId
- Wiki page id.fileId
- Attachment file ID returned by FileStorageApp/SimpleFileStorageApp webservice.filename
- Attachment file name.mimetype
- Attachment file type.- Throws:
InvalidSessionFault
- when the sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when the specified object is invalid.NoSuchVersionFault
- when the specified version is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 4.3
-
addAttachments
void addAttachments(String sessionId, String wikiPageId, AttachmentSoapDO[] attachments) throws RemoteException Attaches the uploaded file to the specified wiki page.- Parameters:
sessionId
- User session id.wikiPageId
- Wiki page id.attachments
- AttachmentSoapDO.- Throws:
InvalidSessionFault
- when the sessionId is invalid.PermissionDeniedFault
- when permission is denied for the specified operation.NoSuchObjectFault
- when the specified object is invalid.NoSuchVersionFault
- when the specified version is invalid.SystemFault
- when an unexpected system error occurs.RemoteException
- Since:
- 6.2
-