com.ibm.tivoli.maximo.srvad.app

Class ServiceAddress

java.lang.Object

psdi.mbo.Mbo

com.ibm.tivoli.maximo.srvad.app.ServiceAddress

All Implemented Interfaces:

AutoLocatable, GISable, AddressableMbo, ServiceAddressRemote, java.rmi.Remote, MboConstants, MboRemote, MaxRemoteProxy

public class ServiceAddress
extends Mbo
implements ServiceAddressRemote

ServiceAddress MBO code for FSM

Field Summary

Fields inherited from class psdi.mbo.Mbo

MULTILANGCOPY, phantomList, phantomQueue

Fields inherited from interface com.ibm.tivoli.maximo.srvad.app.common.AddressableMbo

ADDRESSABLE_SERVICEADDRESS_REL, NPADDRESSCODE_ATTRNAME, NPADDRESSDESC_ATTRNAME, NPADDRESSLONGDESC_ATTRNAME, SERVICEADDRESS_NATIVE_RELATIONSHIPNAME

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

Method Summary

Modifier and Type	Method and Description
void	add() During add we must set the owner name if any.
void	appValidate() LatitudeY and LongitudeX must be either both filled either none.
void	delete(long accessModifier) Mark the object to be deleted depending on the access modifier.
MboRemote	duplicate() Creates a duplicate Service Address.
java.lang.String	getAddressString() Return a string with the address of the current entitty.
java.lang.String	getAutolocateGeometry()
MboRemote	getAutoLocateObject() Returns an autolocate object instance if present.
MboRemote	getAutoLocateObject(AutoLocatable parent) Returns an autolocate object instance if present.
MboSetRemote	getChildren() Returns the children Service Addresses ServiceAddressSetRemote
java.lang.Double	getLatitudeY() Return a double value with the the Latitude (or Y) coordinate of the current entitty.
java.lang.Double	getLongitudeX() Return a double value with the the Longitude (or X) coordinate of the current entitty.
java.lang.String	getOrgSiteForMaxvar(java.lang.String maxvarName) Returns org or site for getting maxvar
MboRemote	getParent() Returns the parent Service Address ServiceAddressRemote.
ServiceAddressRemote	getServiceAddress()
java.lang.Boolean	hasCoords() Check if this autolocatable object has coordinates filled (LAT,LONG)
boolean	hasServiceAddress()
void	init() Called by the framework when the Mbo has been constructed and the MboValues have been initialized.
boolean	isGISDataReadonly() Indicate if the current GIS entity is editable or not.
java.lang.Boolean	isParent() A SA is parent if it's OBJECTNAME is null, that means it's not customized.
boolean	makeEditableOnSAInfoEdit(MboRemote checker) Check if SAEDITABLE maxvar is enabled.
void	makeSAParent() Modify SA attributes to make it a main SA (parent)
protected void	save() When saving a value in a SA that is related to another object (like a Location) we need to check if this change is being done in an original SA or a customized SA. If it's an original we must clone the original SA into a new customized SA. Also, if a customized SA gets modified, and it wasn't done by SA's owner, this SA will be treated as an original SA, and same rules for originals will be applied to it.
void	saveGISData(java.lang.String address, java.lang.String lat, java.lang.String lng) Implement the logic to save the GIS Data
protected boolean	skipCopyField(MboValueInfo mvi) This method 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.
void	updateGeometry()

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, deleteDoclinks, determineRequiredFieldsFromERM, 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, 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.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, 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

ServiceAddress

public ServiceAddress(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

skipCopyField

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

This method 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. If this field does not need to be copied return true.

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:

java.rmi.RemoteException

MXException

duplicate

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

Creates a duplicate Service Address.

Specified by:

duplicate in interface MboRemote

Overrides:

duplicate in class Mbo

Returns:

the newly duplicated Service Address

Throws:

MXException

java.rmi.RemoteException

getParent

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

Description copied from interface: ServiceAddressRemote

Returns the parent Service Address ServiceAddressRemote.

Specified by:

getParent in interface ServiceAddressRemote

Returns:

Throws:

MXException

java.rmi.RemoteException

getChildren

public MboSetRemote getChildren()
                         throws MXException,
                                java.rmi.RemoteException

Description copied from interface: ServiceAddressRemote

Returns the children Service Addresses ServiceAddressSetRemote

Specified by:

getChildren in interface ServiceAddressRemote

Returns:

Throws:

MXException

java.rmi.RemoteException

appValidate

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

LatitudeY and LongitudeX must be either both filled either none.

Overrides:

appValidate in class Mbo

Throws:

MXException

java.rmi.RemoteException

save

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

When saving a value in a SA that is related to another object (like a Location) we need to check if this change is being done in an original SA or a customized SA.
If it's an original we must clone the original SA into a new customized SA.
Also, if a customized SA gets modified, and it wasn't done by SA's owner, this SA will be treated as an original SA, and same rules for originals will be applied to it. If LongitudeX or LatitudeY is modified, delete the records from SKDOriginDestMatrix where the source is GOOGLE or BING

Overrides:

save 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)

add

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

During add we must set the owner name if any. (when ading from another app than SA)

Specified by:

add in interface MboRemote

