Class LocationManager

  • All Implemented Interfaces:
    ManageLocations

    public class LocationManager
    extends java.lang.Object
    implements ManageLocations
    LocationManager provides the API operations to create and maintain location definitions.
    • Constructor Summary

      Constructors 
      Constructor Description
      LocationManager​(java.lang.String serverName, java.lang.String serverPlatformURLRoot)
      Create a new client with no authentication embedded in the HTTP request.
      LocationManager​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password)
      Create a new client that passes userId and password in each HTTP request.
      LocationManager​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, java.lang.String userId, java.lang.String password, AuditLog auditLog)
      Create a new client that passes userId and password in each HTTP request.
      LocationManager​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, DigitalArchitectureRESTClient restClient, int maxPageSize, AuditLog auditLog)
      Create a new client that is going to be used in an OMAG Server (view service or integration service typically).
      LocationManager​(java.lang.String serverName, java.lang.String serverPlatformURLRoot, AuditLog auditLog)
      Create a new client with no authentication embedded in the HTTP request and an audit log.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void clearAdjacentLocation​(java.lang.String userId, java.lang.String locationOneGUID, java.lang.String locationTwoGUID)
      Remove a peer-to-peer relationship between two locations.
      void clearLocationAsDigital​(java.lang.String userId, java.lang.String locationGUID)
      Remove the digital/cyber location designation from the location.
      void clearLocationAsFixedPhysical​(java.lang.String userId, java.lang.String locationGUID)
      Remove the fixed physical location designation from the location.
      void clearLocationAsSecure​(java.lang.String userId, java.lang.String locationGUID)
      Remove the secure location designation from the location.
      void clearNestedLocation​(java.lang.String userId, java.lang.String parentLocationGUID, java.lang.String childLocationGUID)
      Remove a parent-child relationship between two locations.
      java.lang.String createLocation​(java.lang.String userId, LocationProperties locationProperties)
      Create a new metadata element to represent a location.
      java.lang.String createLocationFromTemplate​(java.lang.String userId, java.lang.String templateGUID, TemplateProperties templateProperties)
      Create a new metadata element to represent a location using an existing metadata element as a template.
      java.util.List<LocationElement> findLocations​(java.lang.String userId, java.lang.String searchString, int startFrom, int pageSize)
      Retrieve the list of location metadata elements that contain the search string.
      LocationElement getLocationByGUID​(java.lang.String userId, java.lang.String locationGUID)
      Retrieve the location metadata element with the supplied unique identifier.
      java.util.List<LocationElement> getLocationsByName​(java.lang.String userId, java.lang.String name, int startFrom, int pageSize)
      Retrieve the list of location metadata elements with a matching qualified or display name.
      void removeLocation​(java.lang.String userId, java.lang.String locationGUID)
      Remove the metadata element representing a location.
      void setLocationAsDigital​(java.lang.String userId, java.lang.String locationGUID, java.lang.String networkAddress)
      Classify the location to indicate that it represents a digital/cyber location.
      void setLocationAsFixedPhysical​(java.lang.String userId, java.lang.String locationGUID, java.lang.String coordinates, java.lang.String mapProjection, java.lang.String postalAddress, java.lang.String timeZone)
      Classify the location to indicate that it represents a fixed physical location.
      void setLocationAsSecure​(java.lang.String userId, java.lang.String locationGUID, java.lang.String description, java.lang.String level)
      Classify the location to indicate that it represents a secure location.
      void setupAdjacentLocation​(java.lang.String userId, java.lang.String locationOneGUID, java.lang.String locationTwoGUID)
      Create a peer-to-peer relationship between two locations.
      void setupNestedLocation​(java.lang.String userId, java.lang.String parentLocationGUID, java.lang.String childLocationGUID)
      Create a parent-child relationship between two locations.
      void updateLocation​(java.lang.String userId, boolean isMergeUpdate, java.lang.String locationGUID, LocationProperties locationProperties)
      Update the metadata element representing a location.
      • Methods inherited from class java.lang.Object

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