psdi.app.asset

Class AssetLocRelation

java.lang.Object

psdi.mbo.Mbo

psdi.app.asset.AssetLocRelation

All Implemented Interfaces:

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

public class AssetLocRelation
extends Mbo
implements AssetLocRelationRemote

MBO to represent an AssetLocRelation. See Asset package description for details.

This is a system level object.

The key attributes for this object is: SOURCEASSETNUM, TARGETASSETNUM and ASSETRELATIONNUM

The attributes in this object are as follows:

Attribute Name	Description
ASSETLOCRELATIONID	Unique ID
SOURCEASSETNUM	Identifier of the Source Asset.
SOURCELOCATION	Identifier of the Source Location.
TARGETASSETNUM	Identifier of the Target Asset.
TARGETLOCATION	Identifier of the Target Location.
SOURCESTARTMEASURE	Identifier of the Source Start Measure.
TARGETSTARTMEASURE	Identifier of the Target Strat Measure.
SOURCEENDMEASURE	Identifier of the Source End Measure.
TARGETENDMEASURE	Identifier of the Target End Measure.
SOURCESTARTOFFSET	Identifier of the Source Start Offset.
SOURCESTARTYOFFSET	Identifier of the Source Start Y Offset.
SITEID	SITE where AssetLocRelation exists.
ORGID	Organization where AssetLocRelation exists
SOURCEYOFFSETREF	Source Y Offset Referent.
TARGETYOFFSETREF	Target Y Offset Referant.
SOURCEZOFFSETREF	Source Z Offset Referent.
TARGETZOFFSETREF	Target z Offset Referant.
SOURCESTARTZOFFSET	Source start Z Offset.
TARGETSTARTOFFSET	Target Start Offste.
TARGETSTARTYOFFSET	Target Start Y Offset.
TARGETSTARTZOFFSET	Target Start Z Offset.
SOURCEENDOFFSET	Source End Offset.
SOURCEENDYOFFSET	Source End Y Offset.
SOURCEENDZOFFSET	Source End Z Offset.
TARGETENDOFFSET	Target End Offste.
TARGETENDYOFFSET	Target End Y Offste.
TARGETENDZOFFSET	Target End Z Offste.
SOURCESTARTASSETFEATUREID	Unique Identifier for the start of this AssetLocRelation''s source asset feature.
TARGETSTARTASSETFEATUREID	Unique Identifier for the start of this AssetLocRelation''s target asset feature.
SOURCEENDASSETFEATUREID	Unique Identifier for the end of this AssetLocRelation''s source asset feature.
TARGETENDASSETFEATUREID	Unique Identifier for the end of this AssetLocRelation''s target asset feature.
ASSETRELATIONNUM	Asset Relationship identifier.
CREATEDDATE	The Date when the relation between the two Assets were established.
SOURCELRM	Name of this linear referencing method. A linear referencing method is a mechanism for finding and stating the location of any point in a linear asset by referencing it to a known point. The method also specifies a marker (for example, mile post) and measure unit (for example, kilometre).
TARGETLRM	Name of this linear referencing method. A linear referencing method is a mechanism for finding and stating the location of any point in a linear asset by referencing it to a known point. The method also specifies a marker (for example, mile post) and measure unit (for example, kilometre)
SOURCESTARTFEATURELABEL	Label used to identify the specific AssetFeature used to locate the start of the portion of the linear asset for which this relationship applies.
SOURCEENDFEATURELABEL	Label used to identify the specific AssetFeature used to locate the end of the portion of the linear asset for which this relationship applies.
TARGETSTARTFEATURELABEL	Label used to identify the specific AssetFeature used to locate the start of the portion of the linear asset for which this relationship applies.
TARGETENDFEATURELABEL	Label used to identify the specific AssetFeature used to locate the end of the portion of the linear asset for which this relationship applies.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	createNewAssetNum

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
AssetLocRelation(MboSet ms)

Method Summary

