org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers

Class NoteHandler

java.lang.Object

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.AttachmentHandlerBase

org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.NoteHandler

public class NoteHandler
extends AttachmentHandlerBase

NoteLogHandler manages NoteLog objects. It runs server-side in the OMAG Server Platform and retrieves NoteLog entities through the OMRSRepositoryConnector.

Field Summary

Fields inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.AttachmentHandlerBase

invalidParameterHandler, lastAttachmentHandler, repositoryHandler, repositoryHelper, serverName, serviceName

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	countAttachedNotes(String userId, String anchorGUID, String methodName) Count the number of notes attached to an anchor note log.
List<Note>	getNotes(String userId, String anchorGUID, int startingFrom, int pageSize, String methodName) Return the notes attached to an anchor note log.

Methods inherited from class org.odpi.openmetadata.commonservices.ocf.metadatamanagement.handlers.AttachmentHandlerBase

countAttachments, getAttachmentLinks, getAttachments

Methods inherited from class java.lang.Object

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

Constructor Detail

NoteHandler

public NoteHandler(String serviceName,
                   String serverName,
                   InvalidParameterHandler invalidParameterHandler,
                   RepositoryHandler repositoryHandler,
                   OMRSRepositoryHelper repositoryHelper,
                   LastAttachmentHandler lastAttachmentHandler)

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

lastAttachmentHandler - handler for recording last attachment

Method Detail

countAttachedNotes

public int countAttachedNotes(String userId,
                              String anchorGUID,
                              String methodName)
                       throws InvalidParameterException,
                              PropertyServerException,
                              UserNotAuthorizedException

Count the number of notes attached to an anchor note log.

Parameters:

userId - calling user

anchorGUID - identifier for the entity that the object is attached to

methodName - calling method

Returns:

count of the attached objects

Throws:

InvalidParameterException - the parameters are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getNotes

public List<Note> getNotes(String userId,
                           String anchorGUID,
                           int startingFrom,
                           int pageSize,
                           String methodName)
                    throws InvalidParameterException,
                           PropertyServerException,
                           UserNotAuthorizedException

Return the notes attached to an anchor note log.

Parameters:

userId - calling user

anchorGUID - identifier for the entity that the identifier is attached to

startingFrom - where to start from in the list

pageSize - maximum number of results that can be returned

methodName - calling method

Returns:

list of retrieved objects or null if none found

Throws:

InvalidParameterException - the input properties are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server