ServiceAddressServiceRemote (Maximo API)

All Superinterfaces:

AppServiceRemote, java.rmi.Remote, ServiceRemote

All Known Implementing Classes:

ServiceAddressService
```
public interface ServiceAddressServiceRemote
extends AppServiceRemote
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`com.ibm.json.java.JSONObject`	`getLatLngFromAddressableMbo(MboRemote mboWithXY)` Based on a mbo with GIS data it gets the mbo WGS coordinates (lat/lng). With Bingmaps or Googlemaps providers the LATITUDEY and LONGITUDEX double attributes are already in WGS84. With Maximo Spatial maps this is not always true.
`java.util.List`	`getLatLngFromAutolocatableMbos(MboSetRemote mboSet)` Runs getLatLngFromAddressableMbo(mbo) for every mbo in the mboSet after retrieving the mboWithXY . from each mbo (by calling mbo.getAutoLocateObject()) The execution will split into threads because retrieving the x/y can be slow when coordinate system conversion and feature class fetching take place.
`SpatialMapConfServiceRemote`	`getSpatialMapConfService(UserInfo userInfo)`
`java.lang.String[]`	`getStreetOrderFormat(MboRemote mbo)` Returns an array with the field's order that is set in STREETORDERNUM maxvar
`boolean`	`hasServiceAddressData(MboRemote mbo)`
`boolean`	`isAddressDetailRequired(MboRemote mbo)` Returns true if the maxvar STRADDRDETAIL is set to "REQUIRED"
`boolean`	`isAddressMasterMaximo(MboRemote mbo)` Returns true if the maxvar ADDRMASTER is set to "MAXIMO"
`boolean`	`isCoordinatesLatLong(MboRemote mbo)` Returns true if the maxvar COORDINATE is set to "LATLONG"
`boolean`	`isCoordinatesLatLong(java.lang.String orgId)`
`boolean`	`isSAInfoEditable(MboRemote mbo)` Returns true if the maxvar SAEDITABLE is set to "1"
`boolean`	`isSAMessagePrompt(MboRemote mbo)` Returns true if the maxvar SAMSGPROMPT is set to "1"

Methods inherited from interface psdi.server.AppServiceRemote
checkSecurity, getCriteria, getCurrentState, getLiveObjCount, getMboSet, getName, getSchemaOwner, getSetForRelationship, getSetFromKeys, getStateCmdList, getStateList, getURL, verifyUser, verifyUser

Methods inherited from interface psdi.server.ServiceRemote
isAppService, isSingletonService, restart

- Method Detail
  - isSAInfoEditable
```
boolean isSAInfoEditable(MboRemote mbo)
                  throws java.rmi.RemoteException,
                         MXException
```
    Returns true if the maxvar SAEDITABLE is set to "1"
    
    Parameters:
    
    mbo - - Current mbo record to recover Org. values
    
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - isAddressDetailRequired
```
boolean isAddressDetailRequired(MboRemote mbo)
                         throws java.rmi.RemoteException,
                                MXException
```
    Returns true if the maxvar STRADDRDETAIL is set to "REQUIRED"
    
    Parameters:
    
    mbo - - Current mbo record to recover Org. values
    
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - isCoordinatesLatLong
```
boolean isCoordinatesLatLong(MboRemote mbo)
                      throws java.rmi.RemoteException,
                             MXException
```
    Returns true if the maxvar COORDINATE is set to "LATLONG"
    
    Parameters:
    
    mbo - - Current mbo record to recover Org. values
    
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - isAddressMasterMaximo
```
boolean isAddressMasterMaximo(MboRemote mbo)
                       throws java.rmi.RemoteException,
                              MXException
```
    Returns true if the maxvar ADDRMASTER is set to "MAXIMO"
    
    Parameters:
    
    mbo - - Current mbo record to recover Org. values
    
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - getStreetOrderFormat
```
java.lang.String[] getStreetOrderFormat(MboRemote mbo)
                                 throws java.rmi.RemoteException,
                                        MXException
```
    Returns an array with the field's order that is set in STREETORDERNUM maxvar
    
    Parameters:
    
    mbo - - Current mbo record to recover Org. values
    
    Returns:
    
    A String array with all field's name in correct order
    
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - isSAMessagePrompt
```
boolean isSAMessagePrompt(MboRemote mbo)
                   throws java.rmi.RemoteException,
                          MXException
```
    Returns true if the maxvar SAMSGPROMPT is set to "1"
    
    Parameters:
    
    mbo - - Current mbo record to recover Org. values
    
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - hasServiceAddressData
```
boolean hasServiceAddressData(MboRemote mbo)
                       throws MXException,
                              java.rmi.RemoteException
```
    Throws:
    
    MXException
    
    java.rmi.RemoteException
  - getLatLngFromAddressableMbo
```
com.ibm.json.java.JSONObject getLatLngFromAddressableMbo(MboRemote mboWithXY)
                                                  throws MXException,
                                                         java.rmi.RemoteException
```
    Based on a mbo with GIS data it gets the mbo WGS coordinates (lat/lng).
    With Bingmaps or Googlemaps providers the LATITUDEY and LONGITUDEX double attributes are already in WGS84.
    With Maximo Spatial maps this is not always true. The Map could use a different coordinate system, so it's
    necessary to convert to the WGS84 coordinate system. Also if Spatial map provider is being used, it is also
    needed to look for linked records. This method does convert the feature class to lat/lng coordinages.
    The JsonObject returned has 2 properties: {lat:DOUBLE, lng:DOUBLE}
    
    Parameters:
    
    mboWithXY - mbo that is the result of calling getAutoLocateObject in an AutoLocatable mbo
    
    Returns:
    
    {lat:DOUBLE, lng:DOUBLE}
    
    Throws:
    
    MXException
    
    java.io.IOException
    
    java.rmi.RemoteException
  - getLatLngFromAutolocatableMbos
```
java.util.List getLatLngFromAutolocatableMbos(MboSetRemote mboSet)
                                       throws MXException,
                                              java.rmi.RemoteException
```
    Runs getLatLngFromAddressableMbo(mbo) for every mbo in the mboSet after retrieving the mboWithXY .
    from each mbo (by calling mbo.getAutoLocateObject())
    The execution will split into threads because retrieving the x/y can be slow
    when coordinate system conversion and feature class fetching take place.
    
    Parameters:
    
    mboSet - mboSet containing the mbos for which the x/y will be retrieved
    
    Returns:
    
    List<{lat:DOUBLE, lng:DOUBLE}>
    
    Throws:
    
    MXException
    
    java.io.IOException
    
    java.rmi.RemoteException
  - getSpatialMapConfService
```
SpatialMapConfServiceRemote getSpatialMapConfService(UserInfo userInfo)
                                              throws java.rmi.RemoteException,
                                                     MXException
```
    Throws:
    
    java.rmi.RemoteException
    
    MXException
  - isCoordinatesLatLong
```
boolean isCoordinatesLatLong(java.lang.String orgId)
                      throws java.rmi.RemoteException,
                             MXException
```
    Throws:
    
    java.rmi.RemoteException
    
    MXException

Methods inherited from interface psdi.server.AppServiceRemote

Methods inherited from interface psdi.server.ServiceRemote

isSAInfoEditable

isAddressDetailRequired

isCoordinatesLatLong

isAddressMasterMaximo

getStreetOrderFormat

isSAMessagePrompt

hasServiceAddressData

getLatLngFromAddressableMbo

getLatLngFromAutolocatableMbos

getSpatialMapConfService

isCoordinatesLatLong