Modifier and Type	Method and Description
void	add() sets defaults values for a new AssetLocRelation object.
void	appValidate() Pre-save validation method.
void	canDelete() If Asset Relationship is marked as the 'Use As Reference', also creates the asset feature records.
void	checkDuplicateRelationships(java.lang.String sourceassetnum, java.lang.String assetrelationnum, java.lang.String targetassetnum) Informs when a duplicate Relation has been entered for a SourceAsset/TragetAsset combination in AssetLocelationship table.
void	clearLinearAssetFields(java.lang.String attr) Clears all the source or target linear asset-related fields when an attribute containing "SOURCE" or "TARGET" is modified.
void	createSourceAssetFeatureRec() When a CI-Relationship is applied to Linear Asset and Asset Relationship has been identified as a referent , create assetfeature record(s).
void	createTargetAssetFeatureRec() When a CI-Relationship is applied to Linear Asset and Asset Relationship has been identified as a referent , create assetfeature record(s).
void	delete(long accessModifier) override delete to delete this record
java.lang.String[]	getValidateOrder() validation order for asset attributes
void	init() Initialization routine.
void	initFieldFlagsOnMbo(java.lang.String attrName) set linear-related field flags
boolean	isChangeByUserWhenSetFromLookup(java.lang.String lookupAttrName, java.lang.String attributeName) Indicate whether the changeed by user flag should be set to the attribute when it is set along with other key field when the lookup attribute is being set on this Linear Mbo.
void	recalAssetRelFeatureMesModify() Recalibration for Asset-Relationships.
void	recalAssetRelMesModify() Recalibration for Asset-Relationships.
void	save() on creating new AssetLocRelationship record also creates AssetLocRelHistory record.
void	setLinearAttrsREADONLYFlagOnSourceAsset() sets TargetAsset-related fields' READONLY flag.
void	setLinearAttrsREADONLYFlagOnTargetAsset() sets TargetAsset-related fields' READONLY flag.
void	validateRelationshipRules() Validates the relationship rules for Assets using the RELATIONRULEEXT rules

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, 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, 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, hasFieldAccess, hasHierarchyLink, hasLockSaveRights, hasRelatedQbe, hasUniqueID, initRelationship, isApiBatchError, isAutoKeyed, isBasedOn, 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.MboRemote

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

Field Detail

createNewAssetNum

public boolean createNewAssetNum

Constructor Detail

AssetLocRelation

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

Throws:

java.rmi.RemoteException

Method Detail

clearLinearAssetFields

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

Clears all the source or target linear asset-related fields when an attribute containing "SOURCE" or "TARGET" is modified. This method should be called from the field class action() method of the attribute for which this is the desired behavior. This will occur when SourceAssetnum or TargetAssetnum are modified.

Specified by:

clearLinearAssetFields in interface AssetLocRelationRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

FldAssetLocRelationSourceAssetNum.action(), FldAssetLocRelationTargetAssetNum.action()

init

public void init()
          throws MXException

Initialization routine.

Overrides:

init in class Mbo

Parameters:

none -

Throws:

none

MXException

getValidateOrder

public java.lang.String[] getValidateOrder()

validation order for asset attributes

Overrides:

getValidateOrder in class Mbo

Returns:

String array containing the asset attributes in the order in which they are to be validated

add

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

sets defaults values for a new AssetLocRelation object.

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException - MAXIMO System error

java.rmi.RemoteException - RMI error

save

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

on creating new AssetLocRelationship record also creates AssetLocRelHistory record. if the Linear Relationship(AssetLocRelation) has 'IsLinearRef' to true, creates, records in AssetFeature. createSourceAssetFeatureRec(); and createTargetAssetFeatureRec();

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

checkDuplicateRelationships

public void checkDuplicateRelationships(java.lang.String sourceassetnum,
                                        java.lang.String assetrelationnum,
                                        java.lang.String targetassetnum)
                                 throws MXException,
                                        java.rmi.RemoteException

