com.docdoku.core.services

Interface IProductBaselineManagerLocal

public interface IProductBaselineManagerLocal

Since:

V2.0

Version:

2.0, 26/09/14

Author:

Taylor Labejof

Method Summary

Modifier and Type	Method and Description
ProductBaseline	createBaseline(ConfigurationItemKey configurationItemKey, String name, ProductBaselineType type, String description, List<PartIterationKey> partIterationKeys, List<String> substituteLinks, List<String> optionalUsageLinks)
ProductConfiguration	createProductConfiguration(ConfigurationItemKey ciKey, String name, String description, List<String> substituteLinks, List<String> optionalUsageLinks, Map<String,String> userEntries, Map<String,String> groupEntries)
void	deleteBaseline(String pWorkspaceId, int baselineId)
void	deleteProductConfiguration(ConfigurationItemKey ciKey, int productConfigurationId)
List<ProductBaseline>	getAllBaselines(String workspaceId)
List<ProductConfiguration>	getAllProductConfigurations(String workspaceId)
List<ProductConfiguration>	getAllProductConfigurationsByConfigurationItemId(ConfigurationItemKey ciKey)
ProductBaseline	getBaseline(int baselineId)
ProductBaseline	getBaselineById(int baselineId)
List<PathChoice>	getBaselineCreationPathChoices(ConfigurationItemKey ciKey, ProductBaselineType type)
List<PartIteration>	getBaselineCreationVersionsChoices(ConfigurationItemKey ciKey)
List<BaselinedPart>	getBaselinedPartWithReference(int baselineId, String q, int maxResults)
List<ProductBaseline>	getBaselines(ConfigurationItemKey configurationItemKey)
List<PartRevision>	getObsoletePartRevisionsInBaseline(String workspaceId, int baselineId)
List<PathToPathLink>	getPathToPathLinkFromSourceAndTarget(String workspaceId, String configurationItemId, int baselineId, String sourcePath, String targetPath)
List<String>	getPathToPathLinkTypes(String workspaceId, String configurationItemId, int baselineId)
ProductConfiguration	getProductConfiguration(ConfigurationItemKey ciKey, int productConfigurationId)
void	removeACLFromConfiguration(ConfigurationItemKey ciKey, int productConfigurationId)
void	updateACLForConfiguration(ConfigurationItemKey ciKey, int productConfigurationId, Map<String,String> userEntries, Map<String,String> groupEntries)
ProductConfiguration	updateProductConfiguration(ConfigurationItemKey ciKey, int productConfigurationId, String name, String description, List<String> substituteLinks, List<String> optionalUsageLinks)

Method Detail

createBaseline

ProductBaseline createBaseline(ConfigurationItemKey configurationItemKey,
                               String name,
                               ProductBaselineType type,
                               String description,
                               List<PartIterationKey> partIterationKeys,
                               List<String> substituteLinks,
                               List<String> optionalUsageLinks)
                        throws UserNotFoundException,
                               AccessRightException,
                               WorkspaceNotFoundException,
                               ConfigurationItemNotFoundException,
                               PartRevisionNotReleasedException,
                               PartIterationNotFoundException,
                               UserNotActiveException,
                               NotAllowedException,
                               EntityConstraintException,
                               PartMasterNotFoundException,
                               CreationException,
                               BaselineNotFoundException,
                               PathToPathLinkAlreadyExistsException,
                               WorkspaceNotEnabledException

Throws:

UserNotFoundException

AccessRightException

WorkspaceNotFoundException

ConfigurationItemNotFoundException

PartRevisionNotReleasedException

PartIterationNotFoundException

UserNotActiveException

NotAllowedException

EntityConstraintException

PartMasterNotFoundException

CreationException

BaselineNotFoundException

PathToPathLinkAlreadyExistsException

WorkspaceNotEnabledException

getAllBaselines

List<ProductBaseline> getAllBaselines(String workspaceId)
                               throws UserNotFoundException,
                                      UserNotActiveException,
                                      WorkspaceNotFoundException,
                                      WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