Overrides:

add in class Mbo

Throws:

MXException

java.rmi.RemoteException

isParent

public java.lang.Boolean isParent()
                           throws MXException,
                                  java.rmi.RemoteException

A SA is parent if it's OBJECTNAME is null, that means it's not customized.

Specified by:

isParent in interface ServiceAddressRemote

Returns:

Throws:

MXException

java.rmi.RemoteException

makeSAParent

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

Description copied from interface: ServiceAddressRemote

Modify SA attributes to make it a main SA (parent)

Specified by:

makeSAParent in interface ServiceAddressRemote

Throws:

MXException

java.rmi.RemoteException

getServiceAddress

public ServiceAddressRemote getServiceAddress()
                                       throws MXException,
                                              java.rmi.RemoteException

Specified by:

getServiceAddress in interface AddressableMbo

Throws:

MXException

java.rmi.RemoteException

saveGISData

public void saveGISData(java.lang.String address,
                        java.lang.String lat,
                        java.lang.String lng)
                 throws MXException,
                        java.rmi.RemoteException

Description copied from interface: GISable

Implement the logic to save the GIS Data

Specified by:

saveGISData in interface GISable

Throws:

MXException

java.rmi.RemoteException

makeEditableOnSAInfoEdit

public boolean makeEditableOnSAInfoEdit(MboRemote checker)
                                 throws java.rmi.RemoteException,
                                        MXException

Description copied from interface: ServiceAddressRemote

Check if SAEDITABLE maxvar is enabled. If no the service address record has its attributes open to be edited.

Specified by:

makeEditableOnSAInfoEdit in interface ServiceAddressRemote

Returns:

the SAEDITABLE maxvar state: enabled/disabled.

Throws:

java.rmi.RemoteException

MXException

See Also:

com.ibm.tivoli.maximo.srvad.app.ServiceAddressRemote#makeEditableOnLochierarchy(psdi.mbo.MboRemote)

getOrgSiteForMaxvar

public java.lang.String getOrgSiteForMaxvar(java.lang.String maxvarName)
                                     throws MXException,
                                            java.rmi.RemoteException

Description copied from class: Mbo

Returns org or site for getting maxvar

Specified by:

getOrgSiteForMaxvar in interface MboRemote

Overrides:

getOrgSiteForMaxvar in class Mbo

Returns:

Throws:

MXException

java.rmi.RemoteException

getLatitudeY

public java.lang.Double getLatitudeY()
                              throws MXException,
                                     java.rmi.RemoteException

Description copied from interface: GISable

Return a double value with the the Latitude (or Y) coordinate of the current entitty.

Specified by:

getLatitudeY in interface GISable

Returns:

Double or null

Throws:

MXException

java.rmi.RemoteException

getLongitudeX

public java.lang.Double getLongitudeX()
                               throws MXException,
                                      java.rmi.RemoteException

Description copied from interface: GISable

Return a double value with the the Longitude (or X) coordinate of the current entitty.

Specified by:

getLongitudeX in interface GISable

Returns:

Double or null

Throws:

MXException

java.rmi.RemoteException

getAddressString

public java.lang.String getAddressString()
                                  throws MXException,
                                         java.rmi.RemoteException

Description copied from interface: GISable

Return a string with the address of the current entitty.

Specified by:

getAddressString in interface GISable

Returns:

Double or null

Throws:

MXException

java.rmi.RemoteException

hasServiceAddress

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

Specified by:

hasServiceAddress in interface AddressableMbo

Throws:

MXException

java.rmi.RemoteException

isGISDataReadonly

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

Description copied from interface: GISable

Indicate if the current GIS entity is editable or not. Usefull when the coordinates are populated using an external system.

Specified by:

isGISDataReadonly in interface GISable

Returns:

Throws:

MXException

java.rmi.RemoteException

getAutoLocateObject

public MboRemote getAutoLocateObject(AutoLocatable parent)
                              throws MXException,
                                     java.rmi.RemoteException

Description copied from interface: AutoLocatable

Returns an autolocate object instance if present.

Specified by:

getAutoLocateObject in interface AutoLocatable

Returns:

the autolocate object instance

Throws:

MXException - the mX exception

java.rmi.RemoteException - the remote exception

hasCoords

public java.lang.Boolean hasCoords()
                            throws MXException,
                                   java.rmi.RemoteException

Description copied from interface: GISable

Check if this autolocatable object has coordinates filled (LAT,LONG)

Specified by:

hasCoords in interface GISable

Returns:

the boolean

Throws:

MXException - the mX exception

java.rmi.RemoteException - the remote exception

getAutoLocateObject

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

Description copied from interface: AutoLocatable

Returns an autolocate object instance if present.

Specified by:

getAutoLocateObject in interface AutoLocatable

Returns:

the auto locate object

Throws:

MXException - the mX exception

java.rmi.RemoteException - the remote exception

getAutolocateGeometry

public java.lang.String getAutolocateGeometry()
                                       throws java.rmi.RemoteException,
                                              MXException

Specified by:

getAutolocateGeometry in interface AutoLocatable

Throws:

java.rmi.RemoteException

MXException

updateGeometry

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

Throws:

java.rmi.RemoteException

MXException