psdi.app.calendar

Class Calendar

java.lang.Object

psdi.mbo.Mbo

psdi.app.calendar.Calendar

All Implemented Interfaces:

java.rmi.Remote, CalendarRemote, MboConstants, MboRemote, MaxRemoteProxy

public class Calendar
extends Mbo
implements CalendarRemote

Mbo object to represent Calendar : Use the Calendar object to indicate working time for asset, craft, and labor records. A calendar is defined by a start date, an end date, and the shift to be worked. It is also possible to designate non-working time and holidays in a calendar.

Attribute Description

Attribute	Description
CALNUM	Calendar Number
DESCRIPTION	Calendar Description
ENDDATE	Calendar End Day
LDKEY	Long Description Key
STARTDATE	Calendar Start Day

Author:

Ramadevi Bhogadi

Field Summary

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
Calendar(MboSet ms) Construct the Calendar object

Method Summary

Methods

Modifier and Type	Method and Description
void	add() This is called when a new Mbo is added to the Mboset collection.
java.util.Date	addDates(java.util.Date date, int days) Add or minus days from the given date.
boolean	applyNonWorkTime(MboSetRemote nonWorkTimeSet) Propagates workperiod records from specified non-working start date to end date.
void	applyNonWorkTime(java.lang.String nonWorkType, java.lang.String description, java.util.Date startDate, java.util.Date endDate) Propagates workperiod records from specified non-working start date to end date.
void	applyShift(java.lang.String shiftname) Propagates workperiod records from start date to end date of the calendar for the input shift definition.
void	applyShift(java.lang.String shiftname, java.util.Date startdate, java.util.Date enddate) Propagates workperiod records from specified start date to end date for a selected shift definition.
void	applyShift(java.util.Vector shiftSet) Propagates workperiod records from start date to end date of the calendar for the input shift definition.
void	appValidate() Pre-save validation method.
double	calculateAvailability() Add up the total work hours for all work period records in this calendar between its start date and end date.
double	calculateAvailability(java.util.Date startDate, java.util.Date endDate) Add up the total work hours for all work period records in this calendar between the input start date and end date.
double	calculateDownTime(java.util.Date lastChangeDate, java.util.Date currentChangeDate) Calculate the actual Downtime for an Asset.
double	calculateHours(java.util.Date date1, java.util.Date date2) Calculate Elapsed Time in hours.
double	calculateWorkHours(java.util.Date workDate) Add up the total work hours for all work period records in this calendar for the given work date.
void	canApplyShift(ShiftRemote shift) Can a shift be applied to a calendar? A shift can be applied to a calendar only if a pattern has already been defined for that shift.
void	canApplyShift(java.lang.String shiftname) Can a shift be applied to a calendar? Cannot apply the shift to the calendar when it is not existing.
void	canDelete() canDelete method.
java.util.Date	combineDateTime(java.util.Date date, java.util.Date time) Combine fist Date's date and second Date's time and return a new date.
void	delete(long accessModifier) Delete the calendar record and delete associated workperiod records.
void	deleteWorkPeriod(java.util.Date startDate, java.util.Date endDate) Delete WorkPeriod Mbo Set for the specified startdate and enddate
MboRemote	duplicate() This method creates a duplicate calendar Copies over all the workperiods that belong to this calendar
void	generateAutoKey() Calendar supports autokeying - sets the calnum attribute.
double	getDownTime(java.util.Date currentChangeDate, java.util.Date lastChangeDate) Get WorkPeriod Mbo Set with given where clause.
java.lang.String[][]	getMonthsAvailableHours(com.ibm.icu.util.Calendar cal) Gets The Available Hours in the Month for given Calendar
double	getWorkPeriodData(WorkPeriodSet workPeriodSet, java.util.Date lastChangeDate, java.util.Date currentChangeDate) Get WorkPeriod data and calcualte down time.
WorkPeriodSetRemote	getWorkPeriodSet(java.util.Date workDate) Get the workperid mboset for the given workdate
void	init() Called by the framework when the Mbo has been constructed and the MboValues have been initialized.
boolean	isAvailable(java.util.Date date) Function to determine if the date passed in is within this calendar.
void	setWPIncrement(int i)

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkSiteOrgAccessForSave, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, determineRequiredFieldsFromERM, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, generateContentUID, getAlwaysFlags, getAttrRestrictionFlag, getAttrRestrictions, getBoolean, getByte, getBytes, getCheckpoint, getClientLocale, getClientTimeZone, getCommLogOwnerNameAndUniqueId, getCondition, getDatabaseValue, getDate, getDeleteForInsertList, getDocLinksCount, getDomainFilterWhere, getDomainIDs, getDouble, getExistingMboSet, getFetchIndex, getFieldExceptions, getFlags, getFloat, getIgnoreLockCheck, getInitialValue, getInsertCompanySetId, getInsertItemSetId, getInsertOrganization, getInsertSite, getInstanciatedMboSet, getInstanciatedMboValue, getInt, getIntegrationService, getKeyValue, getLanguageRecordRowStamp, getLinesRelationship, getList, getLockedByDisplayName, getLockedByUserID, getLong, getMatchingAttr, getMatchingAttr, getMatchingAttrs, getMaxMessage, getMboData, getMboDataSet, getMboForAttribute, getMboForAttributeStatic, getMboInitialValue, getMboList, getMboLogger, getMboRecordData, getMboServer, getMboSet, getMboSet, getMboSet, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getRowRestrictionFlag, getRowStamp, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isEAuditFieldModified, isESigFieldModified, isFlagSet, isForDM, isLocked, isLocked, isLockedByMe, isMasterTenant, isMboLockedByMe, isModified, isModified, isNew, isNull, isOptionGranted, isSelected, isSkipCopyField, isValid, isZombie, lock, modify, moveFieldFlagsToMboValue, needCallInitFieldFlag, orEvaluateConditions, propagateKeyValue, removeRelatedSet, rollbackToCheckpoint, select, setAppDefaultValue, setApplicationError, setApplicationRequired, setAutokeyFields, setCopyDefaults, setDefaultValue, setDefaultValues, setDeleted, setEAuditFieldModified, setESigFieldModified, setFetchIndex, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlag, setFieldFlags, setFlag, setFlag, setFlags, setForDM, setHierarchyLink, setIgnoreRecordLockCheck, setLangCodeDefault, setMLValue, setModified, setNewMbo, setPropagateKeyFlag, setPropagateKeyFlag, setProxy, setReadonlyWhenParentIsReadonly, setReferencedMbo, setReferencedMbo, 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.MboRemote

addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, excludeObjectForPropagate, 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, getMboSet, getMboValueData, getMboValueData, getMboValueData, 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

Constructor Detail

Calendar

public Calendar(MboSet ms)
         throws MXException,
                java.rmi.RemoteException

Construct the Calendar object

Parameters:

ms -

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Description copied from class: Mbo

Called by the framework when the Mbo has been constructed and the MboValues have been initialized. This can be overridden by the programmer to provide any custom initialization they would like to do.

Overrides:

init in class Mbo

Throws:

MXException

generateAutoKey

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

Calendar supports autokeying - sets the calnum attribute. Only allowed for newly created calendar.

Specified by:

generateAutoKey in interface MboRemote

Overrides:

generateAutoKey in class Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

MboValue.autoKey(), MboValue.generateUniqueID()

isAvailable

public boolean isAvailable(java.util.Date date)
                    throws MXException,
                           java.rmi.RemoteException

Function to determine if the date passed in is within this calendar. It is called by AssignmntQueue's getFirstAvailablePerson() function.

Specified by:

isAvailable in interface CalendarRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.laborgroup.LaborGroup#getFirstAvailablePerson, AvailCalc.checkAvailableCalendar(java.util.Date, java.util.Date, java.lang.String)

appValidate

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

Pre-save validation method. Validating startdate and enddate before save.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

