com.ibm.tivoli.maximo.amcrew.app

Class AMCrew

java.lang.Object

psdi.mbo.Mbo

psdi.mbo.StatefulMbo

com.ibm.tivoli.maximo.amcrew.app.AMCrew

All Implemented Interfaces:

AMCrewRemote, GISable, LBS, java.rmi.Remote, MboConstants, MboRemote, StatefulMboRemote, MaxRemoteProxy

public class AMCrew
extends StatefulMbo
implements AMCrewRemote

Field Summary

Fields

Modifier and Type	Field and Description
boolean	availabilityDataCalculated The calculateAvailabilityData() method is called once for each labor row on the Available Crew dialog of the Assignment tab and is triggered by the first access to any of the fields.
static java.lang.String	crewDurCrewPos
static java.lang.String	crewDurDynamic
static java.lang.String	crewDurStatic
java.util.Date	dateTo

Fields inherited from class psdi.mbo.StatefulMbo

onListTab, statusChangeButtonSigoption, targetStatusOption

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface psdi.mbo.MboConstants

ALLROWS, CHANGEDBY_USER, COUNT_ADDITIONS, COUNT_AFTERSAVE, COUNT_DATABASE, COUNT_DELETED, COUNT_EXISTING, DBCONFIG, DELAYVALIDATION, DELAYVALIDATIONONLY, DISCARDABLE, GOTCOMPLETEWHERE, HIDDEN, NO_RELATEDMBOS_OF_OWNERSCHILDREN_FETCH, NOACCESSCHECK, NOACTION, NOADD, NOCOMMIT, NODELETE, NONE, NOOVERWRITE, NOSAVE, NOSETVALUE, NOUPDATE, NOVALIDATION, NOVALIDATION_AND_NOACTION, NOVALIDATION_AND_NOACTION_ALLOWCROSSOVER, READONLY, REBUILD, REQUIRED, SAMEVALUEVALIDATION, SETBYPARENT, USER

Constructor Summary

Constructors

Constructor and Description
AMCrew(MboSet ms)

Method Summary