WorkspaceNotEnabledException

getBaselines

List<ProductBaseline> getBaselines(ConfigurationItemKey configurationItemKey)
                            throws UserNotFoundException,
                                   UserNotActiveException,
                                   WorkspaceNotFoundException,
                                   WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

WorkspaceNotEnabledException

deleteBaseline

void deleteBaseline(String pWorkspaceId,
                    int baselineId)
             throws UserNotFoundException,
                    AccessRightException,
                    WorkspaceNotFoundException,
                    BaselineNotFoundException,
                    UserNotActiveException,
                    EntityConstraintException,
                    WorkspaceNotEnabledException

Throws:

UserNotFoundException

AccessRightException

WorkspaceNotFoundException

BaselineNotFoundException

UserNotActiveException

EntityConstraintException

WorkspaceNotEnabledException

getBaseline

ProductBaseline getBaseline(int baselineId)
                     throws UserNotFoundException,
                            UserNotActiveException,
                            WorkspaceNotFoundException,
                            BaselineNotFoundException,
                            WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

BaselineNotFoundException

WorkspaceNotEnabledException

getBaselineById

ProductBaseline getBaselineById(int baselineId)
                         throws UserNotFoundException,
                                UserNotActiveException,
                                WorkspaceNotFoundException,
                                WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

WorkspaceNotEnabledException

getBaselinedPartWithReference

List<BaselinedPart> getBaselinedPartWithReference(int baselineId,
                                                  String q,
                                                  int maxResults)
                                           throws BaselineNotFoundException,
                                                  UserNotFoundException,
                                                  UserNotActiveException,
                                                  WorkspaceNotFoundException,
                                                  WorkspaceNotEnabledException

Throws:

BaselineNotFoundException

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

WorkspaceNotEnabledException

getBaselineCreationPathChoices

List<PathChoice> getBaselineCreationPathChoices(ConfigurationItemKey ciKey,
                                                ProductBaselineType type)
                                         throws UserNotFoundException,
                                                UserNotActiveException,
                                                WorkspaceNotFoundException,
                                                ConfigurationItemNotFoundException,
                                                PartMasterNotFoundException,
                                                NotAllowedException,
                                                EntityConstraintException,
                                                WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

ConfigurationItemNotFoundException

PartMasterNotFoundException

NotAllowedException

EntityConstraintException

WorkspaceNotEnabledException

getBaselineCreationVersionsChoices

List<PartIteration> getBaselineCreationVersionsChoices(ConfigurationItemKey ciKey)
                                                throws ConfigurationItemNotFoundException,
                                                       UserNotFoundException,
                                                       UserNotActiveException,
                                                       WorkspaceNotFoundException,
                                                       PartMasterNotFoundException,
                                                       NotAllowedException,
                                                       EntityConstraintException,
                                                       WorkspaceNotEnabledException

Throws:

ConfigurationItemNotFoundException

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

PartMasterNotFoundException

NotAllowedException

EntityConstraintException

WorkspaceNotEnabledException

createProductConfiguration

ProductConfiguration createProductConfiguration(ConfigurationItemKey ciKey,
                                                String name,
                                                String description,
                                                List<String> substituteLinks,
                                                List<String> optionalUsageLinks,
                                                Map<String,String> userEntries,
                                                Map<String,String> groupEntries)
                                         throws UserNotFoundException,
                                                UserNotActiveException,
                                                WorkspaceNotFoundException,
                                                ConfigurationItemNotFoundException,
                                                CreationException,
                                                AccessRightException,
                                                WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

ConfigurationItemNotFoundException

CreationException

AccessRightException

WorkspaceNotEnabledException

getAllProductConfigurations

List<ProductConfiguration> getAllProductConfigurations(String workspaceId)
                                                throws UserNotFoundException,
                                                       UserNotActiveException,
                                                       WorkspaceNotFoundException,
                                                       WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

WorkspaceNotEnabledException

getAllProductConfigurationsByConfigurationItemId

