Package overit.geocallapp.wfm.core.bl.crewshell

Class CrewShellUtils

java.lang.Object

overit.geocallapp.wfm.crewshell.bl.CrewShellUtils

overit.geocallapp.wfm.core.bl.crewshell.CrewShellUtils

public class CrewShellUtils
extends CrewShellUtils

Utility class for the crew shells.

Since:

16.0

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CrewShellUtils()

Method Summary

Modifier and Type	Method	Description
protected static BOCrewShell	getCrewShell(Long crewShellId, PoolKit pk)
static Set<Long>	getCrewShellBySchedulings(Set<Long> schedulingIDs, PoolKit pk)	Retrieves the set of the IDs of the BOCrewShell objects by taking into account their work-shifts.
static DBView	getCrewShellBySchedulingsDbv(Set<Long> schedulingIDs, PoolKit pk)	Retrieves the DBView object containing the scheduling's data for each BOCrewShell object.
static Map<Date,Set<Long>>	getCrewShellBySchedulingsGroupedByDay(Set<Long> schedulingIDs, PoolKit pk)	Retrieves the map of the IDs of the BOCrewShell objects for each Date composition day, by taking into account the BOCrewShell objects' schedulings.
static String	getCrewShellName(Long crewShellID, PoolKit pk)	Retrieves the BOCrewShell object's name (i.e., the crew shell's description).
static BOWorkShift	getCrewShellWorkShift(Long crewShellId, Date day, PoolKit poolKit)
protected static BOOperationCenter	getOperationCenter(Long operationCenterId, PoolKit pk)
protected static BOSchedulingUser	getSchedulingUser(Long schedulingUserId, PoolKit pk)
static String	getTechnicianName(BOCrewShellDraftComposition technician, PoolKit pk)	Retrieves the BOCrewShellDraftComposition object's concatenation of surname-space-name (i.e., the technician's full name).
static String	getUserName(Long userID, PoolKit pk)	Retrieves the BOSchedulingUser object's concatenation of surname-space-name (i.e., the user's full name) by its userID.
protected static BOWorkShift	getWorkshift(Long workshiftId, PoolKit pk)
static boolean	isDummyUser(BOSchedulingUser user)	Checks if the BOSchedulingUser object is a BOCrewShell object (i.e., a dummy user).
static List<BOCrewShellOperationCenter>	retrieveActivatedOCsForCrewShells(PoolKit poolKit)	Retrieves the list of all the BOCrewShellOperationCenter objects (i.e., the list of the activated crew shells' operation centers).
static List<Long>	retrieveActivatedOCsIDsForCrewShells(PoolKit poolKit)	Retrieves the list of all the operation centers' IDs associated to the BOCrewShellOperationCenter objects (i.e., the list of the IDs of the activated operation centers for crew shells).
static void	validateDeactivatedCrewShellsOC(DynO dynO, PoolKit pk)	Validates whether the associated BOOperationCenter object (i.e., operation center) has been deactivated for crew shells.
static void	validateDeactivatedCrewShellsOC(NotificationInput<BOWorkShift> input, PoolKit pk)

Methods inherited from class overit.geocallapp.wfm.crewshell.bl.CrewShellUtils

findCrewShellByDummyUser, getCrewShellByDummyUser, getCrewShellDummyUsers, getCrewShellTechnicians, getCrewShellTechnicians, getCrewShellTechniciansByDummyUser, getCrewShellTechniciansByDummyUser, getResourceOfACrewShell, getResourceOfACrewShell, isAnyForemanPresent, isResourceInACrewShell

Methods inherited from class java.lang.Object

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

Constructor Details

CrewShellUtils

protected CrewShellUtils()

Method Details

getCrewShellBySchedulings

public static Set<Long> getCrewShellBySchedulings(Set<Long> schedulingIDs,
 PoolKit pk)
                                           throws DAValidateException,
DAException

Retrieves the set of the IDs of the BOCrewShell objects by taking into account their work-shifts.

Parameters:

schedulingIDs - the set of work-shifts' IDs

pk - the PoolKit poolKit

Returns:

the set of the IDs of the BOCrewShell objects

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

See Also:

• business object

getCrewShellBySchedulingsGroupedByDay

public static Map<Date,Set<Long>> getCrewShellBySchedulingsGroupedByDay(Set<Long> schedulingIDs,
 PoolKit pk)
                                                                 throws DAValidateException,
DAException

Retrieves the map of the IDs of the BOCrewShell objects for each Date composition day, by taking into account the BOCrewShell objects' schedulings.

Parameters:

schedulingIDs - the set of work-shifts' IDs

pk - the PoolKit poolKit

Returns:

the map of the IDs of the BOCrewShell objects for each Date composition day

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

See Also:

• business object

getCrewShellBySchedulingsDbv

public static DBView getCrewShellBySchedulingsDbv(Set<Long> schedulingIDs,
 PoolKit pk)
                                           throws DAValidateException,
DAException

Retrieves the DBView object containing the scheduling's data for each BOCrewShell object.

Parameters:

schedulingIDs - the set of work-shifts' IDs

pk - the PoolKit poolKit

Returns:

the DBView object containing the scheduling's data for each BOCrewShell object

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

See Also:

• business object

getTechnicianName

public static String getTechnicianName(BOCrewShellDraftComposition technician,
 PoolKit pk)
                                throws DAValidateException,
DAException

Retrieves the BOCrewShellDraftComposition object's concatenation of surname-space-name (i.e., the technician's full name). This method concerns a BOCrewShell object's draft composition.

