Package org.odpi.openmetadata.commonservices.generichandlers

Class CommentBuilder

java.lang.Object

org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

org.odpi.openmetadata.commonservices.generichandlers.CommentBuilder

public class CommentBuilder
extends ReferenceableBuilder

CommentBuilder is able to build the properties for a Comment entity.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

qualifiedName

Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

errorHandler, existingClassifications, extendedProperties, instanceStatus, newClassifications, repositoryHelper, serverName, serviceName, templateProperties, typeGUID, typeName

Constructor Summary

Constructors

Constructor	Description
CommentBuilder(String qualifiedName, int commentType, String commentText, boolean isPublic, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)	Constructor.

Method Summary

Modifier and Type	Method	Description
InstanceProperties	getInstanceProperties(String methodName)	Return the entity properties in an InstanceProperties object.
InstanceProperties	getRelationshipInstanceProperties(String methodName)	Return the relationship properties in an InstanceProperties object.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableBuilder

getQualifiedName, setMemento, setOwnershipClassification, setSecurityTags, setTemplate

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericBuilder

getEntityClassificationProperties, getEntityClassifications, getExistingEntityClassificationHeader, getInstanceProperties, getInstanceStatus, getTypeGUID, getTypeName, setAnchors, setClassification, setEffectivityDates, setEffectivityDates, setLatestChange, setTemplateClassifications, updateInstanceProperties

Methods inherited from class java.lang.Object

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

Constructor Detail

CommentBuilder

public CommentBuilder(String qualifiedName,
                      int commentType,
                      String commentText,
                      boolean isPublic,
                      OMRSRepositoryHelper repositoryHelper,
                      String serviceName,
                      String serverName)

Constructor.

Parameters:

qualifiedName - unique name (qualifiedName) for the comment

commentType - ordinal of comment enum.

commentText - String - the text of the comment.

isPublic - should this be visible to all or private to the caller

repositoryHelper - helper methods

serviceName - name of this OMAS

serverName - name of local server

Method Detail

getRelationshipInstanceProperties

public InstanceProperties getRelationshipInstanceProperties(String methodName)

Return the relationship properties in an InstanceProperties object.

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object

getInstanceProperties

public InstanceProperties getInstanceProperties(String methodName)
                                         throws InvalidParameterException

Return the entity properties in an InstanceProperties object.

Overrides:

getInstanceProperties in class ReferenceableBuilder

Parameters:

methodName - name of the calling method

Returns:

InstanceProperties object

Throws:

InvalidParameterException - there is a problem with the properties