public interface IProductManagerWS
Modifier and Type | Method and Description |
---|---|
PartRevision |
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.
|
PartRevision |
checkOutPart(PartRevisionKey partRPK)
Checks out the supplied part revision to allow the operating user to modify it.
|
ConfigurationItem |
createConfigurationItem(String workspaceId,
String id,
String description,
String designItemNumber)
Creates a new product structure.
|
Layer |
createLayer(ConfigurationItemKey key,
String name)
Creates a new layer on a given product structure.
|
Marker |
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 |
createPartMaster(String workspaceId,
String number,
String name,
String partMasterDescription,
boolean standardPart,
String workflowModelId,
String partRevisionDescription)
Creates a new PartMaster.
|
void |
deleteConfigurationItem(ConfigurationItemKey configurationItemKey) |
void |
deleteLayer(String workspaceId,
int layerId) |
PartUsageLink |
filterProductStructure(ConfigurationItemKey ciKey,
ConfigSpec configSpec,
Integer partUsageLink,
Integer depth)
Resolves the product structure identified by the supplied
ConfigurationItemKey.
|
List<PartMaster> |
findPartMasters(String workspaceId,
String partNumber,
int maxResults)
Finds part masters by their part number using like style query.
|
List<PartUsageLink[]> |
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.
|
List<PartUsageLink> |
getComponents(PartIterationKey partIPK)
Fetches the components of the supplied part assembly
|
List<ConfigurationItem> |
getConfigurationItems(String workspaceId)
Retrieves all product structures that belong to the given workspace.
|
File |
getDataFile(String fullName)
Returns the java.io.File object that references the physical file of the
supplied binary resource.
|
Layer |
getLayer(int id)
Retrieves a given layer.
|
List<Layer> |
getLayers(ConfigurationItemKey key)
Retrieves all layers of the given product structure, ie
ConfigurationItem.
|
PartMaster |
getPartMaster(PartMasterKey partMPK)
Returns a specific PartMaster.
|
PartRevision |
getPartRevision(PartRevisionKey partRPK)
Returns a specific PartRevision.
|
boolean |
partMasterExists(PartMasterKey partMasterKey) |
void |
removeCADFileFromPartIteration(PartIterationKey partIKey) |
File |
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 |
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 |
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.
|
PartRevision |
undoCheckOutPart(PartRevisionKey partRPK)
Undoes checkout the given part revision.
|
PartRevision |
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.
|
List<PartUsageLink[]> findPartUsages(ConfigurationItemKey ciKey, PartMasterKey partMKey) throws WorkspaceNotFoundException, UserNotFoundException, UserNotActiveException
ciKey
- The configuration item under which context the search is madepartMKey
- The id of the part master to search on the structureWorkspaceNotFoundException
UserNotFoundException
UserNotActiveException
PartUsageLink filterProductStructure(ConfigurationItemKey ciKey, ConfigSpec configSpec, Integer partUsageLink, Integer depth) throws ConfigurationItemNotFoundException, WorkspaceNotFoundException, NotAllowedException, UserNotFoundException, UserNotActiveException, PartUsageLinkNotFoundException
ciKey
- The product structure to resolveconfigSpec
- The rules for the resolution algorithmpartUsageLink
- The part usage link id, if null starts from the root partdepth
- The fetch depthConfigurationItemNotFoundException
WorkspaceNotFoundException
NotAllowedException
UserNotFoundException
UserNotActiveException
PartUsageLinkNotFoundException
ConfigurationItem createConfigurationItem(String workspaceId, String id, String description, String designItemNumber) throws UserNotFoundException, WorkspaceNotFoundException, AccessRightException, NotAllowedException, ConfigurationItemAlreadyExistsException, CreationException
workspaceId
- The workspace in which the product structure will be createdid
- The id of the product structure which must be unique inside
the workspace contextdescription
- The description of the product structuredesignItemNumber
- The id of the part master that will be the root of the product structureUserNotFoundException
WorkspaceNotFoundException
AccessRightException
NotAllowedException
ConfigurationItemAlreadyExistsException
CreationException
PartMaster createPartMaster(String workspaceId, String number, String name, String partMasterDescription, boolean standardPart, String workflowModelId, String partRevisionDescription) throws NotAllowedException, UserNotFoundException, WorkspaceNotFoundException, AccessRightException, WorkflowModelNotFoundException, PartMasterAlreadyExistsException, CreationException
workspaceId
- The workspace in which the part master will be creatednumber
- The part number of the item to create which is its id
inside the workspacename
- The user friendly name of the itempartMasterDescription
- The full item descriptionstandardPart
- Boolean indicating if the item to create is a standard partworkflowModelId
- The id of the workflow template that will be instantiated and attached
to the created part master. Actually, it's the first
PartRevision that will hold
the reference to the workflow. Obviously this parameter may be null,
it's not mandatory to rely on workflows for product definitions.partRevisionDescription
- The description of the first revision, version A, of the item.
This revision will be created in the same time than
the PartMaster itself.NotAllowedException
UserNotFoundException
WorkspaceNotFoundException
AccessRightException
WorkflowModelNotFoundException
PartMasterAlreadyExistsException
CreationException
PartRevision checkOutPart(PartRevisionKey partRPK) throws UserNotFoundException, AccessRightException, WorkspaceNotFoundException, PartRevisionNotFoundException, NotAllowedException, FileAlreadyExistsException, CreationException
partRPK
- The id of the part revision to check outUserNotFoundException
AccessRightException
WorkspaceNotFoundException
PartRevisionNotFoundException
NotAllowedException
FileAlreadyExistsException
CreationException
PartRevision undoCheckOutPart(PartRevisionKey partRPK) throws NotAllowedException, PartRevisionNotFoundException, UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException
partRPK
- The id of the part revision to undo check outNotAllowedException
PartRevisionNotFoundException
UserNotFoundException
UserNotActiveException
WorkspaceNotFoundException
PartRevision checkInPart(PartRevisionKey partRPK) throws PartRevisionNotFoundException, UserNotFoundException, WorkspaceNotFoundException, AccessRightException, NotAllowedException
partRPK
- The id of the part revision to check inPartRevisionNotFoundException
UserNotFoundException
WorkspaceNotFoundException
AccessRightException
NotAllowedException
File saveNativeCADInPartIteration(PartIterationKey partIPK, String name, long size) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException, NotAllowedException, PartRevisionNotFoundException, FileAlreadyExistsException, CreationException
partIPK
- The id of the part iteration on which the file will be attachedname
- The name of the binary resource to createsize
- Number of bytes of the physical fileUserNotFoundException
UserNotActiveException
WorkspaceNotFoundException
NotAllowedException
PartRevisionNotFoundException
FileAlreadyExistsException
CreationException
File saveGeometryInPartIteration(PartIterationKey partIPK, String name, int quality, long size) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException, NotAllowedException, PartRevisionNotFoundException, FileAlreadyExistsException, CreationException
partIPK
- The id of the part iteration on which the file will be attachedname
- The name of the binary resource to createquality
- The quality of the CAD file, starts at 0, smaller is greatersize
- Number of bytes of the physical fileUserNotFoundException
UserNotActiveException
WorkspaceNotFoundException
NotAllowedException
PartRevisionNotFoundException
FileAlreadyExistsException
CreationException
File saveFileInPartIteration(PartIterationKey partIPK, String name, long size) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException, NotAllowedException, PartRevisionNotFoundException, FileAlreadyExistsException, CreationException
partIPK
- The id of the part iteration on which the file will be attachedname
- The name of the binary resource to createsize
- Number of bytes of the physical fileUserNotFoundException
UserNotActiveException
WorkspaceNotFoundException
NotAllowedException
PartRevisionNotFoundException
FileAlreadyExistsException
CreationException
PartRevision updatePartIteration(PartIterationKey key, String iterationNote, PartIteration.Source source, List<PartUsageLink> usageLinks, List<InstanceAttribute> attributes, DocumentIterationKey[] linkKeys) throws UserNotFoundException, WorkspaceNotFoundException, AccessRightException, NotAllowedException, PartRevisionNotFoundException, PartMasterNotFoundException
key
- The id of the part iteration to modifyiterationNote
- A note to describe the iteration and thus the modifications made
to the partsource
- The PartIteration.Source
attribute of the partusageLinks
- Links to other parts. Only assembly parts can define usage linksattributes
- Custom attributes that may be added to the partlinkKeys
- Links to documentsUserNotFoundException
WorkspaceNotFoundException
AccessRightException
NotAllowedException
PartRevisionNotFoundException
PartMasterNotFoundException
File getDataFile(String fullName) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException, FileNotFoundException, NotAllowedException
fullName
- Id of the BinaryResource of which the
data file will be returnedUserNotFoundException
UserNotActiveException
WorkspaceNotFoundException
FileNotFoundException
NotAllowedException
List<ConfigurationItem> getConfigurationItems(String workspaceId) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException
workspaceId
- The workspace which is the first level context
where all products and parts are referencedUserNotFoundException
UserNotActiveException
WorkspaceNotFoundException
List<Layer> getLayers(ConfigurationItemKey key) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException
key
- The id of the configuration itemUserNotFoundException
UserNotActiveException
WorkspaceNotFoundException
Layer getLayer(int id) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException, LayerNotFoundException
id
- Integer value that uniquely identifies the layer to returnUserNotFoundException
UserNotActiveException
WorkspaceNotFoundException
LayerNotFoundException
Layer createLayer(ConfigurationItemKey key, String name) throws UserNotFoundException, WorkspaceNotFoundException, AccessRightException, ConfigurationItemNotFoundException
key
- The identifier object of the configuration item wherein the layer will
be createdname
- The user friendly name of the layerUserNotFoundException
WorkspaceNotFoundException
AccessRightException
ConfigurationItemNotFoundException
Marker createMarker(int layerId, String title, String description, double x, double y, double z) throws LayerNotFoundException, UserNotFoundException, WorkspaceNotFoundException, AccessRightException
layerId
- The layer id on which the marker will be createdtitle
- The title of the markerdescription
- The description of the markerx
- The x axis coordinate of the markery
- The y axis coordinate of the markerz
- The z axis coordinate of the markerLayerNotFoundException
UserNotFoundException
WorkspaceNotFoundException
AccessRightException
PartMaster getPartMaster(PartMasterKey partMPK) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException, PartMasterNotFoundException
partMPK
- The id of the part master to getUserNotFoundException
UserNotActiveException
WorkspaceNotFoundException
PartMasterNotFoundException
PartRevision getPartRevision(PartRevisionKey partRPK) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException, PartRevisionNotFoundException
partRPK
- The id of the part revision to getUserNotFoundException
UserNotActiveException
WorkspaceNotFoundException
PartRevisionNotFoundException
List<PartMaster> findPartMasters(String workspaceId, String partNumber, int maxResults) throws UserNotFoundException, AccessRightException, WorkspaceNotFoundException
workspaceId
- The workspace in which part masters will be searchedpartNumber
- The number of the part master to search formaxResults
- Set the maximum number of results to retrieveUserNotFoundException
AccessRightException
WorkspaceNotFoundException
List<PartUsageLink> getComponents(PartIterationKey partIPK) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException, PartIterationNotFoundException, NotAllowedException
partIPK
- The id of the part iteration of which the components have to be retrievedUserNotFoundException
UserNotActiveException
WorkspaceNotFoundException
PartIterationNotFoundException
NotAllowedException
boolean partMasterExists(PartMasterKey partMasterKey) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException
void deleteConfigurationItem(ConfigurationItemKey configurationItemKey) throws UserNotFoundException, WorkspaceNotFoundException, AccessRightException, NotAllowedException, UserNotActiveException, ConfigurationItemNotFoundException, LayerNotFoundException
void deleteLayer(String workspaceId, int layerId) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException, LayerNotFoundException
void removeCADFileFromPartIteration(PartIterationKey partIKey) throws UserNotFoundException, UserNotActiveException, WorkspaceNotFoundException, PartIterationNotFoundException
Copyright © 2013 OW2 Consortium. All Rights Reserved.