Modifier and Type	Method and Description
void	add() This is called when a new Mbo is added to the Mboset collection.
void	associateCrewType() Associate the Crew Type copying all requirements (crafts, qualifications and tools)
void	calculateAvailabilityData() The method calculates the values for the nonpersistent fields StartTime, Availability (i.e.
void	canDelete() Business Rules : 1.
void	changeStatus(java.lang.String status, java.util.Date date, java.lang.String memo, long accessModifier) Changes the status of the object.
void	changeStatus(java.lang.String newStatus, java.lang.String memo)
void	checkCalendarAndShift() This method checks whether this crew has a calendar and a shift associated with it.
void	childHasChanged()
void	delete(long accessModifier) Mark the object to be deleted depending on the access modifier.
MboRemote	duplicate() Duplicate method only throws exception now
java.lang.String	getAddressString() There is no address string with LBSLocation.
java.lang.Double	getAltitude()
java.lang.Double	getAltitudeAccuracy()
double	getAssignedHours(boolean insideCurrentDateWorkingTime, java.util.Date wpStartDateTime, java.util.Date wpEndDateTime, MboSetRemote dayNAssignmentSet) Sums up the assigned hours of the assignments in the assignment set, but only those portions of them that are actually inside working time.
double	getAvailableHours(java.util.Date startDate) Get either the number of workhours for this day, either from the modavail table, if there is an entry, or from the workperiod table.
MboRemote	getAvailableMbo(java.util.Date startDate) Get either the WorkPeriod mbo or the ModAvail mbo if there is one.
java.util.List<MboRemote>	getAvailableMboList(java.util.Date startDate) This returns either the workperiod or modavail mbo for the given parameters.
java.util.Date	getClientDTFromServerDT(java.util.Date serverDateTime, java.util.GregorianCalendar scratchCal) Generates a datetime in the client time zone from a datetime in the server time zone, using previously calculated zone offsets.
MboRemote	getCompositeWP(java.util.List<MboRemote> modAvailList, java.util.Date workDate) This takes a List of ModAvail mbos and combines them with the WorkPeriod of the same workdate, if any, into a single "composite" workperiod.
java.util.Date	getCrewDate() Get crew date
int	getCrewMemberCount(java.util.Date desiredDate) Get members count related to MaxVar CREWDURATION for a specific date
java.util.Date	getCurrentShiftEndDate(java.util.Date endDate)
java.util.Date	getCurrentShiftStartDate(java.util.Date effectiveDate)
java.util.Date	getDateTime(java.util.Date workdt, java.util.Date sttime)
java.util.Date	getDateTo()
MboSetRemote	getDayNAssignmentSet(MboRemote theCrewMbo, java.util.Date wpStartDateTime, java.util.Date wpEndDateTime) Fetch the mboset of those assignments for this crew that start within the working time of the dayN under consideration.
java.util.Date	getEarliestUnassignedDateTime(MboSetRemote dayNAssignmentSet, java.util.Date rangeStartDateTime, java.util.Date rangeFinishDateTime) This is passed a mboSet of assignments and a datetime range.
double[]	getEligibleHours()
java.lang.Double	getHeading()
java.util.Collection	getLabors(java.util.Date currentDate) Get all labors assigned on this crew for the currentDate
java.util.Date	getLastUpdate()
java.lang.Double	getLatitudeY() Return a double value with the the Latitude (or Y) coordinate of the current entitty.
java.lang.Double	getLocationAccuracy()
java.lang.Double	getLongitudeX() Return a double value with the the Longitude (or X) coordinate of the current entitty.
MboSetRemote	getMboSet(java.lang.String name) Get a related MboSet for the object using the named relationship.
java.util.Date[]	getServerDateColumn()
java.util.Date	getServerDTFromClientDT(java.util.Date clientDateTime, java.util.GregorianCalendar scratchCal) Generates a datetime in the server time zone from a datetime in the client time zone, using previously calculated zone offsets.
java.lang.Double	getSpeed()
java.lang.String	getStatusListName() Return the name of the value list which contains the list of status's.
java.util.Collection	getTools(java.util.Date currentDate) Get all tools assigned on this crew for the currentDate
MboRemote	getValidContract(java.util.Date startDate) Get the valid contract for the Crew.
java.util.Date	getWPEndDateTime(MboRemote WorkTimeMbo, java.util.Date wpStartDateTime, java.util.GregorianCalendar scratchCal) Gets the end datetime for the workperiod.
java.lang.Boolean	hasCoords() Check if this autolocatable object has coordinates filled (LAT,LONG)
void	init() Initialize the AMCrew Mbo object
boolean	isAMGridCreated()
boolean	isGISDataReadonly() Indicate if the current GIS entity is editable or not.
void	refreshkRequirements() Refresh the required crafts, qualifications and tools.
void	saveGISData(java.lang.String address, java.lang.String lat, java.lang.String lng) The address here is not saved as this will be writing out to LBSLocation table which does not contain an address.
void	saveLBSData(java.lang.Double lat, java.lang.Double lng, java.lang.Double locationAccuracy, java.lang.Double altitudeAccuracy, java.lang.Double altitude, java.lang.Double heading, java.lang.Double speed)
void	setAMGridCreated(boolean gridCreated)
void	setCrewDate(java.util.Date date) Set crew date
void	setDateTo(java.util.Date dateTo)
void	setServerDateColumn(java.util.Date[] newServerDateColumn)
void	setWorkHrs(java.util.Date DayOneClientDate) Sets the available hours for the 7 dayN attributes (all non-persistent).
void	updateStandardRate() Update standard rate field by calculating the sum of all labor and asset rates

Methods inherited from class psdi.mbo.StatefulMbo

canChangeMaxStatus, canChangeStatus, canChangeStatus, canChangeStatus, canDeleteAttachedDocs, changeMaxStatus, changeMaxStatus, changeStatus, changeStatus, checkForOpenStatus, checkStatusChangeAuthorization, filterByValidStatusList, fireEvent, getInternalStatus, getOnListTab, getOverridePVStatusException, getStatusChangeButtonSigoption, getStatusList, getTargetStatusOption, getValidStatusList, setOnListTab, setOverridePVStatusException, setStatusChangeButtonSigoption, setTargetStatusOption

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, appValidate, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, generateAutoKey, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getESId, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertOrgForSite, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboCtx, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNoSql, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeCtx, removeRelatedSet, resolveNoSqlWhere, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, setEAuditFieldModified, setESId, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMboCtx, setMLValue, setModified, setModifiedForIntegrationOnly, setNewMbo, setNoSql, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setUniqueIDValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueFromSequence, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.mbo.StatefulMboRemote

canChangeMaxStatus, canChangeStatus, canChangeStatus, canDeleteAttachedDocs, changeMaxStatus, changeMaxStatus, changeStatus, changeStatus, checkForOpenStatus, getInternalStatus, getOnListTab, getOverridePVStatusException, getStatusChangeButtonSigoption, getStatusList, getTargetStatusOption, getValidStatusList, setOnListTab, setOverridePVStatusException, setStatusChangeButtonSigoption, setTargetStatusOption

Methods inherited from interface psdi.mbo.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, generateAutoKey, getBoolean, getByte, getBytes, getCommLogOwnerNameAndUniqueId, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainIDs, getDouble, getExistingMboSet, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInt, getKeyValue, getLinesRelationship, getList, getLockedByDisplayName, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboInitialValue, getMboList, getMboSet, getMboSet, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getPropagateKeyFlag, getRecordIdentifer, getSiteOrg, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getThisMboSet, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, hasHierarchyLink, hasLockSaveRights, isAutoKeyed, isBasedOn, isFlagSet, isForDM, isLocked, isLocked, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isZombie, lock, propagateKeyValue, rollbackToCheckpoint, select, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDeleted, setESigFieldModified, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setIgnoreRecordLockCheck, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setReferencedMbo, setReferencedMbo, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValue, setValueNull, setValueNull, sigopGranted, sigopGranted, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Field Detail

crewDurStatic

public static final java.lang.String crewDurStatic

See Also:

Constant Field Values

crewDurDynamic

public static final java.lang.String crewDurDynamic

See Also:

Constant Field Values

crewDurCrewPos

public static final java.lang.String crewDurCrewPos

See Also:

Constant Field Values

availabilityDataCalculated

public boolean availabilityDataCalculated

The calculateAvailabilityData() method is called once for each labor row on the Available Crew dialog of the Assignment tab and is triggered by the first access to any of the fields. But after that happens, it must not execute a second time. This boolean keeps track of whether it's been executed yet or not.

dateTo

public java.util.Date dateTo

Constructor Detail

AMCrew

public AMCrew(MboSet ms)
       throws java.rmi.RemoteException

Parameters:

ms -

Throws:

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Initialize the AMCrew Mbo object

Overrides:

init in class Mbo

Throws:

MXException

See Also:

Mbo.init()

add

public void add()
         throws MXException,
                java.rmi.RemoteException

Description copied from class: Mbo

This is called when a new Mbo is added to the Mboset collection. It is called AFTER user defaults have been set from the data dictionary. Programmer should usually override this to set some defaults. Default behavior is to do nothing.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

MboRemote.add()

changeStatus

public void changeStatus(java.lang.String status,
                         java.util.Date date,
                         java.lang.String memo,
                         long accessModifier)
                  throws MXException,
                         java.rmi.RemoteException

Description copied from class: StatefulMbo

Changes the status of the object. This method compares the requested status and the current status by calling canChangeStatus before the change is performed. If the status change is allowed, the status change is performed and a status history record is written. If the status change is not allowed, an exception is thrown.

If the new status has the same MaxValue as the current status, then only the status and statusDate attributes are updated, and the StatusHandler is not used.

Specified by:

changeStatus in interface StatefulMboRemote

Overrides:

changeStatus in class StatefulMbo

Parameters:

status - The new desired status. This is the translated status (that is, the status code as it would have been entered by a user, or valuelist.value), not the internal status value (valuelist.maxvalue).

date - The effective date of the new status (java.util.Date). If this value is null, the current date/time of the server will be used.

memo - A string briefly describing the circumstances of the change. The memo can be null.

accessModifier - A value of NOACCESSCHECK will cause the method not to call canChangeStatus. Callers using this flag are responsible for ensuring that they are attempting a valid status change.

Throws:

MXException - Thrown if there is a problem, or the status cannot be changed, as determined by canChangeStatus(String).

java.rmi.RemoteException

See Also:

StatefulMbo.canChangeStatus(String)

canDelete

public void canDelete()
               throws MXException,
                      java.rmi.RemoteException

Business Rules : 1. A Crew may not be deleted if it is referenced by a Work Order or Job Plan

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

delete

public void delete(long accessModifier)
            throws MXException,
                   java.rmi.RemoteException

Description copied from class: Mbo

Mark the object to be deleted depending on the access modifier. This will usually be overridden in the subclass of Mbo as there may be application specific rules as to if and when an object can be deleted. Object is not actually deleted in the database until save() is called. This method will also mark all associated Long Description and Translation Mbos for deletion.

Specified by:

delete in interface MboRemote

Overrides:

delete in class Mbo

Parameters:

accessModifier - The bitwise flag specified to determine if certain normal security checks are to be bypassed for this delete request. For example: if the accessModifer is NOACCESSCHECK, then the check for the object's NODELETE flag and the call to the object's canDelete() method will not be performed. If the accessModifer is NONE, then all the access checks are performed before this object is marked delete.

Throws:

MXException

java.rmi.RemoteException

See Also:

Mbo.delete(long)

duplicate

public MboRemote duplicate()
                    throws MXException,
                           java.rmi.RemoteException

Description copied from class: Mbo

Duplicate method only throws exception now

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

MboRemote.duplicate()

getStatusListName

public java.lang.String getStatusListName()

Description copied from class: StatefulMbo

Return the name of the value list which contains the list of status's. This MUST be overridden by the Mbo programmer.

Specified by:

getStatusListName in interface StatefulMboRemote

Specified by:

getStatusListName in class StatefulMbo

See Also:

StatefulMbo.getStatusListName()

associateCrewType

public void associateCrewType()
                       throws MXException,
                              java.rmi.RemoteException

Associate the Crew Type copying all requirements (crafts, qualifications and tools)

Specified by:

associateCrewType in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

associateCrewType()

refreshkRequirements

public void refreshkRequirements()
                          throws MXException,
                                 java.rmi.RemoteException

Refresh the required crafts, qualifications and tools.

Specified by:

refreshkRequirements in interface AMCrewRemote

Parameters:

crewtemplate -

Throws:

MXException

java.rmi.RemoteException

See Also:

refreshkRequirements()

checkCalendarAndShift

public void checkCalendarAndShift()
                           throws MXException,
                                  java.rmi.RemoteException

This method checks whether this crew has a calendar and a shift associated with it. If not, no calendar exceptions may be added to the modavail table through the Modify Availability dialog in Assignment Manager. Assignment Manager method

Specified by:

checkCalendarAndShift in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

checkCalendarAndShift()

changeStatus

public void changeStatus(java.lang.String newStatus,
                         java.lang.String memo)
                  throws MXException,
                         java.rmi.RemoteException

Throws:

MXException

java.rmi.RemoteException

setWorkHrs

public void setWorkHrs(java.util.Date DayOneClientDate)
                throws MXException,
                       java.rmi.RemoteException

Sets the available hours for the 7 dayN attributes (all non-persistent). This method fetches the eligible hours from the corresponding person object and subtracts the hours already consumed by assignments. The AMGridCreated field tells whether this has already been done for this labor (needed because we can't predict the order in which the dayN fields will be accessed -- whichever one is called first will call the setWorkHrs method).

Specified by:

setWorkHrs in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setWorkHrs(Date)

getServerDTFromClientDT

public java.util.Date getServerDTFromClientDT(java.util.Date clientDateTime,
                                              java.util.GregorianCalendar scratchCal)
                                       throws MXException,
                                              java.rmi.RemoteException

Generates a datetime in the server time zone from a datetime in the client time zone, using previously calculated zone offsets.

Specified by:

getServerDTFromClientDT in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getServerDTFromClientDT(Date, GregorianCalendar)

getClientDTFromServerDT

public java.util.Date getClientDTFromServerDT(java.util.Date serverDateTime,
                                              java.util.GregorianCalendar scratchCal)
                                       throws MXException,
                                              java.rmi.RemoteException

Generates a datetime in the client time zone from a datetime in the server time zone, using previously calculated zone offsets.

Specified by:

getClientDTFromServerDT in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getClientDTFromServerDT(Date, GregorianCalendar)

getAvailableMbo

public MboRemote getAvailableMbo(java.util.Date startDate)
                          throws MXException,
                                 java.rmi.RemoteException

Get either the WorkPeriod mbo or the ModAvail mbo if there is one.

Specified by:

getAvailableMbo in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getAvailableMbo(Date)

getAvailableMboList

public java.util.List<MboRemote> getAvailableMboList(java.util.Date startDate)
                                              throws MXException,
                                                     java.rmi.RemoteException

This returns either the workperiod or modavail mbo for the given parameters. Returns null if there is no mbo available for the date or org.

Specified by:

getAvailableMboList in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getAvailableMbo(Date)

getDateTime

public java.util.Date getDateTime(java.util.Date workdt,
                                  java.util.Date sttime)

Specified by:

getDateTime in interface AMCrewRemote

Parameters:

workdt -

sttime -

Returns:

See Also:

getDateTime(Date, Date)

getWPEndDateTime

public java.util.Date getWPEndDateTime(MboRemote WorkTimeMbo,
                                       java.util.Date wpStartDateTime,
                                       java.util.GregorianCalendar scratchCal)
                                throws MXException,
                                       java.rmi.RemoteException

Gets the end datetime for the workperiod. Deals with the case when the workperiod spans midnight.

Specified by:

getWPEndDateTime in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getWPEndDateTime(MboRemote, Date, GregorianCalendar)

getDayNAssignmentSet

public MboSetRemote getDayNAssignmentSet(MboRemote theCrewMbo,
                                         java.util.Date wpStartDateTime,
                                         java.util.Date wpEndDateTime)
                                  throws MXException,
                                         java.rmi.RemoteException

Fetch the mboset of those assignments for this crew that start within the working time of the dayN under consideration.

Specified by:

getDayNAssignmentSet in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getDayNAssignmentSet(MboRemote, Date, Date)

getAvailableHours

public double getAvailableHours(java.util.Date startDate)
                         throws MXException,
                                java.rmi.RemoteException

Get either the number of workhours for this day, either from the modavail table, if there is an entry, or from the workperiod table.

Specified by:

getAvailableHours in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getAvailableHours(Date)

getAssignedHours

public double getAssignedHours(boolean insideCurrentDateWorkingTime,
                               java.util.Date wpStartDateTime,
                               java.util.Date wpEndDateTime,
                               MboSetRemote dayNAssignmentSet)
                        throws MXException,
                               java.rmi.RemoteException

Sums up the assigned hours of the assignments in the assignment set, but only those portions of them that are actually inside working time. (That is, the assigned hours are the intersection of the assignment with working time.) There are four scenarios to be handled: 1) the assignment is entirely inside working time (assignStart after-or-equal-to workStart AND assignFinish before-or-equal-to workFinish) 2) the assignment starts in working time and extends beyond it (assignStart after-or-equal-to workStart AND assignFinish after workFinish) 3) the assignment starts before working time and finishes within it (assignStart before workStart AND assignFinish before-or-equal-to workFinish) 4) the assignment wholly spans working time (assignStart before workStart AND assignFinish after workFinish)

