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

Class AttachmentHandlerBase

java.lang.Object

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

Direct Known Subclasses:

CertificationHandler, ConnectionHandler, ExternalIdentifierHandler, ExternalReferenceHandler, FeedbackHandlerBase, GlossaryTermHandler, LicenseHandler, LocationHandler, MeaningHandler, NoteHandler, NoteLogHandler, RelatedMediaHandler

public abstract class AttachmentHandlerBase
extends Object

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

Field Summary

Fields

Modifier and Type	Field and Description
protected InvalidParameterHandler	invalidParameterHandler
protected LastAttachmentHandler	lastAttachmentHandler
protected RepositoryHandler	repositoryHandler
protected OMRSRepositoryHelper	repositoryHelper
protected String	serverName
protected String	serviceName

Constructor Summary

Constructors

Constructor and Description
AttachmentHandlerBase(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
protected int	countAttachments(String userId, String anchorGUID, String anchorTypeName, String attachmentTypeGUID, String attachmentTypeName, String methodName) Count up the number of elements of a certain type that are attached to an anchor entity.
List<Relationship>	getAttachmentLinks(String userId, String anchorGUID, String anchorTypeName, String attachmentTypeGUID, String attachmentTypeName, int startingFrom, int pageSize, String methodName) Return the relationships to required elements attached to an anchor entity.
List<EntityDetail>	getAttachments(String userId, String anchorGUID, String anchorTypeName, boolean anchorAtEnd1, String attachmentTypeGUID, String attachmentTypeName, String entityTypeName, int startingFrom, int pageSize, String methodName) Return the entities for the required elements attached to an anchor entity.

Methods inherited from class java.lang.Object

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

Field Detail

serviceName

protected String serviceName

serverName

protected String serverName

repositoryHelper

protected OMRSRepositoryHelper repositoryHelper

repositoryHandler

protected RepositoryHandler repositoryHandler

invalidParameterHandler

protected InvalidParameterHandler invalidParameterHandler

lastAttachmentHandler

protected LastAttachmentHandler lastAttachmentHandler

Constructor Detail

AttachmentHandlerBase

public AttachmentHandlerBase(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

countAttachments

protected int countAttachments(String userId,
                               String anchorGUID,
                               String anchorTypeName,
                               String attachmentTypeGUID,
                               String attachmentTypeName,
                               String methodName)
                        throws InvalidParameterException,
                               PropertyServerException,
                               UserNotAuthorizedException

Count up the number of elements of a certain type that are attached to an anchor entity.

Parameters:

userId - calling user

anchorGUID - unique identifier for the entity that the object is attached to (anchor entity)

anchorTypeName - type of the anchor entity

attachmentTypeGUID - unique identifier of the attachment's type

attachmentTypeName - unique name of the attachment's type

methodName - calling method

Returns:

count of attached objects

Throws:

InvalidParameterException - the parameters are invalid

UserNotAuthorizedException - user not authorized to issue this request

PropertyServerException - problem accessing the property server

getAttachmentLinks

public List<Relationship> getAttachmentLinks(String userId,
                                             String anchorGUID,
                                             String anchorTypeName,
                                             String attachmentTypeGUID,
                                             String attachmentTypeName,
                                             int startingFrom,
                                             int pageSize,
                                             String methodName)
                                      throws InvalidParameterException,
                                             PropertyServerException,
                                             UserNotAuthorizedException

Return the relationships to required elements attached to an anchor entity.

Parameters:

userId - calling user

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

anchorTypeName - type name for anchor

attachmentTypeGUID - unique identifier of the attachment's type

attachmentTypeName - unique name of the attachment's type

startingFrom - start position for results

pageSize - maximum number of results

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

getAttachments

public List<EntityDetail> getAttachments(String userId,
                                         String anchorGUID,
                                         String anchorTypeName,
                                         boolean anchorAtEnd1,
                                         String attachmentTypeGUID,
                                         String attachmentTypeName,
                                         String entityTypeName,
                                         int startingFrom,
                                         int pageSize,
                                         String methodName)
                                  throws InvalidParameterException,
                                         PropertyServerException,
                                         UserNotAuthorizedException

Return the entities for the required elements attached to an anchor entity.

Parameters:

userId - calling user

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

anchorTypeName - type name for anchor

anchorAtEnd1 - indicates which end to extract attachment from

attachmentTypeGUID - unique identifier of the attachment's type

attachmentTypeName - unique name of the attachment's type

entityTypeName - unique name of the attached entity's type

startingFrom - start position for results

pageSize - maximum number of results

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