Informs when a duplicate Relation has been entered for a SourceAsset/TragetAsset combination in AssetLocelationship table.

Parameters:

thisMbo - the object to which the meter is being added

Throws:

MXApplicationException("asset","sourcereltargetdupe") - when a duplicate relation is added to a asset-relationship.

MXException

java.rmi.RemoteException

canDelete

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

If Asset Relationship is marked as the 'Use As Reference', also creates the asset feature records. That asset feature record can be used as start reference point or end reference point in another asset feature. In this scenario asset relationship record cannot be deleted.

Overrides:

canDelete in class Mbo

Throws:

MXException

java.rmi.RemoteException

MXApplicationException

delete

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

override delete to delete this record

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)

setLinearAttrsREADONLYFlagOnSourceAsset

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

sets TargetAsset-related fields' READONLY flag. If asset is not linear, these will be READONLY.

Specified by:

setLinearAttrsREADONLYFlagOnSourceAsset in interface AssetLocRelationRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setLinearAttrsREADONLYFlagOnTargetAsset()

setLinearAttrsREADONLYFlagOnTargetAsset

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

sets TargetAsset-related fields' READONLY flag. If asset is not linear, these will be READONLY.

Specified by:

setLinearAttrsREADONLYFlagOnTargetAsset in interface AssetLocRelationRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

setLinearAttrsREADONLYFlagOnTargetAsset()

initFieldFlagsOnMbo

public void initFieldFlagsOnMbo(java.lang.String attrName)
                         throws MXException

set linear-related field flags

Overrides:

initFieldFlagsOnMbo in class Mbo

Throws:

MXException

isChangeByUserWhenSetFromLookup

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

Indicate whether the changeed by user flag should be set to the attribute when it is set along with other key field when the lookup attribute is being set on this Linear Mbo.

Overrides:

isChangeByUserWhenSetFromLookup in class Mbo

Parameters:

lookupAttrName - the attribute whose lookup is being called.

attributeName - the attribute that is not the lookup attribute.

Returns:

createSourceAssetFeatureRec

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

When a CI-Relationship is applied to Linear Asset and Asset Relationship has been identified as a referent , create assetfeature record(s). AssetLocRelation.SourceAssetNum to AssetFeature.AssetNum

Specified by:

createSourceAssetFeatureRec in interface AssetLocRelationRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

createSourceAssetFeatureRec()

createTargetAssetFeatureRec

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

When a CI-Relationship is applied to Linear Asset and Asset Relationship has been identified as a referent , create assetfeature record(s). AssetLocRelation.TargetAssetNum to AssetFeature.AssetNum

Specified by:

createTargetAssetFeatureRec in interface AssetLocRelationRemote

Throws:

MXException

java.rmi.RemoteException

See Also:

createTargetAssetFeatureRec()

recalAssetRelMesModify

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

Recalibration for Asset-Relationships. If the Asset-Relationships creates Asset-Features; using the 'Use As Reference?' box on the relationships details tab, Asset-Features for Source-Relationship and Target-Relationship are created. If an user updates the measures on Asset-Relationship, then corresponding Source-Asset-Features and Target-Asset-Features are updated accordingly.

Throws:

MXException

java.rmi.RemoteException

recalAssetRelFeatureMesModify

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

Recalibration for Asset-Relationships. If the Asset-Relationships creates Asset-Features; using the 'Use As Reference?' box on the relationships details tab, Asset-Features for Source-Relationship and Target-Relationship are created. If an user updates the measures on Asset-Relationship, then corresponding Source-Asset-Features and Target-Asset-Features are updated accordingly.

Throws:

MXException

java.rmi.RemoteException

validateRelationshipRules

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

Validates the relationship rules for Assets using the RELATIONRULEEXT rules

Specified by:

validateRelationshipRules in interface AssetLocRelationRemote

Throws:

MXException

java.rmi.RemoteException