Interface LocationManagementInterface

  • All Known Implementing Classes:
    LocationManagement

    public interface LocationManagementInterface
    LocationManagementInterface defines the client side interface for the Community Profile OMAS that is relevant for managing definitions of locations.
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void clearAdjacentLocation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String locationOneGUID, java.lang.String locationTwoGUID)
      Remove a peer-to-peer relationship between two locations.
      void clearAssetLocation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String assetGUID, java.lang.String locationGUID)
      Remove an asset location relationship between an asset and a location.
      void clearLocationAsDigital​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String locationGUID)
      Remove the digital/cyber location designation from the location.
      void clearLocationAsFixedPhysical​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String locationGUID)
      Remove the fixed physical location designation from the location.
      void clearLocationAsSecure​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String locationGUID)
      Remove the secure location designation from the location.
      void clearNestedLocation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String parentLocationGUID, java.lang.String childLocationGUID)
      Remove a parent-child relationship between two locations.
      void clearProfileLocation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String actorProfileGUID, java.lang.String locationGUID)
      Remove a profile location relationship between an actor profile and a location.
      java.lang.String createLocation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, LocationProperties locationProperties)
      Create a new metadata element to represent a location.
      java.lang.String createLocationFromTemplate​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, 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.
      java.util.List<LocationElement> getAdjacentLocations​(java.lang.String userId, java.lang.String locationGUID, int startFrom, int pageSize)
      Retrieve the list of adjacent location metadata elements linked to locationGUID.
      java.util.List<LocationElement> getGroupingLocations​(java.lang.String userId, java.lang.String locationGUID, int startFrom, int pageSize)
      Retrieve the list of location metadata elements that has the location identifier with locationGUID nested inside it.
      java.util.List<LocationElement> getKnownLocationsForAsset​(java.lang.String userId, java.lang.String assetGUID, int startFrom, int pageSize)
      Retrieve the list of location metadata elements linked to assetGUID.
      LocationElement getLocationByGUID​(java.lang.String userId, java.lang.String locationGUID)
      Retrieve the location metadata element with the supplied unique identifier.
      java.util.List<LocationElement> getLocations​(java.lang.String userId, int startFrom, int pageSize)
      Retrieve the list of location metadata elements.
      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 name, identifier or display name.
      java.util.List<LocationElement> getLocationsByProfile​(java.lang.String userId, java.lang.String actorProfileGUID, int startFrom, int pageSize)
      Retrieve the list of location metadata elements linked to actorProfileGUID.
      java.util.List<LocationElement> getNestedLocations​(java.lang.String userId, java.lang.String locationGUID, int startFrom, int pageSize)
      Retrieve the list of nested location metadata elements linked to locationGUID.
      void removeLocation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String locationGUID)
      Remove the metadata element representing a location.
      void setLocationAsDigital​(java.lang.String userId, java.lang.String locationGUID, java.lang.String externalSourceGUID, java.lang.String externalSourceName, DigitalLocationProperties properties)
      Classify the location to indicate that it represents a digital/cyber location.
      void setLocationAsFixedPhysical​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String locationGUID, FixedLocationProperties properties)
      Classify the location to indicate that it represents a fixed physical location.
      void setLocationAsSecure​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String locationGUID, SecureLocationProperties properties)
      Classify the location to indicate that it represents a secure location.
      void setupAdjacentLocation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String locationOneGUID, java.lang.String locationTwoGUID, AdjacentLocationProperties properties)
      Create a peer-to-peer relationship between two locations.
      void setupAssetLocation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String assetGUID, java.lang.String locationGUID, AssetLocationProperties properties)
      Create an asset location relationship between an asset and a location.
      void setupNestedLocation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String parentLocationGUID, java.lang.String childLocationGUID, NestedLocationProperties properties)
      Create a parent-child relationship between two locations.
      void setupProfileLocation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String actorProfileGUID, java.lang.String locationGUID, ProfileLocationProperties properties)
      Create a profile location relationship between an actor profile and a location.
      void updateLocation​(java.lang.String userId, java.lang.String externalSourceGUID, java.lang.String externalSourceName, java.lang.String locationGUID, boolean isMergeUpdate, LocationProperties locationProperties)
      Update the metadata element representing a location.
    • Method Detail

      • createLocation

        java.lang.String createLocation​(java.lang.String userId,
                                        java.lang.String externalSourceGUID,
                                        java.lang.String externalSourceName,
                                        LocationProperties locationProperties)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Create a new metadata element to represent a location. Classifications can be added later to define the type of location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        locationProperties - properties to store
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • createLocationFromTemplate

        java.lang.String createLocationFromTemplate​(java.lang.String userId,
                                                    java.lang.String externalSourceGUID,
                                                    java.lang.String externalSourceName,
                                                    java.lang.String templateGUID,
                                                    TemplateProperties templateProperties)
                                             throws InvalidParameterException,
                                                    UserNotAuthorizedException,
                                                    PropertyServerException
        Create a new metadata element to represent a location using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        templateGUID - unique identifier of the metadata element to copy
        templateProperties - properties that override the template
        Returns:
        unique identifier of the new metadata element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • updateLocation

        void updateLocation​(java.lang.String userId,
                            java.lang.String externalSourceGUID,
                            java.lang.String externalSourceName,
                            java.lang.String locationGUID,
                            boolean isMergeUpdate,
                            LocationProperties locationProperties)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
        Update the metadata element representing a location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        locationGUID - unique identifier of the metadata element to update
        isMergeUpdate - should the new properties be merged with existing properties (true) or completely replace them (false)?
        locationProperties - new properties for this element
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setLocationAsFixedPhysical

        void setLocationAsFixedPhysical​(java.lang.String userId,
                                        java.lang.String externalSourceGUID,
                                        java.lang.String externalSourceName,
                                        java.lang.String locationGUID,
                                        FixedLocationProperties properties)
                                 throws InvalidParameterException,
                                        UserNotAuthorizedException,
                                        PropertyServerException
        Classify the location to indicate that it represents a fixed physical location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        locationGUID - unique identifier of the metadata element to classify
        properties - time zone and position of the location
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearLocationAsFixedPhysical

        void clearLocationAsFixedPhysical​(java.lang.String userId,
                                          java.lang.String externalSourceGUID,
                                          java.lang.String externalSourceName,
                                          java.lang.String locationGUID)
                                   throws InvalidParameterException,
                                          UserNotAuthorizedException,
                                          PropertyServerException
        Remove the fixed physical location designation from the location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        locationGUID - unique identifier of the metadata element to unclassify
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setLocationAsSecure

        void setLocationAsSecure​(java.lang.String userId,
                                 java.lang.String externalSourceGUID,
                                 java.lang.String externalSourceName,
                                 java.lang.String locationGUID,
                                 SecureLocationProperties properties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
        Classify the location to indicate that it represents a secure location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        locationGUID - unique identifier of the metadata element to classify
        properties - properties of security at the site
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearLocationAsSecure

        void clearLocationAsSecure​(java.lang.String userId,
                                   java.lang.String externalSourceGUID,
                                   java.lang.String externalSourceName,
                                   java.lang.String locationGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Remove the secure location designation from the location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        locationGUID - unique identifier of the metadata element to unclassify
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setLocationAsDigital

        void setLocationAsDigital​(java.lang.String userId,
                                  java.lang.String locationGUID,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  DigitalLocationProperties properties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Classify the location to indicate that it represents a digital/cyber location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        locationGUID - unique identifier of the metadata element to classify
        properties - address of the location
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearLocationAsDigital

        void clearLocationAsDigital​(java.lang.String userId,
                                    java.lang.String externalSourceGUID,
                                    java.lang.String externalSourceName,
                                    java.lang.String locationGUID)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException
        Remove the digital/cyber location designation from the location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        locationGUID - unique identifier of the metadata element to unclassify
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupNestedLocation

        void setupNestedLocation​(java.lang.String userId,
                                 java.lang.String externalSourceGUID,
                                 java.lang.String externalSourceName,
                                 java.lang.String parentLocationGUID,
                                 java.lang.String childLocationGUID,
                                 NestedLocationProperties properties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
        Create a parent-child relationship between two locations.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        parentLocationGUID - unique identifier of the location that is the broader location
        childLocationGUID - unique identifier of the location that is the smaller, nested location
        properties - relationship properties
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearNestedLocation

        void clearNestedLocation​(java.lang.String userId,
                                 java.lang.String externalSourceGUID,
                                 java.lang.String externalSourceName,
                                 java.lang.String parentLocationGUID,
                                 java.lang.String childLocationGUID)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
        Remove a parent-child relationship between two locations.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        parentLocationGUID - unique identifier of the location that is the broader location
        childLocationGUID - unique identifier of the location that is the smaller, nested location
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupAdjacentLocation

        void setupAdjacentLocation​(java.lang.String userId,
                                   java.lang.String externalSourceGUID,
                                   java.lang.String externalSourceName,
                                   java.lang.String locationOneGUID,
                                   java.lang.String locationTwoGUID,
                                   AdjacentLocationProperties properties)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Create a peer-to-peer relationship between two locations.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        locationOneGUID - unique identifier of the first location
        locationTwoGUID - unique identifier of the second location
        properties - relationship properties
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearAdjacentLocation

        void clearAdjacentLocation​(java.lang.String userId,
                                   java.lang.String externalSourceGUID,
                                   java.lang.String externalSourceName,
                                   java.lang.String locationOneGUID,
                                   java.lang.String locationTwoGUID)
                            throws InvalidParameterException,
                                   UserNotAuthorizedException,
                                   PropertyServerException
        Remove a peer-to-peer relationship between two locations.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        locationOneGUID - unique identifier of the first location
        locationTwoGUID - unique identifier of the second location
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupProfileLocation

        void setupProfileLocation​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String actorProfileGUID,
                                  java.lang.String locationGUID,
                                  ProfileLocationProperties properties)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Create a profile location relationship between an actor profile and a location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        actorProfileGUID - unique identifier of the actor profile
        locationGUID - unique identifier of the location
        properties - type of association with the location
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearProfileLocation

        void clearProfileLocation​(java.lang.String userId,
                                  java.lang.String externalSourceGUID,
                                  java.lang.String externalSourceName,
                                  java.lang.String actorProfileGUID,
                                  java.lang.String locationGUID)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException
        Remove a profile location relationship between an actor profile and a location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        actorProfileGUID - unique identifier of the actor profile
        locationGUID - unique identifier of the location
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • setupAssetLocation

        void setupAssetLocation​(java.lang.String userId,
                                java.lang.String externalSourceGUID,
                                java.lang.String externalSourceName,
                                java.lang.String assetGUID,
                                java.lang.String locationGUID,
                                AssetLocationProperties properties)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
        Create an asset location relationship between an asset and a location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        assetGUID - unique identifier of the actor profile
        locationGUID - unique identifier of the location
        properties - type of association with the location
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • clearAssetLocation

        void clearAssetLocation​(java.lang.String userId,
                                java.lang.String externalSourceGUID,
                                java.lang.String externalSourceName,
                                java.lang.String assetGUID,
                                java.lang.String locationGUID)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
        Remove an asset location relationship between an asset and a location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        assetGUID - unique identifier of the asset
        locationGUID - unique identifier of the location
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • removeLocation

        void removeLocation​(java.lang.String userId,
                            java.lang.String externalSourceGUID,
                            java.lang.String externalSourceName,
                            java.lang.String locationGUID)
                     throws InvalidParameterException,
                            UserNotAuthorizedException,
                            PropertyServerException
        Remove the metadata element representing a location.
        Parameters:
        userId - calling user
        externalSourceGUID - unique identifier of software capability representing the caller
        externalSourceName - unique name of software capability representing the caller
        locationGUID - unique identifier of the metadata element to remove
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)
      • getLocationsByName

        java.util.List<LocationElement> getLocationsByName​(java.lang.String userId,
                                                           java.lang.String name,
                                                           int startFrom,
                                                           int pageSize)
                                                    throws InvalidParameterException,
                                                           UserNotAuthorizedException,
                                                           PropertyServerException
        Retrieve the list of location metadata elements with a matching qualified name, identifier or display name. There are no wildcards supported on this request.
        Parameters:
        userId - calling user
        name - name to search for
        startFrom - paging start point
        pageSize - maximum results that can be returned
        Returns:
        list of matching metadata elements
        Throws:
        InvalidParameterException - one of the parameters is invalid
        UserNotAuthorizedException - the user is not authorized to issue this request
        PropertyServerException - there is a problem reported in the open metadata server(s)