Specified by:

getAssignedHours in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getAssignedHours(boolean, Date, Date, MboSetRemote)

getServerDateColumn

public java.util.Date[] getServerDateColumn()
                                     throws MXException,
                                            java.rmi.RemoteException

Specified by:

getServerDateColumn in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getServerDateColumn()

setServerDateColumn

public void setServerDateColumn(java.util.Date[] newServerDateColumn)
                         throws MXException,
                                java.rmi.RemoteException

Specified by:

setServerDateColumn in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setServerDateColumn(Date[])

getLabors

public java.util.Collection getLabors(java.util.Date currentDate)
                               throws MXException,
                                      java.rmi.RemoteException

Get all labors assigned on this crew for the currentDate

Specified by:

getLabors in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getLabors(Date)

getTools

public java.util.Collection getTools(java.util.Date currentDate)
                              throws MXException,
                                     java.rmi.RemoteException

Get all tools assigned on this crew for the currentDate

Specified by:

getTools in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

getTools(Date)

isAMGridCreated

public boolean isAMGridCreated()
                        throws MXException,
                               java.rmi.RemoteException

Specified by:

isAMGridCreated in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

isAMGridCreated()

setAMGridCreated

public void setAMGridCreated(boolean gridCreated)
                      throws MXException,
                             java.rmi.RemoteException

