java.lang.Object
- org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.RootBuilder
- - org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.ReferenceableBuilder

Direct Known Subclasses:

SchemaTypeBuilder
```
public class ReferenceableBuilder
extends RootBuilder
```
ReferenceableBuilder creates Open Metadata Repository Services (OMRS) objects based on the bean properties supplied in the constructor.

Field Summary

Fields
Modifier and Type	Field	Description
`protected Map<String,String>`	`additionalProperties`
`protected Map<String,Object>`	`extendedProperties`
`protected LatestChange`	`latestChange`
`protected String`	`qualifiedName`
`protected String`	`typeId`
`protected String`	`typeName`

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.RootBuilder
classifications, errorHandler, repositoryHelper, serverName, serviceName

Constructor Summary

Constructors
Modifier	Constructor	Description
`protected`	`ReferenceableBuilder(String qualifiedName, String typeName, String typeId, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)`	Constructor for simple creates.
`protected`	`ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeName, String typeId, Map<String,Object> extendedProperties, String actionDescription, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)`	Constructor for updates.
`protected`	`ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeId, String typeName, Map<String,Object> extendedProperties, LatestChange latestChange, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)`	Constructor for updates.
`protected`	`ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeName, String typeId, Map<String,Object> extendedProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)`	Constructor for updates.
`protected`	`ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, String typeId, String typeName, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)`	Constructor for updates.
`protected`	`ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, Map<String,Object> extendedProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)`	Deprecated.
`protected`	`ReferenceableBuilder(String qualifiedName, Map<String,String> additionalProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)`	Constructor for updates.
`protected`	`ReferenceableBuilder(String qualifiedName, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)`	Constructor for simple creates.
	`ReferenceableBuilder(Referenceable beanProperties, OMRSRepositoryHelper repositoryHelper, String serviceName, String serverName)`	Constructor for classifications.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`List<Classification>`	`getEntityClassifications(String userId, String methodName)`	Return a list of entity classifications that can be stored in the metadata repository.
`InstanceProperties`	`getInstanceProperties(String methodName)`	Return the supplied bean properties in an InstanceProperties object.
`InstanceProperties`	`getNameInstanceProperties(String methodName)`	Return the supplied bean properties that represent a name in an InstanceProperties object for search.
`InstanceProperties`	`getQualifiedNameInstanceProperties(String methodName)`	Return the supplied bean properties that represent a name in an InstanceProperties object for search.
`InstanceProperties`	`getSearchInstanceProperties(String methodName)`	Return the supplied bean properties that represent a name in an InstanceProperties object.
`String`	`getTypeId()`
`String`	`getTypeName()`

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.RootBuilder
getEntityClassifications, setClassifications

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

qualifiedName
```
protected String qualifiedName
```

typeId
```
protected String typeId
```

typeName
```
protected String typeName
```

additionalProperties

protected Map<String,String> additionalProperties

extendedProperties

protected Map<String,Object> extendedProperties

latestChange
```
protected LatestChange latestChange
```

Constructor Detail

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for simple creates.

Parameters:: qualifiedName - unique name; repositoryHelper - helper methods; serviceName - name of this OMAS; serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               String typeName,
                               String typeId,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for simple creates.

Parameters:: qualifiedName - unique name; typeName - type name to use for the entity; typeId - type GUID to use for the entity; repositoryHelper - helper methods; serviceName - name of this OMAS; serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               Map<String,String> additionalProperties,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for updates.

Parameters:: qualifiedName - unique name; additionalProperties - additional properties; repositoryHelper - helper methods; serviceName - name of this OMAS; serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               Map<String,String> additionalProperties,
                               String typeId,
                               String typeName,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for updates.

Parameters:: qualifiedName - unique name; additionalProperties - additional properties; typeId - type GUID to use for the entity; typeName - type name to use for the entity; repositoryHelper - helper methods; serviceName - name of this OMAS; serverName - name of local server

ReferenceableBuilder

