Package org.odpi.openmetadata.accessservices.itinfrastructure.api

Interface ServerPurposeManagerInterface

public interface ServerPurposeManagerInterface

ServerPurposeManagerInterface manages the server purpose classifications on the IT Infrastructure assets.

Method Summary

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

Method Details

addServerPurpose

void addServerPurpose(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 boolean infrastructureManagerIsHome,
 String itAssetGUID,
 String classificationName,
 Date effectiveFrom,
 Date effectiveTo,
 Map<String,Object> classificationProperties)
               throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

updateServerPurpose

void updateServerPurpose(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String assetTypeName,
 String assetGUID,
 String classificationName,
 Date effectiveFrom,
 Date effectiveTo,
 boolean isMergeUpdate,
 Map<String,Object> classificationProperties)
                  throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

clearServerPurpose

void clearServerPurpose(String userId,
 String infrastructureManagerGUID,
 String infrastructureManagerName,
 String assetTypeName,
 String assetGUID,
 String classificationName,
 Date effectiveTime)
                 throws org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException,
org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException,
org.odpi.openmetadata.frameworks.connectors.ffdc.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:

org.odpi.openmetadata.frameworks.connectors.ffdc.InvalidParameterException - one of the parameters is invalid

org.odpi.openmetadata.frameworks.connectors.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request

org.odpi.openmetadata.frameworks.connectors.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)