duplicate

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

This method creates a duplicate calendar Copies over all the workperiods that belong to this calendar

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Returns:

duplicated Calendar Mbo

Throws:

MXException

java.rmi.RemoteException

See Also:

skipCopyField(psdi.mbo.MboValueInfo)

canDelete

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

canDelete method. It can only be deleted where there is no labor and asset records referencing to this calendar.

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

delete

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

Delete the calendar record and delete associated workperiod records.

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)

canApplyShift

public void canApplyShift(ShiftRemote shift)
                   throws MXException,
                          java.rmi.RemoteException

Can a shift be applied to a calendar? A shift can be applied to a calendar only if a pattern has already been defined for that shift.

Throws:

MXException

java.rmi.RemoteException

canApplyShift

public void canApplyShift(java.lang.String shiftname)
                   throws MXException,
                          java.rmi.RemoteException

Can a shift be applied to a calendar? Cannot apply the shift to the calendar when it is not existing.

Specified by:

canApplyShift in interface CalendarRemote

Throws:

MXException

java.rmi.RemoteException

applyShift

public void applyShift(java.util.Vector shiftSet)
                throws MXException,
                       java.rmi.RemoteException

Propagates workperiod records from start date to end date of the calendar for the input shift definition. canApplyShift() is called before apply the shift. So, the user doesn't need to explicitly call canApplyShift(). If the shift is applied after a holiday or non-working time is applied, the holiday or non-working time information will be lost and the user has to reapply them afterwards.

Specified by:

applyShift in interface CalendarRemote

Throws:

MXException

java.rmi.RemoteException

applyShift

public void applyShift(java.lang.String shiftname)
                throws MXException,
                       java.rmi.RemoteException

Propagates workperiod records from start date to end date of the calendar for the input shift definition. canApplyShift() is called before apply the shift. So, the user doesn't need to explicitly call canApplyShift(). If the shift is applied after a holiday or non-working time is applied, the holiday or non-working time information will be lost and the user has to reapply them afterwards.

Specified by:

applyShift in interface CalendarRemote

Throws:

MXException

java.rmi.RemoteException

applyShift

public void applyShift(java.lang.String shiftname,
              java.util.Date startdate,
              java.util.Date enddate)
                throws MXException,
                       java.rmi.RemoteException

Propagates workperiod records from specified start date to end date for a selected shift definition. canApplyShift() is implicitly called before apply the shift. Exception will be thrown if the shift cannot be applied. If the shift is applied after a holiday or nonworking time is applied, the information will be lost and the user has to reapply the holiday or nonworking time afterwards.

Specified by:

applyShift in interface CalendarRemote

Throws:

MXException

java.rmi.RemoteException

setWPIncrement

public void setWPIncrement(int i)
                    throws MXException,
                           java.rmi.RemoteException

Specified by:

setWPIncrement in interface CalendarRemote

Throws:

MXException

java.rmi.RemoteException

applyNonWorkTime

public boolean applyNonWorkTime(MboSetRemote nonWorkTimeSet)
                         throws MXException,
                                java.rmi.RemoteException

Propagates workperiod records from specified non-working start date to end date. It changes the shift value to the user given non-work type. Returns true if it applies a non working time.

Specified by:

applyNonWorkTime in interface CalendarRemote

Throws:

MXException

java.rmi.RemoteException

applyNonWorkTime

public void applyNonWorkTime(java.lang.String nonWorkType,
                    java.lang.String description,
                    java.util.Date startDate,
                    java.util.Date endDate)
                      throws MXException,
                             java.rmi.RemoteException

Propagates workperiod records from specified non-working start date to end date. It changes the shift value to the user given non-work type.

Specified by:

applyNonWorkTime in interface CalendarRemote

Throws:

MXException

java.rmi.RemoteException