@Deprecated
protected ReferenceableBuilder(String qualifiedName,
                               Map<String,String> additionalProperties,
                               Map<String,Object> extendedProperties,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Deprecated.

Constructor for updates.

Parameters:: qualifiedName - unique name; additionalProperties - additional properties; extendedProperties - properties from the subtype.; repositoryHelper - helper methods; serviceName - name of this OMAS; serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               Map<String,String> additionalProperties,
                               String typeId,
                               String typeName,
                               Map<String,Object> extendedProperties,
                               LatestChange latestChange,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for updates.

Parameters:: qualifiedName - unique name; additionalProperties - additional properties; typeId - type GUID to use for the entity; typeName - type name to use for the entity; extendedProperties - properties from the subtype.; latestChange - description of the last change to the asset.; repositoryHelper - helper methods; serviceName - name of this OMAS; serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               Map<String,String> additionalProperties,
                               String typeName,
                               String typeId,
                               Map<String,Object> extendedProperties,
                               String actionDescription,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for updates.

Parameters:: qualifiedName - unique name; additionalProperties - additional properties; typeName - type name to use for the entity; typeId - type GUID to use for the entity; extendedProperties - properties from the subtype.; actionDescription - description of the last change to the asset.; repositoryHelper - helper methods; serviceName - name of this OMAS; serverName - name of local server

ReferenceableBuilder

protected ReferenceableBuilder(String qualifiedName,
                               Map<String,String> additionalProperties,
                               String typeName,
                               String typeId,
                               Map<String,Object> extendedProperties,
                               OMRSRepositoryHelper repositoryHelper,
                               String serviceName,
                               String serverName)

Constructor for updates.

Parameters:: qualifiedName - unique name; additionalProperties - additional properties; typeName - type name to use for the entity; typeId - type GUID to use for the entity; extendedProperties - properties from the subtype.; repositoryHelper - helper methods; serviceName - name of this OMAS; serverName - name of local server

ReferenceableBuilder

public ReferenceableBuilder(Referenceable beanProperties,
                            OMRSRepositoryHelper repositoryHelper,
                            String serviceName,
                            String serverName)
                     throws InvalidParameterException

Constructor for classifications.

Parameters:: beanProperties - properties and header; repositoryHelper - helper methods; serviceName - name of this OMAS; serverName - name of local server
Throws:: InvalidParameterException - bad properties in bean classifications

Method Detail
- getTypeId
```
public String getTypeId()
```
- getTypeName
```
public String getTypeName()
```
- getInstanceProperties
```
public InstanceProperties getInstanceProperties(String methodName)
                                         throws InvalidParameterException
```
  Return the supplied bean properties in an InstanceProperties object.
  
  Overrides:
  
  getInstanceProperties in class RootBuilder
  
  Parameters:
  
  methodName - name of the calling method
  
  Returns:
  
  InstanceProperties object
  
  Throws:
  
  InvalidParameterException - there is a problem with the properties
- getNameInstanceProperties
```
public InstanceProperties getNameInstanceProperties(String methodName)
```
  Return the supplied bean properties that represent a name in an InstanceProperties object for search.
  
  Parameters:
  
  methodName - name of the calling method
  
  Returns:
  
  InstanceProperties object
- getQualifiedNameInstanceProperties
```
public InstanceProperties getQualifiedNameInstanceProperties(String methodName)
```
  Return the supplied bean properties that represent a name in an InstanceProperties object for search.
  
  Parameters:
  
  methodName - name of the calling method
  
  Returns:
  
  InstanceProperties object
- getSearchInstanceProperties
```
public InstanceProperties getSearchInstanceProperties(String methodName)
```
  Return the supplied bean properties that represent a name in an InstanceProperties object.
  
  Parameters:
  
  methodName - name of the calling method
  
  Returns:
  
  InstanceProperties object
- getEntityClassifications
```
public List<Classification> getEntityClassifications(String userId,
                                                     String methodName)
                                              throws InvalidParameterException
```
  Return a list of entity classifications that can be stored in the metadata repository.
  
  Parameters:
  
  userId - calling user
  
  methodName - calling method
  
  Returns:
  
  list of entity classification objects
  
  Throws:
  
  InvalidParameterException - the properties of the classification are flawed

Class ReferenceableBuilder

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.RootBuilder

Constructor Summary

Method Summary

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.builders.RootBuilder

Methods inherited from class java.lang.Object

Field Detail

qualifiedName

typeId

typeName

additionalProperties

extendedProperties

latestChange

Constructor Detail

ReferenceableBuilder

ReferenceableBuilder

ReferenceableBuilder

ReferenceableBuilder

ReferenceableBuilder

ReferenceableBuilder

ReferenceableBuilder

ReferenceableBuilder

ReferenceableBuilder

Method Detail

getTypeId

getTypeName

getInstanceProperties

getNameInstanceProperties

getQualifiedNameInstanceProperties

getSearchInstanceProperties

getEntityClassifications