CollectionHandler (Generic Handler Services 2.10 API)

java.lang.Object
- org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
- - org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler
 - - org.odpi.openmetadata.commonservices.generichandlers.CollectionHandler

Type Parameters:

B - class that represents the collection
```
public class CollectionHandler
extends ReferenceableHandler
```
CollectionHandler provides the exchange of metadata about collections between the repository and the OMAS.

Field Summary
- Fields inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
  auditLog, beanClass, converter, defaultZones, errorHandler, invalidParameterHandler, localServerUserId, publishZones, repositoryHandler, repositoryHelper, securityVerifier, serverName, serviceName, supportedZones

Constructor Summary

Constructors
Constructor and Description
`CollectionHandler(OpenMetadataAPIGenericConverter<B> converter, Class<B> beanClass, String serviceName, String serverName, InvalidParameterHandler invalidParameterHandler, RepositoryHandler repositoryHandler, OMRSRepositoryHelper repositoryHelper, String localServerUserId, OpenMetadataServerSecurityVerifier securityVerifier, List<String> supportedZones, List<String> defaultZones, List<String> publishZones, AuditLog auditLog)` Construct the handler with information needed to work with B objects.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addFolderClassificationToCollection(String userId, String collectionGUID, String collectionGUIDParameterName, int orderBy, String orderPropertyName, String methodName)` Mark the collection as a taxonomy.
`void`	`addMemberToCollection(String userId, String externalSourceGUID, String externalSourceName, String collectionGUID, String collectionGUIDParameterName, String memberGUID, String memberGUIDParameterName, String membershipRationale, String methodName)` Add a member (Referenceable) to collection.
`String`	`createCollection(String userId, String externalSourceGUID, String externalSourceName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String classificationName, String methodName)` Create the collection object.
`String`	`createCollectionFromTemplate(String userId, String externalSourceGUID, String externalSourceName, String templateGUID, String qualifiedName, String displayName, String description, String methodName)` Create a new metadata element to represent a collection using an existing metadata element as a template.
`String`	`createFolder(String userId, String externalSourceGUID, String externalSourceName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, int orderBy, String orderPropertyName, String methodName)` Create the folder object.
`List<B>`	`findCollections(String userId, String searchString, String searchStringParameterName, int startFrom, int pageSize, String methodName)` Retrieve the list of collection metadata elements that contain the search string.
`B`	`getCollectionByGUID(String userId, String guid, String guidParameterName, String methodName)` Retrieve the collection metadata element with the supplied unique identifier.
`List<B>`	`getCollectionsByName(String userId, String name, String nameParameterName, int startFrom, int pageSize, String methodName)` Retrieve the list of collection metadata elements with a matching qualified or display name.
`void`	`removeCollection(String userId, String externalSourceGUID, String externalSourceName, String collectionGUID, String collectionGUIDParameterName, String methodName)` Remove the metadata element representing a collection.
`void`	`removeFolderClassificationFromCollection(String userId, String collectionGUID, String collectionGUIDParameterName, String methodName)` Remove the taxonomy designation from a collection.
`void`	`removeMemberFromCollection(String userId, String externalSourceGUID, String externalSourceName, String collectionGUID, String collectionGUIDParameterName, String memberGUID, String memberGUIDParameterName, String methodName)` Remove a parent-child relationship between two categories.
`void`	`updateCollection(String userId, String externalSourceGUID, String externalSourceName, String collectionGUID, String collectionGUIDParameterName, String qualifiedName, String displayName, String description, Map<String,String> additionalProperties, String suppliedTypeName, Map<String,Object> extendedProperties, String methodName)` Update the anchor object that all elements in a collection (terms and categories) are linked to.

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.ReferenceableHandler
addOwner, addSecurityTags, addTemplateClassification, clearBusinessSignificant, findBeanGUIDsByQualifiedName, findBeanGUIDsByQualifiedName, findBeansByQualifiedName, findBeansByQualifiedName, getBeanByQualifiedName, getBeanByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDByQualifiedName, getBeanGUIDsByQualifiedName, getBeanGUIDsByQualifiedName, getBeansByQualifiedName, getBeansByQualifiedName, getCollectionMembers, getEntityByUniqueQualifiedName, getMoreInformation, getMoreInformation, getVendorProperties, linkElementsAsDuplicates, removeOwner, removeResourceListMember, removeSecurityTags, removeSemanticAssignment, removeTemplateClassification, saveResourceListMember, saveSemanticAssignment, saveSemanticAssignment, setBusinessSignificant, unlinkElementsAsDuplicates

Methods inherited from class org.odpi.openmetadata.commonservices.generichandlers.OpenMetadataAPIGenericHandler
archiveBeanInRepository, archiveBeanInRepository, countAttachments, createBeanFromTemplate, createBeanInRepository, deleteBeanInRepository, deleteBeanInRepository, findAttachmentLinks, findBeanGUIDs, findBeans, findBeans, findBeans, findBeans, findEntities, getAllAttachmentLinks, getAnchorsForAttachedElements, getAttachedElement, getAttachedElement, getAttachedElementGUID, getAttachedElementGUID, getAttachedElementGUIDs, getAttachedElementGUIDs, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedElements, getAttachedEntities, getAttachedEntities, getAttachedEntities, getAttachedEntity, getAttachedEntity, getAttachmentLinks, getAttachmentLinks, getAttachmentLinks, getBeanByUniqueName, getBeanByUniqueName, getBeanByValue, getBeanFromEntity, getBeanFromRepository, getBeanFromRepository, getBeanGUIDByUniqueName, getBeanGUIDByUniqueName, getBeanGUIDsByClassification, getBeanGUIDsByType, getBeanGUIDsByType, getBeanGUIDsByValue, getBeansByClassification, getBeansByCreator, getBeansByIntValue, getBeansByType, getBeansByType, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getBeansByValue, getEntitiesByIntValue, getEntitiesByType, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntitiesByValue, getEntityByValue, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityFromRepository, getEntityGUIDByValue, getEntityGUIDsByValue, getRepositoryHelper, getServiceName, getUniqueAttachmentLink, getUniqueAttachmentLink, linkElementToElement, linkElementToElement, maintainSupplementaryProperties, relinkElementToNewElement, relinkElementToNewElement, removeClassificationFromRepository, setClassificationInRepository, setClassificationInRepository, setSecurityVerifier, unlinkAllElements, unlinkAllElements, unlinkConnectedElement, unlinkConnectedElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, unlinkElementFromElement, updateBeanEffectivityDates, updateBeanInRepository, updateBeanInRepository, updateBeanPropertyInRepository, updateBeanStatusInRepository, updateBeanStatusInRepository, updateClassificationEffectivityDates, updateElementToElementLink, updateElementToElementLink, updateRelationshipEffectivityDates, updateRelationshipProperties, validateAnchorEntity, validateAnchorEntity, verifyExternalSourceIdentity

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

Constructor Detail

CollectionHandler

public CollectionHandler(OpenMetadataAPIGenericConverter<B> converter,
                         Class<B> beanClass,
                         String serviceName,
                         String serverName,
                         InvalidParameterHandler invalidParameterHandler,
                         RepositoryHandler repositoryHandler,
                         OMRSRepositoryHelper repositoryHelper,
                         String localServerUserId,
                         OpenMetadataServerSecurityVerifier securityVerifier,
                         List<String> supportedZones,
                         List<String> defaultZones,
                         List<String> publishZones,
                         AuditLog auditLog)

Construct the handler with information needed to work with B objects.

Parameters:: converter - specific converter for this bean class; beanClass - name of bean class that is represented by the generic class B; 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; localServerUserId - userId for this server; securityVerifier - open metadata security services verifier; supportedZones - list of zones that the access service is allowed to serve B instances from; defaultZones - list of zones that the access service should set in all new B instances; publishZones - list of zones that the access service sets up in published B instances; auditLog - destination for audit log events

Method Detail

createCollection

public String createCollection(String userId,
                               String externalSourceGUID,
                               String externalSourceName,
                               String qualifiedName,
                               String displayName,
                               String description,
                               Map<String,String> additionalProperties,
                               String suppliedTypeName,
                               Map<String,Object> extendedProperties,
                               String classificationName,
                               String methodName)
                        throws InvalidParameterException,
                               UserNotAuthorizedException,
                               PropertyServerException

Create the collection object.

Parameters:: userId - calling user; externalSourceGUID - unique identifier of the software server capability that owns this collection; externalSourceName - unique name of the software server capability that owns this collection; qualifiedName - unique name for the collection - used in other configuration; displayName - short display name for the collection; description - description of the governance collection; additionalProperties - additional properties for a collection; suppliedTypeName - type name from the caller (enables creation of subtypes); extendedProperties - properties for a governance collection subtype; classificationName - name of classification to add to the collection (assume no properties); methodName - calling method
Returns:: unique identifier of the new collection object
Throws:: InvalidParameterException - qualifiedName or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createFolder

public String createFolder(String userId,
                           String externalSourceGUID,
                           String externalSourceName,
                           String qualifiedName,
                           String displayName,
                           String description,
                           Map<String,String> additionalProperties,
                           String suppliedTypeName,
                           Map<String,Object> extendedProperties,
                           int orderBy,
                           String orderPropertyName,
                           String methodName)
                    throws InvalidParameterException,
                           UserNotAuthorizedException,
                           PropertyServerException

Create the folder object. This is collection with a Folder classification attached

Parameters:: userId - calling user; externalSourceGUID - unique identifier of the software server capability that owns this collection; externalSourceName - unique name of the software server capability that owns this collection; qualifiedName - unique name for the collection - used in other configuration; displayName - short display name for the collection; description - description of the governance collection; additionalProperties - additional properties for a collection; suppliedTypeName - type name from the caller (enables creation of subtypes); extendedProperties - properties for a governance collection subtype; orderBy - the factor used to organize the members; orderPropertyName - name of property of OrderBy is 99 (OTHER); methodName - calling method
Returns:: unique identifier of the new collection object
Throws:: InvalidParameterException - qualifiedName or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

createCollectionFromTemplate
```
public String createCollectionFromTemplate(String userId,
                                           String externalSourceGUID,
                                           String externalSourceName,
                                           String templateGUID,
                                           String qualifiedName,
                                           String displayName,
                                           String description,
                                           String methodName)
                                    throws InvalidParameterException,
                                           UserNotAuthorizedException,
                                           PropertyServerException
