Interface ServerPurposeManagerInterface

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void addServerPurpose​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, boolean infrastructureManagerIsHome, java.lang.String itAssetGUID, java.lang.String classificationName, java.util.Date effectiveFrom, java.util.Date effectiveTo, java.util.Map<java.lang.String,​java.lang.Object> classificationProperties)
      Add a Server Purpose classification to an IT asset.
      void clearServerPurpose​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String assetTypeName, java.lang.String assetGUID, java.lang.String classificationName, java.util.Date effectiveTime)
      Remove a server purpose classification.
      void updateServerPurpose​(java.lang.String userId, java.lang.String infrastructureManagerGUID, java.lang.String infrastructureManagerName, java.lang.String assetTypeName, java.lang.String assetGUID, java.lang.String classificationName, java.util.Date effectiveFrom, java.util.Date effectiveTo, boolean isMergeUpdate, java.util.Map<java.lang.String,​java.lang.Object> classificationProperties)
      Update the properties of a classification for an asset.
    • Method Detail

      • addServerPurpose

        void addServerPurpose​(java.lang.String userId,
                              java.lang.String infrastructureManagerGUID,
                              java.lang.String infrastructureManagerName,
                              boolean infrastructureManagerIsHome,
                              java.lang.String itAssetGUID,
                              java.lang.String classificationName,
                              java.util.Date effectiveFrom,
                              java.util.Date effectiveTo,
                              java.util.Map<java.lang.String,​java.lang.Object> classificationProperties)
                       throws InvalidParameterException,
                              UserNotAuthorizedException,
                              PropertyServerException
        Add a Server Purpose classification to an IT asset.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
        infrastructureManagerName - unique name of software server capability representing the infrastructure manager
        infrastructureManagerIsHome - ensure that only the infrastructure manager can update this asset
        itAssetGUID - unique identifier of the asset
        classificationName - name of the classification type
        effectiveFrom - when should relationship be effective - null means immediately
        effectiveTo - when should relationship no longer be effective - null means never
        classificationProperties - 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)
      • updateServerPurpose

        void updateServerPurpose​(java.lang.String userId,
                                 java.lang.String infrastructureManagerGUID,
                                 java.lang.String infrastructureManagerName,
                                 java.lang.String assetTypeName,
                                 java.lang.String assetGUID,
                                 java.lang.String classificationName,
                                 java.util.Date effectiveFrom,
                                 java.util.Date effectiveTo,
                                 boolean isMergeUpdate,
                                 java.util.Map<java.lang.String,​java.lang.Object> classificationProperties)
                          throws InvalidParameterException,
                                 UserNotAuthorizedException,
                                 PropertyServerException
        Update the properties of a classification for an asset.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
        infrastructureManagerName - unique name of software server capability representing the infrastructure manager
        assetTypeName - name of type for the asset
        assetGUID - unique identifier of the asset
        classificationName - name of the classification type
        effectiveFrom - when should relationship be effective - null means immediately
        effectiveTo - when should relationship no longer be effective - null means never
        isMergeUpdate - should the supplied properties be merged with existing properties (true) by replacing just the properties with matching names, or should the entire properties of the instance be replaced?
        classificationProperties - 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)
      • clearServerPurpose

        void clearServerPurpose​(java.lang.String userId,
                                java.lang.String infrastructureManagerGUID,
                                java.lang.String infrastructureManagerName,
                                java.lang.String assetTypeName,
                                java.lang.String assetGUID,
                                java.lang.String classificationName,
                                java.util.Date effectiveTime)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException
        Remove a server purpose classification.
        Parameters:
        userId - calling user
        infrastructureManagerGUID - unique identifier of software server capability representing the infrastructure manager
        infrastructureManagerName - unique name of software server capability representing the infrastructure manager
        assetTypeName - name of type for the asset
        assetGUID - unique identifier of the asset
        classificationName - name of the classification type
        effectiveTime - effective time of the classification 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)