Specified by:

setAMGridCreated in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setAMGridCreated(boolean)

childHasChanged

public void childHasChanged()
                     throws MXException,
                            java.rmi.RemoteException

Specified by:

childHasChanged in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

childHasChanged()

getMboSet

public MboSetRemote getMboSet(java.lang.String name)
                       throws MXException,
                              java.rmi.RemoteException

Description copied from class: Mbo

Get a related MboSet for the object using the named relationship. Used for cross object linking; for example,Work Order to Asset.

Specified by:

getMboSet in interface MboRemote

Overrides:

getMboSet in class Mbo

Parameters:

name - The relationship provided to retrieve a related mboSet, usually using foreign keys. For example, "psdi.app.workorder.WOSetRemote.ASSET" is a relationship for the work order object to access the asset Set where "workorder.assetnum=asset.assetnum". The relationship can also be chained. Such as ASSET.ASSETSTATUS.

Returns:

The returned related set specified through the relationship.

Throws:

MXException - "A relationship called {0} does not exist for the {1} business object" exception will be thrown if the relationship was not found. "Unknown Object" exception will be thrown if the database object can not be found through the relationship.

java.rmi.RemoteException

See Also:

Mbo.getMboSet(java.lang.String)

calculateAvailabilityData

public void calculateAvailabilityData()
                               throws MXException,
                                      java.rmi.RemoteException

