com.ibm.tivoli.maximo.appt.app

Class ApptBook

java.lang.Object

psdi.mbo.Mbo

psdi.mbo.StatefulMbo

com.ibm.tivoli.maximo.appt.app.ApptBook

All Implemented Interfaces:

ApptBookRemote, java.rmi.Remote, MboConstants, MboRemote, StatefulMboRemote, MaxRemoteProxy

public class ApptBook
extends StatefulMbo
implements ApptBookRemote

Field Summary

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
ApptBook(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	applyApptWindow(MboRemote apptWindow) Propagates APPTBKWINDOWAVAIL records from start date to end date of the apptbook for the input appt windows definition.
void	applyApptWindow(MboRemote apptwindow, java.util.Date startdate, java.util.Date enddate) Propagates APPTBKWINDOWAVAIL records from specified start date to end date for for the input appt windows definition.
void	applyApptWindows() Propagates APPTBKWINDOWAVAIL records from start date to end date of the apptbook for the input appt windows definition.
void	applyApptWindows(java.util.Date startdate, java.util.Date enddate) Propagates APPTBKWINDOWAVAIL records from specified start date to end date for for the input appt windows definition.
void	appValidate() Pre-save validation method.
boolean	canAapplyApptWindows() canApplyApptWindow() is called before apply the window.
void	canDelete() Can the object be deleted ? This is object specific and should be overridden.
void	checkShiftsDateLimits() Checks if at least one work period from the selected calendar is inside the start and end dates limits.
void	copyGroupsToCommGroup(MboSetRemote groupSet) Copies the selected groups values to the commitgroup.
void	copyJobPlansToJobPlanSet(MboSetRemote jobPlanSet) Copies the selected job plans to the Job Plans Set.
void	copyPersonsToCommPerson(MboSetRemote personSet) Copies the selected person values to the commitperson.
void	delete(long accessModifier) Mark the object to be deleted depending on the access modifier.
MboRemote	duplicate() This method creates a duplicate Appointment Book
protected StatusHandler	getStatusHandler() Return the status handler object to be used for the actual changing of the status.
protected MboSetRemote	getStatusHistory() Return the MboSet object used for storing the status change history.
java.lang.String	getStatusListName() Return the name of the value list which contains the list of status's.
void	init() Called by the framework when the Mbo has been constructed and the MboValues have been initialized.
protected void	save() Overrides the save of Mbo so that a row is added to the status history table when a new object is saved.
protected boolean	skipCopyField(MboValueInfo mvi) Overrides the skipCopyField() in the Mbo.
protected void	validateApptBookName() Check if there's an existing ApptBook record with the same name.

Methods inherited from class psdi.mbo.StatefulMbo

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

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, deleteDoclinks, 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, getMboSet, getMboSetInfo, getMboSetInfo, getMboValue, getMboValueData, getMboValueData, getMboValueData, getMboValueDataForDownload, getMboValueInfoStatic, getMboValueInfoStatic, getMessage, getMessage, getMessage, getMessage, getMXTransaction, getName, getOrgForGL, getOrgSiteForMaxvar, getOwner, getProfile, getPropagateKeyFlag, getProxy, getRecordIdentifer, getRecordMboName, getRecordType, getRelatedSets, getRelatedWhere, getRelatedWhere, getRelationshipNameToLangTable, getResourceName, getRowRestrictionFlag, getRowStamp, getRowStampObject, getSecurityLogger, getSiteOrg, getSqlLogger, getString, getString, getStringInBaseLanguage, getStringInSpecificLocale, getStringTransparent, getSynonymValueWhere, getTenantId, getTenantIdForNoMboRecordData, getThisMboSet, getTranslator, getUniqueIdentifer, getUniqueIDName, getUniqueIDValue, getUniqueLanguageIDRecord, getUserInfo, getUserName, getValidateOrder, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initFieldFlagsOnMbo, initRelationship, isApiBatchError, isAppLockEnabled, isAutoKeyed, isBasedOn, isChangeByUserWhenSetFromLookup, isDuringInit, 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, setDatabaseDefaultValues, setDatabaseDefaultValues, setDefaultValue, setDefaultValues, setDeleted, setDuringInit, 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, setRecordType, setReferencedMbo, setReferencedMbo, setResolveNoSqlWhere, setResourceName, setTenantIdForNoMboRecordData, 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, sigopGranted, sigOptionAccessAuthorized, smartFill, smartFind, smartFind, smartFind, smartFindByObjectName, smartFindByObjectName, smartFindByObjectNameDirect, startCheckpoint, thisToBeUpdated, throwRequiredException, toBeAdded, toBeDeleted, toBeSaved, toBeUpdated, toBeValidated, undelete, undeleteDoclinks, unlock, unselect, useDataSecurity, validate, validateAttributes, validateKeyUniqueness, valueChanged

Methods inherited from class java.lang.Object

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

Methods inherited from interface psdi.mbo.StatefulMboRemote

canChangeMaxStatus, canChangeStatus, canChangeStatus, canDeleteAttachedDocs, changeMaxStatus, changeMaxStatus, changeStatus, 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, 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

Constructor Detail

ApptBook

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

Throws:

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

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

save

protected void save()
             throws MXException,
                    java.rmi.RemoteException

Description copied from class: StatefulMbo

Overrides the save of Mbo so that a row is added to the status history table when a new object is saved.

Overrides:

save in class StatefulMbo

Throws:

MXException

java.rmi.RemoteException

appValidate

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

Description copied from class: Mbo

Pre-save validation method. Programmer can override with specific rules.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

validateApptBookName

protected void validateApptBookName()
                             throws java.rmi.RemoteException,
                                    MXException

Check if there's an existing ApptBook record with the same name.

Throws:

java.rmi.RemoteException

MXException

canAapplyApptWindows

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

canApplyApptWindow() is called before apply the window. So, the user doesn't need to explicitly call canApplyApptWindow().

Specified by:

canAapplyApptWindows in interface ApptBookRemote

Throws:

MXException

java.rmi.RemoteException

checkShiftsDateLimits

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

Description copied from interface: ApptBookRemote

Checks if at least one work period from the selected calendar is inside the start and end dates limits. This method is called before apply the window. So, the user doesn't need to explicitly call it.

Specified by:

checkShiftsDateLimits in interface ApptBookRemote

Throws:

MXException

java.rmi.RemoteException

applyApptWindows

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

Propagates APPTBKWINDOWAVAIL records from start date to end date of the apptbook for the input appt windows definition. canApplyApptWindow() is called before apply the window. So, the user doesn't need to explicitly call canApplyApptWindow().

Specified by:

applyApptWindows in interface ApptBookRemote

Throws:

MXException

java.rmi.RemoteException

applyApptWindow

public void applyApptWindow(MboRemote apptWindow)
                     throws MXException,
                            java.rmi.RemoteException

Propagates APPTBKWINDOWAVAIL records from start date to end date of the apptbook for the input appt windows definition. canApplyApptWindow() is called before apply the window. So, the user doesn't need to explicitly call canApplyApptWindow().

Specified by:

applyApptWindow in interface ApptBookRemote

Throws:

MXException

java.rmi.RemoteException

applyApptWindows

public void applyApptWindows(java.util.Date startdate,
                             java.util.Date enddate)
                      throws MXException,
                             java.rmi.RemoteException

Propagates APPTBKWINDOWAVAIL records from specified start date to end date for for the input appt windows definition. canApplyApptWindow() is called before apply the window. So, the user doesn't need to explicitly call canApplyApptWindow().

Specified by:

applyApptWindows in interface ApptBookRemote

Throws:

MXException

java.rmi.RemoteException

applyApptWindow

public void applyApptWindow(MboRemote apptwindow,
                            java.util.Date startdate,
                            java.util.Date enddate)
                     throws MXException,
                            java.rmi.RemoteException

Propagates APPTBKWINDOWAVAIL records from specified start date to end date for for the input appt windows definition. canApplyApptWindow() is called before apply the window. So, the user doesn't need to explicitly call canApplyApptWindow().

Specified by:

applyApptWindow in interface ApptBookRemote

Throws:

MXException

java.rmi.RemoteException

copyPersonsToCommPerson

public void copyPersonsToCommPerson(MboSetRemote personSet)
                             throws MXException,
                                    java.rmi.RemoteException

Copies the selected person values to the commitperson.

Specified by:

copyPersonsToCommPerson in interface ApptBookRemote

Throws:

MXException

java.rmi.RemoteException

copyGroupsToCommGroup

public void copyGroupsToCommGroup(MboSetRemote groupSet)
                           throws MXException,
                                  java.rmi.RemoteException

Copies the selected groups values to the commitgroup.

Specified by:

copyGroupsToCommGroup in interface ApptBookRemote

Throws:

MXException

java.rmi.RemoteException

getStatusHandler

protected StatusHandler getStatusHandler()

Description copied from class: StatefulMbo

Return the status handler object to be used for the actual changing of the status. This is only called once by the framework. This method must be provided by the Mbo programmer.

Specified by:

getStatusHandler in class StatefulMbo

getStatusHistory

protected MboSetRemote getStatusHistory()
                                 throws MXException,
                                        java.rmi.RemoteException

Description copied from class: StatefulMbo

Return the MboSet object used for storing the status change history. This method must be provided by the Mbo programmer.

Specified by:

getStatusHistory in class StatefulMbo

Throws:

MXException

java.rmi.RemoteException

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

duplicate

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

This method creates a duplicate Appointment Book

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Returns:

duplicated ApptBook Mbo

Throws:

MXException

java.rmi.RemoteException

skipCopyField

protected boolean skipCopyField(MboValueInfo mvi)
                         throws java.rmi.RemoteException,
                                MXException

Overrides the skipCopyField() in the Mbo. Since this method takes the MboValueInfo as its parameter just check to see if this field needs to be copied or skipped by using the data from the static HashTable. If this field does not need to be copied return true. The following fields will be skipped without being copied to the newly duplicated object.

1. WORKZONE

Overrides:

skipCopyField in class Mbo

Parameters:

- - The MboValueInfo object of the MboValue that needs to be copied.

Returns:

- True,if the field does not need to be copied.In all other cases return false.

Throws:

MXException

java.rmi.RemoteException

copyJobPlansToJobPlanSet

public void copyJobPlansToJobPlanSet(MboSetRemote jobPlanSet)
                              throws MXException,
                                     java.rmi.RemoteException

Copies the selected job plans to the Job Plans Set.

Specified by:

copyJobPlansToJobPlanSet in interface ApptBookRemote

Throws:

MXException

java.rmi.RemoteException

canDelete

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

Description copied from class: Mbo

Can the object be deleted ? This is object specific and should be overridden.

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)