public class PageAppSoapStub extends com.collabnet.ce.soap60.webservices.ClientSoapStub implements IPageAppSoap
Constructor and Description |
---|
PageAppSoapStub(String soapServerUrl) |
Modifier and Type | Method and Description |
---|---|
String |
addPageImage(String sessionId,
String projectId,
String fileId,
String filename,
String mimetype)
Adds an uploaded file as an image for a page.
|
PageComponentSoapDO |
createComponent(String sessionId,
String pageId,
String compName,
String componentType,
boolean topOfPage,
int visibility,
com.collabnet.ce.soap60.types.SoapNamedValues attributes,
String content)
Creates a page component.
|
PageComponent2SoapDO |
createComponent2(String sessionId,
String pageId,
String compName,
String componentType,
boolean topOfPage,
int visibility,
com.collabnet.ce.soap60.types.SoapNamedValues attributes,
String content)
Creates a page component.
|
PageSoapDO |
createPage(String sessionId,
String projectId,
String parentId,
String title,
boolean visible,
boolean freeform)
Creates a new project page.
|
void |
deletePage(String sessionId,
String pageId)
Deletes an existing page
|
void |
deletePageComponent(String sessionId,
String pageComponentId)
Deletes an existing page component
|
void |
deletePageImage(String sessionId,
String projectId,
String attachmentId)
Deletes the specified attachment of the specified object.
|
PageComponent2SoapDO |
getPageComponent(String sessionId,
String pageComponentId)
Gets page component meta data and settings for a given page component id.
|
PageComponentSoapDO[] |
getPageComponents(String sessionId,
String pageId)
Gets an array of page components for a page (in the correct order)
|
PageSoapDO |
getPageData(String sessionId,
String pageId)
Gets a project page.
|
String |
getPageImageUrl(String sessionId,
String projectId,
String attachmentId)
Gets relative URL to access to the uploaded image from an HTML page.
|
PageSoapList |
getPageList(String sessionId,
String projectId)
Gets all pages for a user in the specified project (in the correct order).
|
String |
getTextComponentContent(String sessionId,
String pageCompId)
Gets the content of a Text component.
|
AttachmentSoapList |
listPageImages(String sessionId,
String projectId)
Lists the images for a project.
|
void |
movePage(String sessionId,
String pageFolderPath,
String destPath)
Moves a page (including sub pages and contents).
|
void |
setComponentDisplayOrder(String sessionId,
String pageId,
String[] componentIds)
Sets the display order for components within a page
|
void |
setLifecycleMetricComponentContent(String sessionId,
PageComponent2SoapDO pageComponent,
String content)
Sets Lifecycle metric component.
|
void |
setPageComponentData(String sessionId,
PageComponentSoapDO pageComponent)
Updates a page component
|
void |
setPageData(String sessionId,
PageSoapDO pageData)
Edits an existing page.
|
boolean |
setPageDisplayOrder(String sessionId,
String folderId,
String[] childrenPageIds)
Sets the page display order.
|
void |
setTextComponentContent(String sessionId,
String pageCompId,
String content)
Sets the content of a Text component.
|
public PageAppSoapStub(String soapServerUrl)
public PageSoapDO getPageData(String sessionId, String pageId) throws RemoteException
IPageAppSoap
getPageData
in interface IPageAppSoap
sessionId
- User session id.pageId
- the pageId for which data is to be fetched.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public String getTextComponentContent(String sessionId, String pageCompId) throws RemoteException
IPageAppSoap
getTextComponentContent
in interface IPageAppSoap
sessionId
- User session id.pageCompId
- page component id for which the content/source is to be fetched.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.InvalidComponentTypeFault
- if the type of the component is not Textcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public void setTextComponentContent(String sessionId, String pageCompId, String content) throws RemoteException
IPageAppSoap
setTextComponentContent
in interface IPageAppSoap
sessionId
- User session id.pageCompId
- page component id for which the content/source is to be fetched.content
- the new contentcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.InvalidComponentTypeFault
- if the type of the component is not Textcom.collabnet.ce.soap60.fault.VersionMismatchFault
- when component data is stalecom.collabnet.ce.soap60.fault.IllegalArgumentFault
- for invalid contentcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public void setLifecycleMetricComponentContent(String sessionId, PageComponent2SoapDO pageComponent, String content) throws RemoteException
IPageAppSoap
setLifecycleMetricComponentContent
in interface IPageAppSoap
sessionId
- User session id.pageComponent
- the page component to be updated.content
- the html contentcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.InvalidComponentTypeFault
- if the type of the component is not metricscom.collabnet.ce.soap60.fault.VersionMismatchFault
- when component data is stalecom.collabnet.ce.soap60.fault.IllegalArgumentFault
- for invalid contentcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public PageSoapList getPageList(String sessionId, String projectId) throws RemoteException
IPageAppSoap
getPageList
in interface IPageAppSoap
sessionId
- User session id.projectId
- the project for which the pages are to be fetchedcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public PageSoapDO createPage(String sessionId, String projectId, String parentId, String title, boolean visible, boolean freeform) throws RemoteException
IPageAppSoap
createPage
in interface IPageAppSoap
sessionId
- User session id.projectId
- Id of the project in which the page is to be createdparentId
- parent folder id under which the page is to be created, if null
then a top level page under the project will be created.title
- title of the pagevisible
- visibility of the pagefreeform
- true if the page link must be hidden in the left navigationcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- If a page with the same name already exists in the projectcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public void setPageData(String sessionId, PageSoapDO pageData) throws RemoteException
IPageAppSoap
setPageData
in interface IPageAppSoap
sessionId
- User session id.pageData
- the page to be edited.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.VersionMismatchFault
- when page data is stalecom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public PageComponentSoapDO[] getPageComponents(String sessionId, String pageId) throws RemoteException
IPageAppSoap
getPageComponents
in interface IPageAppSoap
sessionId
- User session id.pageId
- the id of the page from which to get the list of componentscom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public void deletePage(String sessionId, String pageId) throws RemoteException
IPageAppSoap
deletePage
in interface IPageAppSoap
sessionId
- User session id.pageId
- the page to be deleted.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.CannotDeleteHomePageFault
- when the user tries to delete the home page.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public void deletePageComponent(String sessionId, String pageComponentId) throws RemoteException
IPageAppSoap
deletePageComponent
in interface IPageAppSoap
sessionId
- User session id.pageComponentId
- the id of the page component to be deleted.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the specified page id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public void setComponentDisplayOrder(String sessionId, String pageId, String[] componentIds) throws RemoteException
IPageAppSoap
setComponentDisplayOrder
in interface IPageAppSoap
sessionId
- User session id.pageId
- the id of the page where the components belongcomponentIds
- ids of component in the order which is to be setcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public PageComponentSoapDO createComponent(String sessionId, String pageId, String compName, String componentType, boolean topOfPage, int visibility, com.collabnet.ce.soap60.types.SoapNamedValues attributes, String content) throws RemoteException
IPageAppSoap
createComponent
in interface IPageAppSoap
sessionId
- User session id.pageId
- the id of the page where the component is to be created.compName
- component namecomponentType
- component type. Valid component types are defined as constants in PageComponentSoapDO
.topOfPage
- true if the component is to be created at top of the pagevisibility
- defines the visibility of this component, 1= visible, 0 = hidden.attributes
- component attributes. The values varies with the component: COMPONENT_TYPE_DOCUMENTS
, attribute documentFolder
must be specified.COMPONENT_TYPE_GRAPH
, no attributes are required but cannot be null.COMPONENT_TYPE_TEXT
, no attributes are required but cannot be null.COMPONENT_TYPE_NEWS
, no attributes are required but cannot be null.COMPONENT_TYPE_TRACKER
, attributes trackerSearchesIds
and count
must be specified.COMPONENT_TYPE_WIKI
, attribute wikiTopic
must be specified.COMPONENT_TYPE_SUBPROJECTS
, attribute subprojects
must be specified.PageComponentSoapDO
has constant declarations for all attribute keys to be used for the attributes.content
- text component content, applicable for Text components and Lifecycle metrics components.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- for incorrect parameter valuescom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- If a component with the same name already exists in the pagecom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public PageComponent2SoapDO createComponent2(String sessionId, String pageId, String compName, String componentType, boolean topOfPage, int visibility, com.collabnet.ce.soap60.types.SoapNamedValues attributes, String content) throws RemoteException
IPageAppSoap
createComponent
but also creates COMPONENT_TYPE_LIFECYCLE_METRICS
and returns PageComponent2SoapDO
object. For COMPONENT_TYPE_TEXT
and COMPONENT_TYPE_LIFECYCLE_METRICS
html source can be fetched from readOnlyTextSource
property of PageComponent2SoapDO
createComponent2
in interface IPageAppSoap
sessionId
- User session id.pageId
- the id of the page where the component is to be created.compName
- component namecomponentType
- component type. Valid component types are defined as constants in PageComponent2SoapDO
.topOfPage
- true if the component is to be created at top of the pagevisibility
- defines the visibility of this component, 1= visible, 0 = hidden.attributes
- component attributes. The values varies with the component: COMPONENT_TYPE_DOCUMENTS
, attribute documentFolder
must be specified.COMPONENT_TYPE_GRAPH
, no attributes are required but cannot be null.COMPONENT_TYPE_TEXT
, no attributes are required but cannot be null.COMPONENT_TYPE_LIFECYCLE_METRICS
, no attributes are required but cannot be null.COMPONENT_TYPE_NEWS
, no attributes are required but cannot be null.COMPONENT_TYPE_TRACKER
, attributes trackerSearchesIds
and count
must be specified.COMPONENT_TYPE_WIKI
, attribute wikiTopic
must be specified.COMPONENT_TYPE_SUBPROJECTS
, attribute subprojects
must be specified.PageComponent2SoapDO
has constant declarations for all attribute keys to be used for the attributes.content
- text component content, applicable for Text components and Lifecycle metrics components.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- for incorrect parameter valuescom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- If a component with the same name already exists in the pagecom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public void setPageComponentData(String sessionId, PageComponentSoapDO pageComponent) throws RemoteException
IPageAppSoap
setPageComponentData
in interface IPageAppSoap
sessionId
- User session id.pageComponent
- the page component to be updated.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the specified page id is invalid.com.collabnet.ce.soap60.fault.VersionMismatchFault
- when the component data is stale.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- for incorrect data.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public boolean setPageDisplayOrder(String sessionId, String folderId, String[] childrenPageIds) throws RemoteException
IPageAppSoap
setPageDisplayOrder
in interface IPageAppSoap
sessionId
- User session id.folderId
- the folder to be used.childrenPageIds
- page keys in the new intended order based on array order must pass in all pages.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public void movePage(String sessionId, String pageFolderPath, String destPath) throws RemoteException
IPageAppSoap
movePage
in interface IPageAppSoap
sessionId
- User session id.pageFolderPath
- The path to the page to movedestPath
- The path of the destination parent foldercom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified folder component id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
public String addPageImage(String sessionId, String projectId, String fileId, String filename, String mimetype) throws RemoteException
IPageAppSoap
addPageImage
in interface IPageAppSoap
sessionId
- User session id.projectId
- Project id.fileId
- Image file ID returned by FileStorageApp/SimpleFileStorageApp webservice.filename
- Image file name.mimetype
- Image file type.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
public AttachmentSoapList listPageImages(String sessionId, String projectId) throws RemoteException
IPageAppSoap
listPageImages
in interface IPageAppSoap
sessionId
- User session id.projectId
- Project id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
public String getPageImageUrl(String sessionId, String projectId, String attachmentId) throws RemoteException
IPageAppSoap
getPageImageUrl
in interface IPageAppSoap
sessionId
- User session id.projectId
- Project id.attachmentId
- Attachment id of the image.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permission is denied for the specified operation.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
public void deletePageImage(String sessionId, String projectId, String attachmentId) throws RemoteException
IPageAppSoap
deletePageImage
in interface IPageAppSoap
sessionId
- User session id.projectId
- Project id.attachmentId
- The attachment id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
public PageComponent2SoapDO getPageComponent(String sessionId, String pageComponentId) throws RemoteException
IPageAppSoap
COMPONENT_TYPE_TEXT
and COMPONENT_TYPE_LIFECYCLE_METRICS
html source can be fetched from readOnlyTextSource
property of PageComponent2SoapDO
getPageComponent
in interface IPageAppSoap
sessionId
- User session id.pageComponentId
- the id of the page component from which to get the componentcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified page component id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
Copyright © 2016 CollabNet. All Rights Reserved.