psdi.app.route

Class RouteStop

java.lang.Object

psdi.mbo.Mbo

psdi.app.route.RouteStop

All Implemented Interfaces:

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

public class RouteStop
extends Mbo
implements RouteStopRemote

MBO object to represent Route Stop.
See Route Package description for details.

This is a site level object.

The key attributes for this object are SiteId,Route and RouteStopID.

The attributes in this object are as follows::

Attribute Name	Description
AssetDescription	A non-persistent attribute that identifies the description of the asset or location, if they are not null.
Assetdescription_longdescription	A non-persistent attribute that identifies the long description of the asset or location, if they are not null.
Description	Description of the Route Stop.
Assetnum	Identifier of the Asset at Route Stop.
Jpnum	Identifier of the JobPlan to be used by Asset or Location during work order generation for this Route Stop.
LDKey	Long Description Key. This is a link to text stored in the LongDescription table.
Location	Identifier of the Location at Route Stop.
OrgId	Identifier of the organization for the Rotue Stop.
Route	Unique indifier for the route.
RouteStopId	Unique Identifier of a Route Stop record added to a Route.
SiteId	Identifier of the site for the Route Stop.
StopSequence	Indentifier of the sequence of Asset or Location to stop at a Route.
RTS1 through RTS5	Extra Fields.

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

Method Summary

Modifier and Type	Method and Description
void	add() Add a new Route Stop object.
void	appValidate() Every route stop should be associated either with a location or asset.
void	clearFormName() Set the value of "inspformname" equal to null.
void	clearLinearAssetFields() Clear all the linear asset fields.
int	getRouteStopId() generates Routestopid which is autonumbered(incremented by 1) for a new route stop
void	init() Initialize the route stop object
boolean	isChangeByUserWhenSetFromLookup(java.lang.String lookupAttrName, java.lang.String attributeName) Indicates whether the CHANGEDBY_USER flag should be set for attributes on this Mbo when their values are set (along with other key fields) via lookup.
void	setLinearAssetFieldsReadOnly(boolean readonlystate) Set the linear asset fields as a group to ReadOnly or not.
protected boolean	skipCopyField(MboValueInfo mvi) This method overrides the skipCopyField() in the Mbo.
void	undelete() Unmark the Mbo for deletion.
void	validateAssetLoc(boolean newAssetNum, boolean newLocation) Validates asset /location fields If asset entered -> location field set to null.

Methods inherited from class psdi.mbo.Mbo

addMboSetForRequiredCheck, addToDeleteForInsertList, andEvaluateConditions, blindCopy, canDelete, checkFieldAccess, checkMethodAccess, checkMethodAccess, checkQualifiedRestriction, checkRecordLock, checkSiteOrgAccessForSave, clear, clearRelatedSets, clearRelatedSets, commit, copy, copy, copy, copyFake, copyValue, copyValue, createComm, delete, delete, deleteDoclinks, determineRequiredFieldsFromERM, duplicate, enableMethod, evaluateCondition, evaluateCondition, evaluateCtrlConditions, evaluateCtrlConditions, evaluateRestriction, excludeObjectForPropagate, findAllNullRequiredFields, fireEvent, 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, 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, save, 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, 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.MboRemote

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, unlock, unselect, validate, validateAttributes

Constructor Detail

RouteStop

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

Construct the RouteStop object

Throws:

MXException

java.rmi.RemoteException

Method Detail

init

public void init()
          throws MXException

Initialize the route stop object

Overrides:

init in class Mbo

Throws:

MXException

See Also:

RouteStop.setAssetDescription()

add

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

Add a new Route Stop object. Non null Field defaults are set.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

appValidate

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

Every route stop should be associated either with a location or asset. Both asset and location cannot be null. If the asset is a linear asset and there is a feature or asset feature on the row then make sure it has a valid assetfeatureid

Overrides:

appValidate in class Mbo

Throws:

MXException - if both assetnum or location are null, then MXApplicationException("route","selectassetlocation")

java.rmi.RemoteException

validateAssetLoc

public void validateAssetLoc(boolean newAssetNum,
                             boolean newLocation)
                      throws MXException,
                             java.rmi.RemoteException

Validates asset /location fields If asset entered -> location field set to null. If location entered ->asset field set to null

Throws:

MXException

java.rmi.RemoteException

See Also:

RouteStop.setAssetDescription()

getRouteStopId

public int getRouteStopId()
                   throws MXException,
                          java.rmi.RemoteException

generates Routestopid which is autonumbered(incremented by 1) for a new route stop

Returns:

routestopid

Throws:

MXException

java.rmi.RemoteException

skipCopyField

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

This method overrides the skipCopyField() in the Mbo. This method takes the MboValueInfo as its parameter to see if this field needs to be copied or skipped.If this field does not need to be copied, it returns true. The following fields donot get copied from the source RouteStop to the target RouteStop.

1. route

Overrides:

skipCopyField in class Mbo

Parameters:

mvi - 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

undelete

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

Description copied from class: Mbo

Unmark the Mbo for deletion. Can only be called after a delete() and before the save() has been performed. This method will also unmark associated Long Description and Translation Mbos.

Specified by:

undelete in interface MboRemote

Overrides:

undelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

setLinearAssetFieldsReadOnly

public void setLinearAssetFieldsReadOnly(boolean readonlystate)
                                  throws MXException,
                                         java.rmi.RemoteException

Set the linear asset fields as a group to ReadOnly or not.

Throws:

MXException

java.rmi.RemoteException

clearLinearAssetFields

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

Clear all the linear asset fields.

Throws:

MXException

java.rmi.RemoteException

isChangeByUserWhenSetFromLookup

public boolean isChangeByUserWhenSetFromLookup(java.lang.String lookupAttrName,
                                               java.lang.String attributeName)

Indicates whether the CHANGEDBY_USER flag should be set for attributes on this Mbo when their values are set (along with other key fields) via lookup.

Overrides:

isChangeByUserWhenSetFromLookup in class Mbo

Parameters:

lookupAttrName - the attribute whose lookup is being called.

attributeName - the attribute that is not the lookup attribute.

Returns:

clearFormName

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

Set the value of "inspformname" equal to null.

Throws:

MXException

java.rmi.RemoteException