psdi.app.calendar

Interface CalendarRemote

All Superinterfaces:

MboRemote, java.rmi.Remote

All Known Implementing Classes:

Calendar

public interface CalendarRemote
extends MboRemote

Remote Interface to the Calendar object.

Method Summary

Modifier and Type	Method and Description
boolean	applyNonWorkTime(MboSetRemote nonWorkTimeSet)
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.
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 startDate, java.util.Date endDate) Calculate the acutal Downtime for an Asset for all work period records in this calendar between the input start date and end date.
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(java.lang.String shiftname) Can a shift be applied to a calendar? MXAccessException thrown when the shift cannot be applied.
void	deleteWorkPeriod(java.util.Date startDate, java.util.Date endDate) Delete WorkPeriod Mbo Set for the specified startdate and enddate
java.lang.String[][]	getMonthsAvailableHours(com.ibm.icu.util.Calendar cal)
WorkPeriodSetRemote	getWorkPeriodSet(java.util.Date workDate) Get the workperid mboset for the given workdate
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 interface psdi.mbo.MboRemote

add, addMboSetForRequiredCheck, addToDeleteForInsertList, blindCopy, checkMethodAccess, clear, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, duplicate, 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, 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, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, unlock, unselect, validate, validateAttributes

Method Detail

isAvailable

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.

Throws:

MXException

java.rmi.RemoteException

See Also:

psdi.app.laborgroup.LaborGroup.getFirstAvailablePerson().

canApplyShift

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

Can a shift be applied to a calendar? MXAccessException thrown when the shift cannot be applied.

Throws:

MXException

java.rmi.RemoteException

applyShift

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.

Throws:

MXException

java.rmi.RemoteException

applyShift

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.

Throws:

MXException

java.rmi.RemoteException

applyShift

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.

Throws:

MXException

java.rmi.RemoteException

applyNonWorkTime

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.

Throws:

MXException

java.rmi.RemoteException

applyNonWorkTime

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

Throws:

MXException

java.rmi.RemoteException

calculateAvailability

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.

Throws:

MXException

java.rmi.RemoteException

calculateAvailability

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.

Throws:

MXException

java.rmi.RemoteException

calculateDownTime

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

Calculate the acutal Downtime for an Asset for all work period records in this calendar between the input start date and end date. Return the number of hours.

Throws:

MXException

java.rmi.RemoteException

deleteWorkPeriod

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

Throws:

MXException

java.rmi.RemoteException

calculateWorkHours

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.

Throws:

MXException

java.rmi.RemoteException

getWorkPeriodSet

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

Get the workperid mboset for the given workdate

Returns:

WorkPeriodSetRemote

Throws:

MXException

java.rmi.RemoteException

getMonthsAvailableHours

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

Throws:

MXException

java.rmi.RemoteException

setWPIncrement

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

Throws:

MXException

java.rmi.RemoteException