ReferenceableHandler (OCF Metadata Management Server-side Handlers 2.2 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.ReferenceableHandler

```
public class ReferenceableHandler
extends Object
```
ReferenceableHandler manages methods on generic referenceables.

Constructor Summary

Constructors
Constructor and Description
`ReferenceableHandler(String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper)` Construct the handler information needed to interact with the repository services

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<Referenceable>`	`getMoreInformation(String userId, String elementGUID, int startFrom, int pageSize, String methodName)` Returns the list of related assets for the asset.
`Map<String,String>`	`getVendorProperties(String userId, String referenceableGUID, String qualifiedName, String methodName)` Retrieve the property facet for the vendor properties.
`void`	`setVendorProperties(String userId, String referenceableGUID, String qualifiedName, Map<String,String> vendorProperties, String methodName)` Create the property facet for the vendor properties.

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

Constructor Detail

ReferenceableHandler

public ReferenceableHandler(String serviceName,
                            String serverName,
                            InvalidParameterHandler invalidParameterHandler,
                            RepositoryHandler repositoryHandler,
                            OMRSRepositoryHelper repositoryHelper)

Construct the handler information needed to interact with the repository services

Parameters:: serviceName - name of this service; serverName - name of the local server; invalidParameterHandler - handler for managing parameter errors; repositoryHandler - manages calls to the repository services; repositoryHelper - provides utilities for manipulating the repository services objects

Method Detail

getMoreInformation

public List<Referenceable> getMoreInformation(String userId,
                                              String elementGUID,
                                              int startFrom,
                                              int pageSize,
                                              String methodName)
                                       throws InvalidParameterException,
                                              PropertyServerException,
                                              UserNotAuthorizedException

Returns the list of related assets for the asset.

Parameters:: userId - String userId of user making request.; elementGUID - String unique id for asset.; startFrom - int starting position for fist returned element.; pageSize - int maximum number of elements to return on the call.; methodName - String calling method
Returns:: a list of assets or
Throws:: InvalidParameterException - - the GUID is not recognized or the paging values are invalid or; PropertyServerException - - there is a problem retrieving the asset properties from the property server or; UserNotAuthorizedException - - the requesting user is not authorized to issue this request.

setVendorProperties

public void setVendorProperties(String userId,
                                String referenceableGUID,
                                String qualifiedName,
                                Map<String,String> vendorProperties,
                                String methodName)
                         throws InvalidParameterException,
                                UserNotAuthorizedException,
                                PropertyServerException

Create the property facet for the vendor properties.

Parameters:: userId - calling user; referenceableGUID - unique identifier of the metadata element; qualifiedName - qualified name of the metadata element; vendorProperties - properties for the vendor; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

getVendorProperties

public Map<String,String> getVendorProperties(String userId,
                                              String referenceableGUID,
                                              String qualifiedName,
                                              String methodName)
                                       throws InvalidParameterException,
                                              UserNotAuthorizedException,
                                              PropertyServerException

Retrieve the property facet for the vendor properties.

Parameters:: userId - calling user; referenceableGUID - unique identifier of the metadata element; qualifiedName - qualified name of the metadata element; methodName - calling method
Returns:: map of properties
Throws:: InvalidParameterException - one of the parameters is null or invalid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

Class ReferenceableHandler