Package wt.epm.upload

Interface EPMUploadManager

All Known Implementing Classes:

EPMStandardUploadManager

@RemoteInterface
public interface EPMUploadManager

Supported API: true

Extendable: false

Method Summary

Modifier and Type	Method	Description
EPMCacheInterface	upload(EPMWorkspace workspace, EPMNeutralData neutralData)	Uploades documents and family tables to a workspace.
EPMCacheInterface	upload(EPMWorkspace workspace, EPMNeutralData neutralData, Collection<String> instanceCADNames)	Uploads documents and family tables to a workspace.
WTSet	uploadAndCheckin(EPMWorkspace workspace, EPMNeutralData neutralData)	Uploads documents to a workspace and checks them in.
WTSet	uploadAndCheckin(EPMWorkspace workspace, EPMNeutralData neutralData, Map checkinData)	Uploads documents to a workspace and checks them in.

Method Details

upload

EPMCacheInterface upload(EPMWorkspace workspace,
 EPMNeutralData neutralData)
                  throws WTException

Uploades documents and family tables to a workspace.

Supported API: true

Parameters:

workspace -

neutralData -

Returns:

EPMCacheInterface

Throws:

WTException

upload

EPMCacheInterface upload(EPMWorkspace workspace,
 EPMNeutralData neutralData,
 Collection<String> instanceCADNames)
                  throws WTException

Uploads documents and family tables to a workspace. Provides family table checkout to upload instances without iterating generic, if instance CAD names are specified.

Supported API: true

Parameters:

workspace -

neutralData - the neutral data of documents to be uploaded to a specified workspace If instanceCADNames specified: - relevant Family Table will be verified for latest version/iteration and not checked out by other user: if the verification will be not successful, the upload will fail with WTException - Family Table for specified instances will be checked out, if exist and not checked out on workspace - corresponding instances from neutralData will be created and added to checked out Family Table without iterating generic

Collection - instanceCADNames, if null or empty

Returns:

EPMCacheInterface

Throws:

WTException

uploadAndCheckin

WTSet uploadAndCheckin(EPMWorkspace workspace,
 EPMNeutralData neutralData)
                throws WTException

Uploads documents to a workspace and checks them in. The returning result is similar to EPMWorkspaceManager.checkin result. All the uploaded documents will be checked in with default checkin options.

Supported API: true

Parameters:

workspace -

neutralData - the neutral data of documents to be uploaded to a specified workspace

Returns:

WTSet

Throws:

WTException

uploadAndCheckin

WTSet uploadAndCheckin(EPMWorkspace workspace,
 EPMNeutralData neutralData,
 Map checkinData)
                throws WTException

Uploads documents to a workspace and checks them in. The returning result is similar to EPMWorkspaceManager.checkin result.

Supported API: true

Parameters:

workspace -

neutralData - the neutral data of documents to be uploaded to a specified workspace

checkinData - the map which contains CAD Name to CheckinOption relations. If the map is not null and does not contain CheckinOption for an uploaded CAD Name - this document will be checked in with the default options. It may be null - in this case all the uploaded documents will be checked in with the default CheckinOption (see EPMWorkspaceManager.checkin for more details).

Returns:

WTSet

Throws:

WTException