org.openepics.cable.services

Class CableTypeService

java.lang.Object

org.openepics.cable.services.CableTypeService

public class CableTypeService
extends Object

CableTypeService is the service layer that handles cable type operations.

Author:

Sunil Sah

Constructor Summary

Constructors

Constructor and Description
CableTypeService()

Method Summary

Modifier and Type	Method and Description
boolean	changeCableTypeStatus(CableType cableType, boolean active, String userId) Changes cable type's status in the database.
CableType	createCableType(String name, InstallationType installationType, String description, String service, Integer voltage, String insulation, String jacket, String flammability, Float tid, Float weight, Float diameter, List<CableTypeManufacturer> manufacturers, String comments, String revision, String userId) Creates a cable type in the database and returns it.
void	detachAllCableTypes() Performs clearing of the persistance context, thus detaching all entities.
void	detachCableType(CableType cableType) Detaches a single cable type from entity manager
List<CableType>	getAllCableTypes()
CableType	getCableTypeByName(String name) Retrieve cable type by the name.
List<CableType>	getFilteredCableTypes(String customQuery, Query query) Return a list of filtered cable types.
Iterable<String>	getFlammabilityValues(CableTypeActiveFilter filter) Return an iteration of all distinct flammability values in the database.
Iterable<String>	getInsulationValues(CableTypeActiveFilter filter) Return an iteration of all distinct insulation values in the database.
Iterable<String>	getJacketValues(CableTypeActiveFilter filter) Return an iteration of all distinct jacket values in the database.
Iterable<String>	getVoltageValues(CableTypeActiveFilter filter) Return an iteration of all distinct voltage values in the database.
boolean	updateCableType(CableType cableType, CableType oldCableType, String userId) Updates the attributes on the given cable type.

Methods inherited from class java.lang.Object

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

Constructor Detail

CableTypeService

public CableTypeService()

Method Detail

getCableTypeByName

public CableType getCableTypeByName(String name)

Retrieve cable type by the name.

Parameters:

name - the cable type name

Returns:

the cable type, or null if the cable type with such name does not exist

getFilteredCableTypes

public List<CableType> getFilteredCableTypes(String customQuery,
                                             Query query)

Return a list of filtered cable types.

Parameters:

customQuery - custom query

query - query

Returns:

a list of filtered cable types

getAllCableTypes

public List<CableType> getAllCableTypes()

Returns:

a list of all cable types

createCableType

public CableType createCableType(String name,
                                 InstallationType installationType,
                                 String description,
                                 String service,
                                 Integer voltage,
                                 String insulation,
                                 String jacket,
                                 String flammability,
                                 Float tid,
                                 Float weight,
                                 Float diameter,
                                 List<CableTypeManufacturer> manufacturers,
                                 String comments,
                                 String revision,
                                 String userId)

Creates a cable type in the database and returns it.

Parameters:

name - the name/code

installationType - the allowed installation type

description - the description

service - the service/function description

voltage - the voltage rating description

insulation - the insulation material

jacket - the type of jacket

flammability - the flammability classification

tid - the total ionizing dose in mrad

weight - the weight in kg/meter

diameter - the outer diameter in mm

manufacturers - the manufacturers of this cable type

comments - the comments

revision - the revision

userId - username of user creating the cableType, for history record

Returns:

the created cable type

updateCableType

public boolean updateCableType(CableType cableType,
                               CableType oldCableType,
                               String userId)

Updates the attributes on the given cable type.

Parameters:

cableType - the cable type with modified attributes to save to the database

oldCableType - the cable type before modification

userId - username of user updating the cableType, for history record

Returns:

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

changeCableTypeStatus

public boolean changeCableTypeStatus(CableType cableType,
                                     boolean active,
                                     String userId)

Changes cable type's status in the database.

Parameters:

cableType - the cable type to modify

active - cable type's new status

userId - username of user modifying the cableType, for history record

Returns:

true if the cable type's status was changed, false if the cable type's status was already set to new status, no modification needed

getVoltageValues

public Iterable<String> getVoltageValues(CableTypeActiveFilter filter)

Return an iteration of all distinct voltage values in the database.

Parameters:

filter - the filter to apply to the returned values

Returns:

an iteration of all distinct voltage values in the database

getInsulationValues

public Iterable<String> getInsulationValues(CableTypeActiveFilter filter)

Return an iteration of all distinct insulation values in the database.

Parameters:

filter - the filter to apply to the returned values

Returns:

an iteration of all distinct insulation values in the database

getJacketValues

public Iterable<String> getJacketValues(CableTypeActiveFilter filter)

Return an iteration of all distinct jacket values in the database.

Parameters:

filter - the filter to apply to the returned values

Returns:

an iteration of all distinct jacket values in the database

getFlammabilityValues

public Iterable<String> getFlammabilityValues(CableTypeActiveFilter filter)

Return an iteration of all distinct flammability values in the database.

Parameters:

filter - the filter to apply to the returned values

Returns:

an iteration of all distinct flammability values in the database

detachAllCableTypes

public void detachAllCableTypes()

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

detachCableType

public void detachCableType(CableType cableType)

Detaches a single cable type from entity manager

Parameters:

cableType - the cableType to detach