com.ptc.netmarkets.nmixb
Interface NmIxbService

All Known Implementing Classes:

NmIxbServiceFwd, StandardNmIxbService

public interface NmIxbService

Supported API: false

Extendable: false

Method Summary

URL	exportContainerAsExternalTemplate(ObjectIdentifier projectOid, String archiveName, TemplateGeneratorWorklist worklist, GeneratedTemplateAttributes attrs) This method creates a jar file and genreates an url that can be used by the client to download the file.
URL	exportDocument(ObjectIdentifier docOid, String archiveName) This method exports a document into a file called called document-name.zip by getting the document name and passing it in to the method with the name in the signature.
URL	exportDocuments(ObjectIdentifier[] docOids, String archiveName) This method exports a set of documents into a file called called file-name.zip by getting the document name and passing it in to the method with the name in the signature.
URL	exportFolderContentsWithMetadata(ObjectIdentifier folderOid, String archiveName) This method exports a set of objects in a given folder.
URL	exportFolderFiles(ObjectIdentifier folderOid, String archiveName) Supported API: false
URL	exportProject(ObjectIdentifier projectOid, String archiveName) Supported API: false
URL	exportProjectDeliverables(ObjectIdentifier projectOid, String archiveName) This method exports all Deliverables for the project.
URL	exportProjectDocuments(ObjectIdentifier projectOid, String archiveName, boolean includeFolderStructure, boolean includeViewables) This method exports all documents in the project.
URL	exportProjectFiles(ObjectIdentifier projectOid, String archiveName) Supported API: false
URL	exportProjectFolders(ObjectIdentifier projectOid, String archiveName) This method exports all Folders for the project.
URL	exportProjectParts(ObjectIdentifier projectOid, String archiveName, boolean includeFolderStructure, boolean includeViewables) This method exports all parts in the project.
URL	exportProjectPlan(ObjectIdentifier projectOid, String archiveName) This method exports all Deliverables for the project.
URL	exportProjectTeam(ObjectIdentifier projectOid, String archiveName, boolean doMembers) This method exports all teams in the project.
URL	exportProjectTemplateNodes(ObjectIdentifier projectOid, String archiveName, boolean doMilestones, boolean doActivities) This method exports the ProjectPlan including only a subset of nodes.
void	importDocumentsIntoFolder(ObjectIdentifier folderOid, String archiveName) This method imports the contents of the file into a folder.
void	importIntoContainer(ObjectIdentifier containerOid, String archiveName) Imports metadata and content into a container See the documentation for the supported types.
void	resetArchiveMode() Imports metadata and content into a container See the documentation for the supported types.
void	setArchiveMode(boolean archiveMode) Imports metadata and content into a container See the documentation for the supported types.

Method Detail

exportDocument

public URL exportDocument(ObjectIdentifier docOid,
                          String archiveName)
                   throws WTException

This method exports a document into a file called called document-name.zip by getting the document name and passing it in to the method with the name in the signature. The returned URL is the redirectURL to initiate the download from.

Supported API: false

Parameters:

docOid -

archiveName -

Returns:

URL

Throws:

WTException

exportDocuments

public URL exportDocuments(ObjectIdentifier[] docOids,
                           String archiveName)
                    throws WTException

This method exports a set of documents into a file called called file-name.zip by getting the document name and passing it in to the method with the name in the signature. The returned URL is the redirectURL to initiate the download from.

Supported API: false

Parameters:

docOids -

archiveName -

Returns:

URL

Throws:

WTException

exportProject

public URL exportProject(ObjectIdentifier projectOid,
                         String archiveName)
                  throws WTException

Supported API: false

Parameters:

projectOid -

archiveName -

Returns:

URL

Throws:

WTException

exportProjectFiles

public URL exportProjectFiles(ObjectIdentifier projectOid,
                              String archiveName)
                       throws WTException

Supported API: false

Parameters:

projectOid -

archiveName -

Returns:

URL

Throws:

WTException

exportFolderContentsWithMetadata

public URL exportFolderContentsWithMetadata(ObjectIdentifier folderOid,
                                            String archiveName)
                                     throws WTException

This method exports a set of objects in a given folder. It does NOT export the full product structure.. The returned URL is the redirectURL to initiate the download from. You should append this to the base url of your download mechanism.

Supported API: false

Parameters:

folderOid -

archiveName -

Returns:

URL

Throws:

WTException

exportFolderFiles

public URL exportFolderFiles(ObjectIdentifier folderOid,
                             String archiveName)
                      throws WTException

Supported API: false

Parameters:

folderOid -

archiveName -

Returns:

URL

Throws:

WTException

exportProjectTeam

public URL exportProjectTeam(ObjectIdentifier projectOid,
                             String archiveName,
                             boolean doMembers)
                      throws WTException

This method exports all teams in the project. The result is a ProjectConfig XML document consistng of a projectMembership tags. The returned URL is the redirectURL to initiate the download from Typeical usage would involve adding this URL to the base url of your chosen transport mechansim.

Supported API: false

Parameters:

projectOid -

archiveName -

doMembers - If set to true, the projectmembers will be exported. If set to false, only the roles will be exported.