```
Create a new metadata element to represent a collection using an existing metadata element as a template. The template defines additional classifications and relationships that should be added to the new collection. All categories and terms are linked to a single collection. They are owned by this collection and if the collection is deleted, any linked terms and categories are deleted as well.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of the software server capability that owns this collection

externalSourceName - unique name of the software server capability that owns this collection

templateGUID - unique identifier of the metadata element to copy

qualifiedName - unique name for the collection - used in other configuration

displayName - short display name for the collection

description - description of the governance collection

methodName - calling method

Returns:

unique identifier of the new metadata element

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

updateCollection

public void updateCollection(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String collectionGUID,
                             String collectionGUIDParameterName,
                             String qualifiedName,
                             String displayName,
                             String description,
                             Map<String,String> additionalProperties,
                             String suppliedTypeName,
                             Map<String,Object> extendedProperties,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Update the anchor object that all elements in a collection (terms and categories) are linked to.

Parameters:: userId - calling user; externalSourceGUID - unique identifier of the software server capability that owns this collection; externalSourceName - unique name of the software server capability that owns this collection; collectionGUID - unique identifier of the collection to update; collectionGUIDParameterName - parameter passing the collectionGUID; qualifiedName - unique name for the collection - used in other configuration; displayName - short display name for the collection; description - description of the governance collection; additionalProperties - additional properties for a governance collection; suppliedTypeName - type of collection; extendedProperties - properties for a governance collection subtype; methodName - calling method
Throws:: InvalidParameterException - qualifiedName or userId is null; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

addFolderClassificationToCollection

public void addFolderClassificationToCollection(String userId,
                                                String collectionGUID,
                                                String collectionGUIDParameterName,
                                                int orderBy,
                                                String orderPropertyName,
                                                String methodName)
                                         throws InvalidParameterException,
                                                UserNotAuthorizedException,
                                                PropertyServerException

Mark the collection as a taxonomy.

Parameters:: userId - calling user; collectionGUID - unique identifier of asset; collectionGUIDParameterName - parameter name supplying collectionGUID; orderBy - the factor used to organize the members; orderPropertyName - name of property of OrderBy is 99 (OTHER); methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

removeFolderClassificationFromCollection

public void removeFolderClassificationFromCollection(String userId,
                                                     String collectionGUID,
                                                     String collectionGUIDParameterName,
                                                     String methodName)
                                              throws InvalidParameterException,
                                                     UserNotAuthorizedException,
                                                     PropertyServerException

Remove the taxonomy designation from a collection.

Parameters:: userId - calling user; collectionGUID - unique identifier of asset; collectionGUIDParameterName - parameter name supplying collectionGUID; methodName - calling method
Throws:: InvalidParameterException - entity not known, null userId or guid; PropertyServerException - problem accessing property server; UserNotAuthorizedException - security access problem

addMemberToCollection

public void addMemberToCollection(String userId,
                                  String externalSourceGUID,
                                  String externalSourceName,
                                  String collectionGUID,
                                  String collectionGUIDParameterName,
                                  String memberGUID,
                                  String memberGUIDParameterName,
                                  String membershipRationale,
                                  String methodName)
                           throws InvalidParameterException,
                                  UserNotAuthorizedException,
                                  PropertyServerException

Add a member (Referenceable) to collection.

Parameters:: userId - calling user; externalSourceGUID - unique identifier of the software server capability that owns this collection; externalSourceName - unique name of the software server capability that owns this collection; collectionGUID - unique identifier of the collection; collectionGUIDParameterName - parameter supplying the collectionGUID; memberGUID - unique identifier of the element that is being added to the collection; memberGUIDParameterName - parameter supplying the memberGUID; membershipRationale - why is the element a member? (optional); methodName - calling method
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

removeMemberFromCollection

public void removeMemberFromCollection(String userId,
                                       String externalSourceGUID,
                                       String externalSourceName,
                                       String collectionGUID,
                                       String collectionGUIDParameterName,
                                       String memberGUID,
                                       String memberGUIDParameterName,
                                       String methodName)
                                throws InvalidParameterException,
                                       UserNotAuthorizedException,
                                       PropertyServerException

Remove a parent-child relationship between two categories.

Parameters:: userId - calling user; externalSourceGUID - unique identifier of the software server capability that owns this collection; externalSourceName - unique name of the software server capability that owns this collection; collectionGUID - unique identifier of the collection; collectionGUIDParameterName - parameter supplying the collectionGUID; memberGUID - unique identifier of the element that is being added to the collection; memberGUIDParameterName - parameter supplying the memberGUID; methodName - calling method
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

removeCollection
```
public void removeCollection(String userId,
                             String externalSourceGUID,
                             String externalSourceName,
                             String collectionGUID,
                             String collectionGUIDParameterName,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException
```
Remove the metadata element representing a collection. This will delete the collection and all categories and terms because the Anchors classifications are set up in these elements.

Parameters:

userId - calling user

externalSourceGUID - unique identifier of the software server capability that owns this collection

externalSourceName - unique name of the software server capability that owns this collection

collectionGUID - unique identifier of the metadata element to remove

collectionGUIDParameterName - parameter supplying the collectionGUID

methodName - calling method

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

findCollections
```
public List findCollections(String userId,
 String searchString,
 String searchStringParameterName,
 int startFrom,
 int pageSize,
 String methodName)
 throws InvalidParameterException,
 UserNotAuthorizedException,
 PropertyServerException
```
Retrieve the list of collection metadata elements that contain the search string. The search string is treated as a regular expression.

Parameters:

userId - calling user

searchString - string to find in the properties

searchStringParameterName - name of parameter supplying the search string

startFrom - paging start point

pageSize - maximum results that can be returned

methodName - calling method

Returns:

list of matching metadata elements

Throws:

InvalidParameterException - one of the parameters is invalid

UserNotAuthorizedException - the user is not authorized to issue this request

PropertyServerException - there is a problem reported in the open metadata server(s)

getCollectionsByName

public List<B> getCollectionsByName(String userId,
                                    String name,
                                    String nameParameterName,
                                    int startFrom,
                                    int pageSize,
                                    String methodName)
                             throws InvalidParameterException,
                                    UserNotAuthorizedException,
                                    PropertyServerException

Retrieve the list of collection metadata elements with a matching qualified or display name. There are no wildcards supported on this request.

Parameters:: userId - calling user; name - name to search for; nameParameterName - parameter supplying name; startFrom - paging start point; pageSize - maximum results that can be returned; methodName - calling method
Returns:: list of matching metadata elements
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

getCollectionByGUID

public B getCollectionByGUID(String userId,
                             String guid,
                             String guidParameterName,
                             String methodName)
                      throws InvalidParameterException,
                             UserNotAuthorizedException,
                             PropertyServerException

Retrieve the collection metadata element with the supplied unique identifier.

Parameters:: userId - calling user; guid - unique identifier of the requested metadata element; guidParameterName - parameter name of guid; methodName - calling method
Returns:: matching metadata element
Throws:: InvalidParameterException - one of the parameters is invalid; UserNotAuthorizedException - the user is not authorized to issue this request; PropertyServerException - there is a problem reported in the open metadata server(s)

Class CollectionHandler<B>

Field Summary

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