calculateAvailability

public double calculateAvailability()
                             throws MXException,
                                    java.rmi.RemoteException

Add up the total work hours for all work period records in this calendar between its start date and end date. Return the number of hours.

Specified by:

calculateAvailability in interface CalendarRemote

Throws:

MXException

java.rmi.RemoteException

calculateAvailability

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

Add up the total work hours for all work period records in this calendar between the input start date and end date. Return the number of hours.

Specified by:

calculateAvailability in interface CalendarRemote

Returns:

double (total workhours)

Throws:

MXException

java.rmi.RemoteException

See Also:

getDownTime(java.util.Date, java.util.Date)

calculateHours

public double calculateHours(java.util.Date date1,
                    java.util.Date date2)

Calculate Elapsed Time in hours. Return the two days difference in hours.

Returns:

double

calculateDownTime

public double calculateDownTime(java.util.Date lastChangeDate,
                       java.util.Date currentChangeDate)
                         throws MXException,
                                java.rmi.RemoteException

Calculate the actual Downtime for an Asset. If there is no Calendar, the Actual Downtime is just the elapsed time. If there is a Calendar the Actual Downtime is calculated by adding up the total WORKHOURS for all WORKPERIOD records for the calendar on the Asset between lastChangeDate and currentChangeDate. Returns the Actual Downtime in Hours.

Specified by:

calculateDownTime in interface CalendarRemote

Returns:

double

Throws:

MXException

java.rmi.RemoteException

getDownTime

public double getDownTime(java.util.Date currentChangeDate,
                 java.util.Date lastChangeDate)
                   throws MXException,
                          java.rmi.RemoteException

Get WorkPeriod Mbo Set with given where clause.

Returns:

double

Throws:

MXException

java.rmi.RemoteException

getWorkPeriodData

public double getWorkPeriodData(WorkPeriodSet workPeriodSet,
                       java.util.Date lastChangeDate,
                       java.util.Date currentChangeDate)
                         throws MXException,
                                java.rmi.RemoteException

Get WorkPeriod data and calcualte down time.

Returns:

double

Throws:

MXException

java.rmi.RemoteException

addDates

public java.util.Date addDates(java.util.Date date,
                      int days)

Add or minus days from the given date.

combineDateTime

public java.util.Date combineDateTime(java.util.Date date,
                             java.util.Date time)

Combine fist Date's date and second Date's time and return a new date.

deleteWorkPeriod

public void deleteWorkPeriod(java.util.Date startDate,
                    java.util.Date endDate)
                      throws MXException,
                             java.rmi.RemoteException

Delete WorkPeriod Mbo Set for the specified startdate and enddate

Specified by:

deleteWorkPeriod in interface CalendarRemote

Throws:

MXException

java.rmi.RemoteException

calculateWorkHours

public double calculateWorkHours(java.util.Date workDate)
                          throws MXException,
                                 java.rmi.RemoteException

Add up the total work hours for all work period records in this calendar for the given work date. Return the number of hours.

Specified by:

calculateWorkHours in interface CalendarRemote

Returns:

double (total workhours)

Throws:

MXException

java.rmi.RemoteException

getWorkPeriodSet

public WorkPeriodSetRemote getWorkPeriodSet(java.util.Date workDate)
                                     throws MXException,
                                            java.rmi.RemoteException

Get the workperid mboset for the given workdate

Specified by:

getWorkPeriodSet in interface CalendarRemote

Returns:

WorkPeriodSetRemote

Throws:

MXException

java.rmi.RemoteException

getMonthsAvailableHours

public java.lang.String[][] getMonthsAvailableHours(com.ibm.icu.util.Calendar cal)
                                             throws MXException,
                                                    java.rmi.RemoteException

Gets The Available Hours in the Month for given Calendar

Specified by:

getMonthsAvailableHours in interface CalendarRemote

Returns:

String[][]

Throws:

MXException

java.rmi.RemoteException

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