The method calculates the values for the nonpersistent fields StartTime, Availability (i.e. availabile hours) and Assigned (whether there's any assigned time in the working time after the start time) that reside on the Available Crew dialog of the Assignment tab's Assignment table

Specified by:

calculateAvailabilityData in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

calculateAvailabilityData()

updateStandardRate

public void updateStandardRate()
                        throws MXException,
                               java.rmi.RemoteException

Update standard rate field by calculating the sum of all labor and asset rates

Specified by:

updateStandardRate in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

updateStandardRate()

getEarliestUnassignedDateTime

public java.util.Date getEarliestUnassignedDateTime(MboSetRemote dayNAssignmentSet,
                                                    java.util.Date rangeStartDateTime,
                                                    java.util.Date rangeFinishDateTime)
                                             throws MXException,
                                                    java.rmi.RemoteException

This is passed a mboSet of assignments and a datetime range. It loops through the assignments to find the earliest time in the range that isn't part of an existing assignment (which may turn out to be the end of the range). Note that the assignments should be ordered by scheduledate (i.e. start time), so as soon as we find one that starts *after* the candidate time, we're done.

Throws:

MXException

java.rmi.RemoteException

getLatitudeY

public java.lang.Double getLatitudeY()
                              throws MXException,
                                     java.rmi.RemoteException

Description copied from interface: GISable

Return a double value with the the Latitude (or Y) coordinate of the current entitty.

Specified by:

getLatitudeY in interface GISable

Returns:

Double or null

Throws:

MXException

java.rmi.RemoteException

hasCoords

public java.lang.Boolean hasCoords()
                            throws MXException,
                                   java.rmi.RemoteException

Description copied from interface: GISable

Check if this autolocatable object has coordinates filled (LAT,LONG)

Specified by:

hasCoords in interface GISable

Returns:

the boolean

Throws:

MXException - the mX exception

java.rmi.RemoteException - the remote exception

getLongitudeX

public java.lang.Double getLongitudeX()
                               throws MXException,
                                      java.rmi.RemoteException

Description copied from interface: GISable

Return a double value with the the Longitude (or X) coordinate of the current entitty.

Specified by:

getLongitudeX in interface GISable

Returns:

Double or null

Throws:

MXException

java.rmi.RemoteException

getAddressString

public java.lang.String getAddressString()
                                  throws MXException,
                                         java.rmi.RemoteException

There is no address string with LBSLocation. This will always return null;

Specified by:

getAddressString in interface GISable

Returns:

Double or null

Throws:

MXException

java.rmi.RemoteException

isGISDataReadonly

public boolean isGISDataReadonly()
                          throws MXException,
                                 java.rmi.RemoteException

Description copied from interface: GISable

Indicate if the current GIS entity is editable or not. Usefull when the coordinates are populated using an external system.

Specified by:

isGISDataReadonly in interface GISable

Returns:

Throws:

MXException

java.rmi.RemoteException

saveGISData

public void saveGISData(java.lang.String address,
                        java.lang.String lat,
                        java.lang.String lng)
                 throws MXException,
                        java.rmi.RemoteException

The address here is not saved as this will be writing out to LBSLocation table which does not contain an address. The address parameter will be ignored. This method will see if there is an existing record in LBSLocation, delete the record and then add a new record based on the latitude and longitude passed.

Specified by:

saveGISData in interface GISable

Throws:

MXException

java.rmi.RemoteException

getLocationAccuracy

public java.lang.Double getLocationAccuracy()
                                     throws MXException,
                                            java.rmi.RemoteException

Specified by:

getLocationAccuracy in interface LBS

Throws:

MXException

java.rmi.RemoteException

getAltitude

public java.lang.Double getAltitude()
                             throws MXException,
                                    java.rmi.RemoteException

Specified by:

getAltitude in interface LBS

Throws:

MXException

java.rmi.RemoteException

getAltitudeAccuracy

public java.lang.Double getAltitudeAccuracy()
                                     throws MXException,
                                            java.rmi.RemoteException

Specified by:

getAltitudeAccuracy in interface LBS

Throws:

MXException

java.rmi.RemoteException

getHeading

public java.lang.Double getHeading()
                            throws MXException,
                                   java.rmi.RemoteException

Specified by:

getHeading in interface LBS

Throws:

MXException

java.rmi.RemoteException

getLastUpdate

public java.util.Date getLastUpdate()
                             throws MXException,
                                    java.rmi.RemoteException

Specified by:

getLastUpdate in interface LBS

Throws:

MXException

java.rmi.RemoteException

getSpeed

public java.lang.Double getSpeed()
                          throws MXException,
                                 java.rmi.RemoteException

Specified by:

getSpeed in interface LBS

Throws:

MXException

java.rmi.RemoteException

saveLBSData

public void saveLBSData(java.lang.Double lat,
                        java.lang.Double lng,
                        java.lang.Double locationAccuracy,
                        java.lang.Double altitudeAccuracy,
                        java.lang.Double altitude,
                        java.lang.Double heading,
                        java.lang.Double speed)
                 throws MXException,
                        java.rmi.RemoteException

Specified by:

saveLBSData in interface LBS

Throws:

MXException

java.rmi.RemoteException

getValidContract

public MboRemote getValidContract(java.util.Date startDate)
                           throws MXException,
                                  java.rmi.RemoteException

Get the valid contract for the Crew.

Specified by:

getValidContract in interface AMCrewRemote

Parameters:

startDate -

Returns:

valid contract mbo or null if the contract is not valid

Throws:

MXException

java.rmi.RemoteException

See Also:

getValidContract(Date)

getCompositeWP

public MboRemote getCompositeWP(java.util.List<MboRemote> modAvailList,
                                java.util.Date workDate)
                         throws MXException,
                                java.rmi.RemoteException

This takes a List of ModAvail mbos and combines them with the WorkPeriod of the same workdate, if any, into a single "composite" workperiod. The work hours of the modavail objects are subtracted from (if non-work) or added to (if work) those in the workperiod. The start- and end- times are adjusted, if possible, to match those of the modavails. If all the work segments are connected, then the span of the start- and end- times will equal the number of work hours. If there are gaps in the work time as defined, then the start/end span will be larger than the number of work hours. In the latter case, there will be no information about where the gaps are.

Specified by:

getCompositeWP in interface AMCrewRemote

Parameters:

modAvailList - A list of ModAvail mbos for the given WorkDate, or a list containing a single workperiod, if no ModAvail rows were defined, or a list with a single null entry, if no workperiod was defined.

workDate - The date in question.

person - The person for whom the Modavail objects were defined.

orgid - The OrgID.

Returns:

A WorkPeriod MboRemote

Throws:

MXException

java.rmi.RemoteException

getCurrentShiftStartDate

public java.util.Date getCurrentShiftStartDate(java.util.Date effectiveDate)
                                        throws MXException,
                                               java.rmi.RemoteException

Specified by:

getCurrentShiftStartDate in interface AMCrewRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

getCurrentShiftStartDate(Date)

getCurrentShiftEndDate

public java.util.Date getCurrentShiftEndDate(java.util.Date endDate)
                                      throws MXException,
                                             java.rmi.RemoteException

Specified by:

getCurrentShiftEndDate in interface AMCrewRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

getCurrentShiftEndDate(Date)

setCrewDate

public void setCrewDate(java.util.Date date)
                 throws MXException,
                        java.rmi.RemoteException

Set crew date

Specified by:

setCrewDate in interface AMCrewRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

setCrewDate(Date date)

getCrewDate

public java.util.Date getCrewDate()
                           throws MXException,
                                  java.rmi.RemoteException

Get crew date

Specified by:

getCrewDate in interface AMCrewRemote

Throws:

java.rmi.RemoteException

MXException

See Also:

getCrewDate()

getCrewMemberCount

public int getCrewMemberCount(java.util.Date desiredDate)
                       throws MXException,
                              java.rmi.RemoteException

Get members count related to MaxVar CREWDURATION for a specific date

Specified by:

getCrewMemberCount in interface AMCrewRemote

Parameters:

desiredDate - The date you want to know the members count

Returns:

Throws:

MXException

java.rmi.RemoteException

MXApplicationException

See Also:

getCrewMemberCount(Date desiredDate)

setDateTo

public void setDateTo(java.util.Date dateTo)
               throws MXException,
                      java.rmi.RemoteException

Specified by:

setDateTo in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

getDateTo

public java.util.Date getDateTo()
                         throws MXException,
                                java.rmi.RemoteException

Specified by:

getDateTo in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException

getEligibleHours

public double[] getEligibleHours()
                          throws MXException,
                                 java.rmi.RemoteException

Specified by:

getEligibleHours in interface AMCrewRemote

Throws:

MXException

java.rmi.RemoteException