org.openepics.cable.services

Class CableArticleService

java.lang.Object

org.openepics.cable.services.CableArticleService

public class CableArticleService
extends Object

CableArticleService is the service layer that handles cable article operations.

Author:

Lars Johansson

Constructor Summary

Constructors

Constructor and Description
CableArticleService()

Method Summary

Modifier and Type	Method and Description
CableArticle	createCableArticle(CableArticle cableArticle, String userId) Creates an cable article in the database and returns it.
CableArticle	createCableArticle(String manufacturer, String externalId, String erpNumber, String isoClass, String description, String longDescription, String modelType, Float bendingRadius, Float outerDiameter, Float ratedVoltage, Float weightPerLength, String shortName, String shortNameExternalId, String urlChessPart, boolean active, Date created, Date modified, String userId)
boolean	deleteCableArticle(CableArticle cableArticle, String userId) Marks the cable article as inactive in the database.
void	detachAllCableArticles() Performs clearing of the persistance context, thus detaching all entities.
void	detachCableArticle(CableArticle cableArticle) Detaches a single cable article from entity manager
List<CableArticle>	getActiveCableArticles() Return a list of all active cable articles.
CableArticle	getCableArticleById(Long id) Returns a cable article with the specified cable article id.
CableArticle	getCableArticleByShortNameExternalId(String shortNameExternalId) Return cable article by manufacturer and externalId.
List<CableArticle>	getCableArticles() Return a list of all cable articles.
List<CableArticle>	getCableArticlesByExternalId(String externalId) Return a list of all cable articles by externalId.
List<CableArticle>	getCableArticlesByManufacturer(String manufacturer) Return a list of all cable articles by manufacturer.
boolean	updateCableArticle(CableArticle cableArticle, CableArticle oldCableArticle, String userId) Updates the attributes on the given cable article.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CableArticleService

public CableArticleService()

Method Detail

getCableArticles

public List<CableArticle> getCableArticles()

Return a list of all cable articles.

Returns:

a list of all cable articles

getActiveCableArticles

public List<CableArticle> getActiveCableArticles()

Return a list of all active cable articles.

Returns:

a list of all active cable articles

getCableArticleById

public CableArticle getCableArticleById(Long id)

Returns a cable article with the specified cable article id.

Parameters:

id - the cable article id

Returns:

the cable article, or null if the cable article with such id cannot be found

getCableArticleByShortNameExternalId

public CableArticle getCableArticleByShortNameExternalId(String shortNameExternalId)

Return cable article by manufacturer and externalId.

Parameters:

shortNameExternalId - short name external id

Returns:

cable article by manufacturer and externalId

getCableArticlesByManufacturer

public List<CableArticle> getCableArticlesByManufacturer(String manufacturer)

Return a list of all cable articles by manufacturer.

Parameters:

manufacturer - manufacturer

Returns:

a list of all cable articles by manufacturer

getCableArticlesByExternalId

public List<CableArticle> getCableArticlesByExternalId(String externalId)

Return a list of all cable articles by externalId.

Parameters:

externalId - external id

Returns:

a list of all cable articles by externalId

createCableArticle

public CableArticle createCableArticle(String manufacturer,
                                       String externalId,
                                       String erpNumber,
                                       String isoClass,
                                       String description,
                                       String longDescription,
                                       String modelType,
                                       Float bendingRadius,
                                       Float outerDiameter,
                                       Float ratedVoltage,
                                       Float weightPerLength,
                                       String shortName,
                                       String shortNameExternalId,
                                       String urlChessPart,
                                       boolean active,
                                       Date created,
                                       Date modified,
                                       String userId)

createCableArticle

public CableArticle createCableArticle(CableArticle cableArticle,
                                       String userId)

Creates an cable article in the database and returns it.

Parameters:

cableArticle - the cable article to add

userId - userId of user creating the cable article, for history record

Returns:

the created cable article

updateCableArticle

public boolean updateCableArticle(CableArticle cableArticle,
                                  CableArticle oldCableArticle,
                                  String userId)

Updates the attributes on the given cable article.

Parameters:

cableArticle - the cable article with modified attributes to save to the database

oldCableArticle - the cable article before modification

userId - username of user updating the cable article, for history record

Returns:

true if that cable article was updated, false if the cable article was not updated

deleteCableArticle

public boolean deleteCableArticle(CableArticle cableArticle,
                                  String userId)

Marks the cable article as inactive in the database.

Parameters:

cableArticle - cable article

userId - username of user deleting the cable article, for history record

Returns:

true if the cable article was deleted, false if the cable article was already deleted

detachAllCableArticles

public void detachAllCableArticles()

Performs clearing of the persistance context, thus detaching all entities.

detachCableArticle

public void detachCableArticle(CableArticle cableArticle)

Detaches a single cable article from entity manager

Parameters:

cableArticle - the cable article to detach