Parameters:

technician - the BOCrewShellDraftComposition technician

Returns:

the technician's full name

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

getUserName

public static String getUserName(Long userID,
 PoolKit pk)
                          throws DAException,
DAValidateException

Retrieves the BOSchedulingUser object's concatenation of surname-space-name (i.e., the user's full name) by its userID.

Parameters:

userID - the BOSchedulingUser user's ID.

Returns:

the user's full name

Throws:

DAException

DAValidateException

See Also:

• business object

getCrewShellName

public static String getCrewShellName(Long crewShellID,
 PoolKit pk)
                               throws DAException,
DAValidateException

Retrieves the BOCrewShell object's name (i.e., the crew shell's description).

Parameters:

crewShellID - the BOCrewShell object's ID.

Returns:

the crew shell's description

Throws:

DAException

DAValidateException

isDummyUser

public static boolean isDummyUser(BOSchedulingUser user)

Checks if the BOSchedulingUser object is a BOCrewShell object (i.e., a dummy user).

Parameters:

user - the BOSchedulingUser object to be checked

Returns:

true if the user is a dummy user, false otherwise

retrieveActivatedOCsForCrewShells

public static List<BOCrewShellOperationCenter> retrieveActivatedOCsForCrewShells(PoolKit poolKit)
                                                                          throws DAValidateException,
DAException

Retrieves the list of all the BOCrewShellOperationCenter objects (i.e., the list of the activated crew shells' operation centers).

Parameters:

poolKit - the PoolKit poolKit

Returns:

the list of the activated crew shells' operation centers

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

retrieveActivatedOCsIDsForCrewShells

public static List<Long> retrieveActivatedOCsIDsForCrewShells(PoolKit poolKit)
                                                       throws DAValidateException,
DAException

Retrieves the list of all the operation centers' IDs associated to the BOCrewShellOperationCenter objects (i.e., the list of the IDs of the activated operation centers for crew shells).

Parameters:

poolKit - the PoolKit poolKit

Returns:

the list of the IDs of the activated operation centers for crew shells

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

validateDeactivatedCrewShellsOC

public static void validateDeactivatedCrewShellsOC(DynO dynO,
 PoolKit pk)
                                            throws DAValidateException,
DAException

Validates whether the associated BOOperationCenter object (i.e., operation center) has been deactivated for crew shells. The existence of a BOCrewShellOperationCenter object (i.e., crew shell's activated operation center) implies that the associated operation center has been activated for crew shells. The validation is performed based on the provided DynO object, and a DAValidateException is thrown with different error codes for each extension of the DynO object.

Parameters:

dynO - the DynO object to be validated

pk - the PoolKit poolKit

Throws:

DAValidateException - if there is a data validation exception

DAException - if a generic Exception object is thrown

validateDeactivatedCrewShellsOC

public static void validateDeactivatedCrewShellsOC(NotificationInput<BOWorkShift> input,
 PoolKit pk)
                                            throws DAValidateException,
DAException

Throws:

DAValidateException

DAException

getCrewShell

protected static BOCrewShell getCrewShell(Long crewShellId,
 PoolKit pk)
                                   throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

getWorkshift

protected static BOWorkShift getWorkshift(Long workshiftId,
 PoolKit pk)
                                   throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

getOperationCenter

protected static BOOperationCenter getOperationCenter(Long operationCenterId,
 PoolKit pk)
                                               throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

getSchedulingUser

protected static BOSchedulingUser getSchedulingUser(Long schedulingUserId,
 PoolKit pk)
                                             throws DAException,
DAValidateException

Throws:

DAException

DAValidateException

getCrewShellWorkShift

public static BOWorkShift getCrewShellWorkShift(Long crewShellId,
 Date day,
 PoolKit poolKit)
                                         throws DAException,
DAValidateException

Throws:

DAException

DAValidateException