List<ProductConfiguration> getAllProductConfigurationsByConfigurationItemId(ConfigurationItemKey ciKey)
                                                                     throws UserNotFoundException,
                                                                            UserNotActiveException,
                                                                            WorkspaceNotFoundException,
                                                                            ConfigurationItemNotFoundException,
                                                                            WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

ConfigurationItemNotFoundException

WorkspaceNotEnabledException

getProductConfiguration

ProductConfiguration getProductConfiguration(ConfigurationItemKey ciKey,
                                             int productConfigurationId)
                                      throws UserNotFoundException,
                                             UserNotActiveException,
                                             WorkspaceNotFoundException,
                                             ProductConfigurationNotFoundException,
                                             AccessRightException,
                                             WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

ProductConfigurationNotFoundException

AccessRightException

WorkspaceNotEnabledException

updateProductConfiguration

ProductConfiguration updateProductConfiguration(ConfigurationItemKey ciKey,
                                                int productConfigurationId,
                                                String name,
                                                String description,
                                                List<String> substituteLinks,
                                                List<String> optionalUsageLinks)
                                         throws UserNotFoundException,
                                                UserNotActiveException,
                                                WorkspaceNotFoundException,
                                                ProductConfigurationNotFoundException,
                                                AccessRightException,
                                                WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

ProductConfigurationNotFoundException

AccessRightException

WorkspaceNotEnabledException

deleteProductConfiguration

void deleteProductConfiguration(ConfigurationItemKey ciKey,
                                int productConfigurationId)
                         throws UserNotFoundException,
                                UserNotActiveException,
                                WorkspaceNotFoundException,
                                ProductConfigurationNotFoundException,
                                AccessRightException,
                                WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

ProductConfigurationNotFoundException

AccessRightException

WorkspaceNotEnabledException

updateACLForConfiguration

void updateACLForConfiguration(ConfigurationItemKey ciKey,
                               int productConfigurationId,
                               Map<String,String> userEntries,
                               Map<String,String> groupEntries)
                        throws UserNotFoundException,
                               UserNotActiveException,
                               WorkspaceNotFoundException,
                               ProductConfigurationNotFoundException,
                               AccessRightException,
                               WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

ProductConfigurationNotFoundException

AccessRightException

WorkspaceNotEnabledException

removeACLFromConfiguration

void removeACLFromConfiguration(ConfigurationItemKey ciKey,
                                int productConfigurationId)
                         throws UserNotFoundException,
                                UserNotActiveException,
                                WorkspaceNotFoundException,
                                ProductConfigurationNotFoundException,
                                AccessRightException,
                                WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

ProductConfigurationNotFoundException

AccessRightException

WorkspaceNotEnabledException

getObsoletePartRevisionsInBaseline

List<PartRevision> getObsoletePartRevisionsInBaseline(String workspaceId,
                                                      int baselineId)
                                               throws UserNotFoundException,
                                                      UserNotActiveException,
                                                      WorkspaceNotFoundException,
                                                      BaselineNotFoundException,
                                                      WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

BaselineNotFoundException

WorkspaceNotEnabledException

getPathToPathLinkFromSourceAndTarget

List<PathToPathLink> getPathToPathLinkFromSourceAndTarget(String workspaceId,
                                                          String configurationItemId,
                                                          int baselineId,
                                                          String sourcePath,
                                                          String targetPath)
                                                   throws UserNotFoundException,
                                                          UserNotActiveException,
                                                          WorkspaceNotFoundException,
                                                          BaselineNotFoundException,
                                                          WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

BaselineNotFoundException

WorkspaceNotEnabledException

getPathToPathLinkTypes

List<String> getPathToPathLinkTypes(String workspaceId,
                                    String configurationItemId,
                                    int baselineId)
                             throws UserNotFoundException,
                                    UserNotActiveException,
                                    WorkspaceNotFoundException,
                                    BaselineNotFoundException,
                                    WorkspaceNotEnabledException

Throws:

UserNotFoundException

UserNotActiveException

WorkspaceNotFoundException

BaselineNotFoundException

WorkspaceNotEnabledException