Returns:

URL

Throws:

WTException

exportProjectDeliverables

public URL exportProjectDeliverables(ObjectIdentifier projectOid,
                                     String archiveName)
                              throws WTException

This method exports all Deliverables for the project. The returned URL is the redirectURL to initiate the download from Typical usage of this would involve adding this URL to the base url of your chosen transport mechansim.

Supported API: false

Parameters:

projectOid -

archiveName -

Returns:

URL

Throws:

WTException

exportProjectPlan

public URL exportProjectPlan(ObjectIdentifier projectOid,
                             String archiveName)
                      throws WTException

This method exports all Deliverables for the project. The returned URL is the redirectURL to initiate the download from Typical usage of this would involve adding this URL to the base url of your chosen transport mechansim.

Supported API: false

Parameters:

projectOid -

archiveName -

Returns:

URL

Throws:

WTException

importDocumentsIntoFolder

public void importDocumentsIntoFolder(ObjectIdentifier folderOid,
                                      String archiveName)
                               throws WTException

This method imports the contents of the file into a folder. An exception is thrown if there is no metadata. In this release only documents are supported. The default policy is to add a new iteration to duplicate bjects based on the meta-data name and number. (This means that if you export from folder A and then import into folder B, the document will no longer be seen in Folder A since its location has been changed. )

Supported API: false

Parameters:

folderOid -

archiveName -

Throws:

WTException

exportProjectFolders

public URL exportProjectFolders(ObjectIdentifier projectOid,
                                String archiveName)
                         throws WTException

This method exports all Folders for the project. The returned URL is the redirectURL to initiate the download from Typical usage of this would involve adding this URL to the base url of your chosen transport mechansim.

Supported API: false

Parameters:

projectOid -

archiveName -

Returns:

URL

Throws:

WTException

exportProjectDocuments

public URL exportProjectDocuments(ObjectIdentifier projectOid,
                                  String archiveName,
                                  boolean includeFolderStructure,
                                  boolean includeViewables)
                           throws WTException

This method exports all documents in the project. The returned URL is the redirectURL to initiate the download from Typical usage of this would involve adding this URL to the base url of your chosen transport mechansim.

Supported API: false

Parameters:

projectOid -

archiveName -

includeFolderStructure -

includeViewables -

Returns:

URL

Throws:

WTException

exportProjectParts

public URL exportProjectParts(ObjectIdentifier projectOid,
                              String archiveName,
                              boolean includeFolderStructure,
                              boolean includeViewables)
                       throws WTException

This method exports all parts in the project. The returned URL is the redirectURL to initiate the download from Typical usage of this would involve adding this URL to the base url of your chosen transport mechansim.

Supported API: false

Parameters:

projectOid -

archiveName -

includeFolderStructure -

includeViewables -

Returns:

URL

Throws:

WTException

exportProjectTemplateNodes

public URL exportProjectTemplateNodes(ObjectIdentifier projectOid,
                                      String archiveName,
                                      boolean doMilestones,
                                      boolean doActivities)
                               throws WTException

This method exports the ProjectPlan including only a subset of nodes. You restrict the nodes to either ProjectActivity nodes, or Milestone nodes. The returned URL is the redirectURL to initiate the download from Typical usage of this would involve adding this URL to the base url of your chosen transport mechansim.

Supported API: false

Parameters:

projectOid -

archiveName -

doMilestones -

doActivities -

Returns:

URL

Throws:

WTException

exportContainerAsExternalTemplate

public URL exportContainerAsExternalTemplate(ObjectIdentifier projectOid,
                                             String archiveName,
                                             TemplateGeneratorWorklist worklist,
                                             GeneratedTemplateAttributes attrs)
                                      throws WTException

This method creates a jar file and genreates an url that can be used by the client to download the file. This ObjectIdentifier must correspond to the container to be exported. If the object is not a WTContainer an exception will be thrown The return value is an URL pointing to the jar file that is suitable for loading into external systems via a reference mechanism. This is a secure URL from the standpoint that it cannot be hijacked, and it cannot be re-used. The caller is responsible for cleaning up the generated file after download completes.

Supported API: false

Parameters:

projectOid -

archiveName -

worklist -

attrs - This contains the attributes of the template export file. To create this argument use the following code... import wt.inf.template.GeneratedTemplateAttributes; GeneratedTemplateAttributes attrs = new GeneratedTemplateAttributes(name,containerClassName) //set other available attributes as desired

Returns:

URL

Throws:

WTException

importIntoContainer

public void importIntoContainer(ObjectIdentifier containerOid,
                                String archiveName)
                         throws WTException

Imports metadata and content into a container See the documentation for the supported types.

Supported API: false

Parameters:

containerOid -

archiveName -

Throws:

WTException

setArchiveMode

public void setArchiveMode(boolean archiveMode)
                    throws WTException

Imports metadata and content into a container See the documentation for the supported types.

Supported API: false

Parameters:

archiveMode -

Throws:

WTException

resetArchiveMode

public void resetArchiveMode()
                      throws WTException

Imports metadata and content into a container See the documentation for the supported types.

Supported API: false

Throws:

WTException