Package | Description |
---|---|
com.docdoku.core.services |
Modifier and Type | Method and Description |
---|---|
DocumentMaster |
IDocumentManagerLocal.approve(String pWorkspaceId,
TaskKey pTaskKey,
String pComment) |
DocumentMaster |
IDocumentManagerWS.approve(String workspaceId,
TaskKey taskKey,
String comment) |
DocumentMaster |
IDocumentManagerLocal.checkInDocument(DocumentMasterKey pDocMPK) |
DocumentMaster |
IDocumentManagerWS.checkInDocument(DocumentMasterKey docMPK) |
PartRevision |
IProductManagerLocal.checkInPart(PartRevisionKey pPartRPK) |
PartRevision |
IProductManagerWS.checkInPart(PartRevisionKey partRPK)
Checks in the supplied part revision so its latest iteration,
that carries the modifications realized since the checkout operation,
will be published and made visible to all users.
|
DocumentMaster |
IDocumentManagerLocal.checkOutDocument(DocumentMasterKey pDocMPK) |
DocumentMaster |
IDocumentManagerWS.checkOutDocument(DocumentMasterKey docMPK) |
PartRevision |
IProductManagerLocal.checkOutPart(PartRevisionKey pPartRPK) |
PartRevision |
IProductManagerWS.checkOutPart(PartRevisionKey partRPK)
Checks out the supplied part revision to allow the operating user to modify it.
|
User |
IUserManagerLocal.checkWorkspaceReadAccess(String pWorkspaceId) |
User |
IUserManagerLocal.checkWorkspaceWriteAccess(String pWorkspaceId) |
ConfigurationItem |
IProductManagerLocal.createConfigurationItem(String pWorkspaceId,
String pId,
String pDescription,
String pDesignItemNumber) |
ConfigurationItem |
IProductManagerWS.createConfigurationItem(String workspaceId,
String id,
String description,
String designItemNumber)
Creates a new product structure.
|
DocumentMaster |
IDocumentManagerLocal.createDocumentMaster(String pParentFolder,
String pDocMId,
String pTitle,
String pDescription,
String pDocMTemplateId,
String pWorkflowModelId,
ACLUserEntry[] aclUserEntries,
ACLUserGroupEntry[] aclUserGroupEntries) |
DocumentMaster |
IDocumentManagerWS.createDocumentMaster(String parentFolder,
String docMId,
String title,
String description,
String docMTemplateId,
String workflowModelId,
ACLUserEntry[] aclUserEntries,
ACLUserGroupEntry[] aclUserGroupEntries) |
DocumentMasterTemplate |
IDocumentManagerLocal.createDocumentMasterTemplate(String pWorkspaceId,
String pId,
String pDocumentType,
String pMask,
InstanceAttributeTemplate[] pAttributeTemplates,
boolean idGenerated) |
DocumentMasterTemplate |
IDocumentManagerWS.createDocumentMasterTemplate(String workspaceId,
String id,
String documentType,
String mask,
InstanceAttributeTemplate[] attributeTemplates,
boolean idGenerated) |
Folder |
IDocumentManagerLocal.createFolder(String pParentFolder,
String pFolder) |
Folder |
IDocumentManagerWS.createFolder(String parentFolder,
String folder) |
Layer |
IProductManagerLocal.createLayer(ConfigurationItemKey pKey,
String pName) |
Layer |
IProductManagerWS.createLayer(ConfigurationItemKey key,
String name)
Creates a new layer on a given product structure.
|
Marker |
IProductManagerLocal.createMarker(int pLayerId,
String pTitle,
String pDescription,
double pX,
double pY,
double pZ) |
Marker |
IProductManagerWS.createMarker(int layerId,
String title,
String description,
double x,
double y,
double z)
Creates a new marker that will be a member of the given layer.
|
PartMaster |
IProductManagerLocal.createPartMaster(String pWorkspaceId,
String pNumber,
String pName,
String pPartMasterDescription,
boolean pStandardPart,
String pWorkflowModelId,
String pPartRevisionDescription) |
PartMaster |
IProductManagerWS.createPartMaster(String workspaceId,
String number,
String name,
String partMasterDescription,
boolean standardPart,
String workflowModelId,
String partRevisionDescription)
Creates a new PartMaster.
|
void |
IDocumentManagerLocal.createTag(String pWorkspaceId,
String pLabel) |
void |
IDocumentManagerWS.createTag(String workspaceId,
String label) |
DocumentMaster[] |
IDocumentManagerLocal.createVersion(DocumentMasterKey pOriginalDocMPK,
String pTitle,
String pDescription,
String pWorkflowModelId,
ACLUserEntry[] aclUserEntries,
ACLUserGroupEntry[] aclUserGroupEntries) |
DocumentMaster[] |
IDocumentManagerWS.createVersion(DocumentMasterKey originalDocMPK,
String title,
String description,
String workflowModelId,
ACLUserEntry[] aclUserEntries,
ACLUserGroupEntry[] aclUserGroupEntries) |
WorkflowModel |
IWorkflowManagerLocal.createWorkflowModel(String pWorkspaceId,
String pId,
String pFinalLifeCycleState,
ActivityModel[] pActivityModels) |
WorkflowModel |
IWorkflowManagerWS.createWorkflowModel(String pWorkspaceId,
String pId,
String pFinalLifeCycleState,
ActivityModel[] pActivityModels) |
void |
IProductManagerLocal.deleteConfigurationItem(ConfigurationItemKey configurationItemKey) |
void |
IProductManagerWS.deleteConfigurationItem(ConfigurationItemKey configurationItemKey) |
void |
IDocumentManagerLocal.deleteDocumentMaster(DocumentMasterKey pDocMPK) |
void |
IDocumentManagerWS.deleteDocumentMaster(DocumentMasterKey docMPK) |
void |
IDocumentManagerLocal.deleteDocumentMasterTemplate(DocumentMasterTemplateKey pKey) |
void |
IDocumentManagerWS.deleteDocumentMasterTemplate(DocumentMasterTemplateKey key) |
DocumentMasterKey[] |
IDocumentManagerLocal.deleteFolder(String pCompletePath) |
DocumentMasterKey[] |
IDocumentManagerWS.deleteFolder(String completePath) |
void |
IProductManagerLocal.deleteLayer(String workspaceId,
int layerId) |
void |
IProductManagerWS.deleteLayer(String workspaceId,
int layerId) |
void |
IProductManagerLocal.deleteMarker(int pLayerId,
int pMarkerId) |
void |
IDocumentManagerLocal.deleteTag(TagKey pKey) |
void |
IDocumentManagerWS.deleteTag(TagKey key) |
void |
IWorkflowManagerLocal.deleteWorkflowModel(WorkflowModelKey pKey) |
void |
IWorkflowManagerWS.deleteWorkflowModel(WorkflowModelKey pKey) |
DataHandler |
IUploadDownloadWS.downloadFromDocument(String workspaceId,
String docMId,
String docMVersion,
int iteration,
String fileName) |
DataHandler |
IUploadDownloadWS.downloadFromPart(String workspaceId,
String partMNumber,
String partRVersion,
int iteration,
String fileName) |
DataHandler |
IUploadDownloadWS.downloadFromTemplate(String workspaceId,
String templateId,
String fileName) |
DataHandler |
IUploadDownloadWS.downloadNativeFromPart(String workspaceId,
String partMNumber,
String partRVersion,
int iteration,
String fileName) |
PartUsageLink |
IProductManagerLocal.filterProductStructure(ConfigurationItemKey pKey,
ConfigSpec configSpec,
Integer partUsageLink,
Integer depth) |
PartUsageLink |
IProductManagerWS.filterProductStructure(ConfigurationItemKey ciKey,
ConfigSpec configSpec,
Integer partUsageLink,
Integer depth)
Resolves the product structure identified by the supplied
ConfigurationItemKey.
|
DocumentMaster[] |
IDocumentManagerLocal.findDocumentMastersByFolder(String pCompletePath) |
DocumentMaster[] |
IDocumentManagerWS.findDocumentMastersByFolder(String completePath) |
DocumentMaster[] |
IDocumentManagerLocal.findDocumentMastersByTag(TagKey pKey) |
DocumentMaster[] |
IDocumentManagerWS.findDocumentMastersByTag(TagKey key) |
List<PartMaster> |
IProductManagerLocal.findPartMasters(String pWorkspaceId,
String pPartNumber,
int pMaxResults) |
List<PartMaster> |
IProductManagerWS.findPartMasters(String workspaceId,
String partNumber,
int maxResults)
Finds part masters by their part number using like style query.
|
List<PartUsageLink[]> |
IProductManagerLocal.findPartUsages(ConfigurationItemKey pKey,
PartMasterKey pPartMKey) |
List<PartUsageLink[]> |
IProductManagerWS.findPartUsages(ConfigurationItemKey ciKey,
PartMasterKey partMKey)
Searchs all instances of a part and returns their paths, defined by a
serie of usage links, from the top of the structure to their own usage
link.
|
String |
IDocumentManagerLocal.generateId(String pWorkspaceId,
String pDocMTemplateId) |
String |
IDocumentManagerWS.generateId(String workspaceId,
String docMTemplateId) |
DocumentMaster[] |
IDocumentManagerLocal.getCheckedOutDocumentMasters(String pWorkspaceId) |
DocumentMaster[] |
IDocumentManagerWS.getCheckedOutDocumentMasters(String workspaceId) |
List<PartUsageLink> |
IProductManagerLocal.getComponents(PartIterationKey pPartIPK) |
List<PartUsageLink> |
IProductManagerWS.getComponents(PartIterationKey partIPK)
Fetches the components of the supplied part assembly
|
List<ConfigurationItem> |
IProductManagerLocal.getConfigurationItems(String pWorkspaceId) |
List<ConfigurationItem> |
IProductManagerWS.getConfigurationItems(String workspaceId)
Retrieves all product structures that belong to the given workspace.
|
File |
IDocumentManagerLocal.getDataFile(String pFullName) |
File |
IProductManagerLocal.getDataFile(String pFullName) |
File |
IProductManagerWS.getDataFile(String fullName)
Returns the java.io.File object that references the physical file of the
supplied binary resource.
|
DocumentMaster |
IDocumentManagerLocal.getDocumentMaster(DocumentMasterKey pDocMPK) |
DocumentMaster |
IDocumentManagerWS.getDocumentMaster(DocumentMasterKey docMPK) |
DocumentMaster[] |
IDocumentManagerLocal.getDocumentMastersWithAssignedTasksForGivenUser(String pWorkspaceId,
String assignedUserLogin) |
DocumentMaster[] |
IDocumentManagerWS.getDocumentMastersWithAssignedTasksForGivenUser(String pWorkspaceId,
String assignedUserLogin) |
DocumentMaster[] |
IDocumentManagerLocal.getDocumentMastersWithReference(String pWorkspaceId,
String reference,
int maxResults) |
DocumentMaster[] |
IDocumentManagerWS.getDocumentMastersWithReference(String pWorkspaceId,
String reference,
int maxResults) |
DocumentMasterTemplate |
IDocumentManagerLocal.getDocumentMasterTemplate(DocumentMasterTemplateKey pKey) |
DocumentMasterTemplate |
IDocumentManagerWS.getDocumentMasterTemplate(DocumentMasterTemplateKey key) |
DocumentMasterTemplate[] |
IDocumentManagerLocal.getDocumentMasterTemplates(String pWorkspaceId) |
DocumentMasterTemplate[] |
IDocumentManagerWS.getDocumentMasterTemplates(String workspaceId) |
String[] |
IDocumentManagerLocal.getFolders(String pCompletePath) |
String[] |
IDocumentManagerWS.getFolders(String completePath) |
DocumentMasterKey[] |
IDocumentManagerLocal.getIterationChangeEventSubscriptions(String pWorkspaceId) |
DocumentMasterKey[] |
IDocumentManagerWS.getIterationChangeEventSubscriptions(String workspaceId) |
Layer |
IProductManagerLocal.getLayer(int pId) |
Layer |
IProductManagerWS.getLayer(int id)
Retrieves a given layer.
|
List<Layer> |
IProductManagerLocal.getLayers(ConfigurationItemKey pKey) |
List<Layer> |
IProductManagerWS.getLayers(ConfigurationItemKey key)
Retrieves all layers of the given product structure, ie
ConfigurationItem.
|
PartMaster |
IProductManagerLocal.getPartMaster(PartMasterKey pPartMPK) |
PartMaster |
IProductManagerWS.getPartMaster(PartMasterKey partMPK)
Returns a specific PartMaster.
|
PartRevision |
IProductManagerLocal.getPartRevision(PartRevisionKey pPartRPK) |
PartRevision |
IProductManagerWS.getPartRevision(PartRevisionKey partRPK)
Returns a specific PartRevision.
|
DocumentMasterKey[] |
IDocumentManagerLocal.getStateChangeEventSubscriptions(String pWorkspaceId) |
DocumentMasterKey[] |
IDocumentManagerWS.getStateChangeEventSubscriptions(String workspaceId) |
String[] |
IDocumentManagerLocal.getTags(String pWorkspaceId) |
String[] |
IDocumentManagerWS.getTags(String workspaceId) |
Task[] |
IDocumentManagerLocal.getTasks(String pWorkspaceId) |
Task[] |
IDocumentManagerWS.getTasks(String workspaceId) |
UserGroup |
IUserManagerLocal.getUserGroup(UserGroupKey pKey) |
UserGroup[] |
IUserManagerLocal.getUserGroups(String pWorkspaceId) |
User[] |
IDocumentManagerLocal.getUsers(String pWorkspaceId) |
User[] |
IDocumentManagerWS.getUsers(String workspaceId) |
WorkflowModel |
IWorkflowManagerLocal.getWorkflowModel(WorkflowModelKey pKey) |
WorkflowModel |
IWorkflowManagerWS.getWorkflowModel(WorkflowModelKey pKey) |
WorkflowModel[] |
IWorkflowManagerLocal.getWorkflowModels(String pWorkspaceId) |
WorkflowModel[] |
IWorkflowManagerWS.getWorkflowModels(String pWorkspaceId) |
Workspace |
IDocumentManagerWS.getWorkspace(String workspaceId) |
WorkspaceUserGroupMembership[] |
IUserManagerLocal.getWorkspaceUserGroupMemberships(String pWorkspaceId) |
WorkspaceUserMembership[] |
IUserManagerLocal.getWorkspaceUserMemberships(String pWorkspaceId) |
boolean |
IDocumentManagerLocal.isUserIterationChangeEventSubscribedForGivenDocument(String pWorkspaceId,
DocumentMaster docM) |
boolean |
IDocumentManagerWS.isUserIterationChangeEventSubscribedForGivenDocument(String workspaceId,
DocumentMaster docM) |
boolean |
IDocumentManagerLocal.isUserStateChangeEventSubscribedForGivenDocument(String pWorkspaceId,
DocumentMaster docM) |
boolean |
IDocumentManagerWS.isUserStateChangeEventSubscribedForGivenDocument(String workspaceId,
DocumentMaster docM) |
DocumentMaster |
IDocumentManagerLocal.moveDocumentMaster(String pParentFolder,
DocumentMasterKey pDocMPK) |
DocumentMaster |
IDocumentManagerWS.moveDocumentMaster(String parentFolder,
DocumentMasterKey docMPK) |
DocumentMasterKey[] |
IDocumentManagerLocal.moveFolder(String pCompletePath,
String pDestParentFolder,
String pDestFolder) |
DocumentMasterKey[] |
IDocumentManagerWS.moveFolder(String completePath,
String destParentFolder,
String destFolder) |
boolean |
IProductManagerLocal.partMasterExists(PartMasterKey partMasterKey) |
boolean |
IProductManagerWS.partMasterExists(PartMasterKey partMasterKey) |
DocumentMaster |
IDocumentManagerLocal.reject(String pWorkspaceId,
TaskKey pTaskKey,
String pComment) |
DocumentMaster |
IDocumentManagerWS.reject(String workspaceId,
TaskKey taskKey,
String comment) |
void |
IProductManagerLocal.removeCADFileFromPartIteration(PartIterationKey partIKey) |
void |
IProductManagerWS.removeCADFileFromPartIteration(PartIterationKey partIKey) |
DocumentMaster |
IDocumentManagerLocal.removeFileFromDocument(String pFullName) |
DocumentMaster |
IDocumentManagerWS.removeFileFromDocument(String fullName) |
DocumentMasterTemplate |
IDocumentManagerLocal.removeFileFromTemplate(String pFullName) |
DocumentMasterTemplate |
IDocumentManagerWS.removeFileFromTemplate(String fullName) |
void |
IUserManagerLocal.removeUsers(String pWorkspaceId,
String[] pLogins) |
File |
IDocumentManagerLocal.saveFileInDocument(DocumentIterationKey pDocPK,
String pName,
long pSize) |
File |
IProductManagerLocal.saveFileInPartIteration(PartIterationKey pPartIPK,
String pName,
long pSize) |
File |
IProductManagerWS.saveFileInPartIteration(PartIterationKey partIPK,
String name,
long size)
Creates a regular file, BinaryResource
object, and attachs it to the part iteration instance passed
as parameter.
|
File |
IDocumentManagerLocal.saveFileInTemplate(DocumentMasterTemplateKey pDocMTemplateKey,
String pName,
long pSize) |
File |
IProductManagerLocal.saveGeometryInPartIteration(PartIterationKey pPartIPK,
String pName,
int quality,
long pSize) |
File |
IProductManagerWS.saveGeometryInPartIteration(PartIterationKey partIPK,
String name,
int quality,
long size)
Creates a Geometry file,
a specialized kind of binary resource which contains CAD data, and
attachs it to the part iteration passed as parameter.
|
File |
IProductManagerLocal.saveNativeCADInPartIteration(PartIterationKey pPartIPK,
String pName,
long pSize) |
File |
IProductManagerWS.saveNativeCADInPartIteration(PartIterationKey partIPK,
String name,
long size)
Creates the BinaryResource file,
which is the native CAD file associated with the part iteration passed as parameter.
|
User |
IDocumentManagerWS.savePersonalInfo(String workspaceId,
String name,
String email,
String language) |
DocumentMaster |
IDocumentManagerLocal.saveTags(DocumentMasterKey pDocMPK,
String[] pTags) |
DocumentMaster |
IDocumentManagerWS.saveTags(DocumentMasterKey docMPK,
String[] tags) |
DocumentMaster[] |
IDocumentManagerLocal.searchDocumentMasters(SearchQuery pQuery) |
DocumentMaster[] |
IDocumentManagerWS.searchDocumentMasters(SearchQuery query) |
void |
IDocumentManagerLocal.subscribeToIterationChangeEvent(DocumentMasterKey pDocMPK) |
void |
IDocumentManagerWS.subscribeToIterationChangeEvent(DocumentMasterKey docMPK) |
void |
IDocumentManagerLocal.subscribeToStateChangeEvent(DocumentMasterKey pDocMPK) |
void |
IDocumentManagerWS.subscribeToStateChangeEvent(DocumentMasterKey docMPK) |
DocumentMaster |
IDocumentManagerLocal.undoCheckOutDocument(DocumentMasterKey pDocMPK) |
DocumentMaster |
IDocumentManagerWS.undoCheckOutDocument(DocumentMasterKey docMPK) |
PartRevision |
IProductManagerLocal.undoCheckOutPart(PartRevisionKey pPartRPK) |
PartRevision |
IProductManagerWS.undoCheckOutPart(PartRevisionKey partRPK)
Undoes checkout the given part revision.
|
void |
IDocumentManagerLocal.unsubscribeToIterationChangeEvent(DocumentMasterKey pDocMPK) |
void |
IDocumentManagerWS.unsubscribeToIterationChangeEvent(DocumentMasterKey docMPK) |
void |
IDocumentManagerLocal.unsubscribeToStateChangeEvent(DocumentMasterKey pDocMPK) |
void |
IDocumentManagerWS.unsubscribeToStateChangeEvent(DocumentMasterKey docMPK) |
DocumentMaster |
IDocumentManagerLocal.updateDocument(DocumentIterationKey pKey,
String pRevisionNote,
InstanceAttribute[] pAttributes,
DocumentIterationKey[] pLinkKeys) |
DocumentMaster |
IDocumentManagerWS.updateDocument(DocumentIterationKey key,
String revisionNote,
InstanceAttribute[] attributes,
DocumentIterationKey[] linkKeys) |
DocumentMasterTemplate |
IDocumentManagerLocal.updateDocumentMasterTemplate(DocumentMasterTemplateKey pKey,
String pDocumentType,
String pMask,
InstanceAttributeTemplate[] pAttributeTemplates,
boolean idGenerated) |
DocumentMasterTemplate |
IDocumentManagerWS.updateDocumentMasterTemplate(DocumentMasterTemplateKey key,
String documentType,
String mask,
InstanceAttributeTemplate[] attributeTemplates,
boolean idGenerated) |
Layer |
IProductManagerLocal.updateLayer(ConfigurationItemKey pKey,
int pId,
String pName) |
PartRevision |
IProductManagerLocal.updatePartIteration(PartIterationKey pKey,
String pIterationNote,
PartIteration.Source source,
List<PartUsageLink> pUsageLinks,
List<InstanceAttribute> pAttributes,
DocumentIterationKey[] pLinkKeys) |
PartRevision |
IProductManagerWS.updatePartIteration(PartIterationKey key,
String iterationNote,
PartIteration.Source source,
List<PartUsageLink> usageLinks,
List<InstanceAttribute> attributes,
DocumentIterationKey[] linkKeys)
Updates the specified PartIteration with
the properties passed as parameters.
|
void |
IUploadDownloadWS.uploadGeometryToPart(String workspaceId,
String partMNumber,
String partRVersion,
int iteration,
String fileName,
int quality,
DataHandler data) |
void |
IUploadDownloadWS.uploadNativeCADToPart(String workspaceId,
String partMNumber,
String partRVersion,
int iteration,
String fileName,
DataHandler data) |
void |
IUploadDownloadWS.uploadToDocument(String workspaceId,
String docMId,
String docMVersion,
int iteration,
String fileName,
DataHandler data) |
void |
IUploadDownloadWS.uploadToPart(String workspaceId,
String partMNumber,
String partRVersion,
int iteration,
String fileName,
DataHandler data) |
void |
IUploadDownloadWS.uploadToTemplate(String workspaceId,
String templateId,
String fileName,
DataHandler data) |
User |
IDocumentManagerLocal.whoAmI(String pWorkspaceId) |
User |
IDocumentManagerWS.whoAmI(String workspaceId) |
Copyright © 2013 OW2 Consortium. All Rights Reserved.