Package org.odpi.openmetadata.accessservices.digitalservice.client

Class CollectionsClient

java.lang.Object
org.odpi.openmetadata.accessservices.digitalservice.client.OpenMetadataBaseClient
org.odpi.openmetadata.accessservices.digitalservice.client.CollectionsClient
All Implemented Interfaces:
org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
public class CollectionsClient extends OpenMetadataBaseClient implements org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
The CollectionsClient supports requests related to collections.

  • Constructor Summary

    Constructors
    Constructor
    Description
    CollectionsClient(String serverName, String serverPlatformURLRoot, int maxPageSize)
    Create a new client with no authentication embedded in the HTTP request.
    CollectionsClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize)
    Create a new client that passes userId and password in each HTTP request.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addToCollection(String userId, String collectionGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.collections.CollectionMembershipProperties membershipProperties, String elementGUID, Date effectiveTime)
    Add an element to a collection.
    void
    attachCollection(String userId, String collectionGUID, String parentGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.resources.ResourceListProperties collectionUse, boolean makeAnchor, Date effectiveTime)
    Connect an existing collection to an element using the ResourceList relationship (0019).
    String
    createCollection(String userId, String anchorGUID, boolean isOwnAnchor, String anchorScopeGUID, String optionalClassification, org.odpi.openmetadata.frameworks.openmetadata.properties.collections.CollectionProperties properties, String parentGUID, String parentRelationshipTypeName, org.odpi.openmetadata.frameworks.openmetadata.search.ElementProperties parentRelationshipProperties, boolean parentAtEnd1, Date effectiveTime)
    Create a new generic collection.
    String
    createCollectionFromTemplate(String userId, String anchorGUID, boolean isOwnAnchor, String anchorScopeGUID, Date effectiveFrom, Date effectiveTo, String templateGUID, org.odpi.openmetadata.frameworks.openmetadata.search.ElementProperties replacementProperties, Map<String,String> placeholderProperties, String parentGUID, String parentRelationshipTypeName, org.odpi.openmetadata.frameworks.openmetadata.search.ElementProperties parentRelationshipProperties, boolean parentAtEnd1, Date effectiveTime)
    Create a new metadata element to represent a collection using an existing metadata element as a template.
    String
    createDigitalProduct(String userId, String anchorGUID, boolean isOwnAnchor, String anchorScopeGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.collections.CollectionProperties collectionProperties, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalProductProperties digitalProductProperties, String parentGUID, String parentRelationshipTypeName, org.odpi.openmetadata.frameworks.openmetadata.search.ElementProperties parentRelationshipProperties, boolean parentAtEnd1, Date effectiveTime)
    Create a new collection that represents a digital product.
    void
    deleteCollection(String userId, String collectionGUID, boolean cascadedDelete)
    Delete a collection.
    void
    detachCollection(String userId, String collectionGUID, String parentGUID, Date effectiveTime)
    Detach an existing collection from an element.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement>
    findCollections(String userId, String classificationName, String searchString, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)
    Returns the list of collections matching the search string - this is coded as a regular expression.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement>
    getAttachedCollections(String userId, String parentGUID, String collectionType, int startFrom, int pageSize)
    Returns the list of collections that are linked off of the supplied element.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement>
    getClassifiedCollections(String userId, String classificationName, int startFrom, int pageSize)
    Returns the list of collections with a particular classification.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement
    getCollection(String userId, String collectionGUID, Date asOfTime, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)
    Return the properties of a specific collection.
    org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionGraph
    getCollectionGraph(String userId, String collectionGUID, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, int startFrom, int pageSize)
    Return a graph of elements that are the nested members of a collection along with elements immediately connected to the starting collection.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionMember>
    getCollectionMembers(String userId, String collectionGUID, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, int startFrom, int pageSize)
    Return a list of elements that are a member of a collection.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement>
    getCollectionsByName(String userId, String classificationName, String name, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime)
    Returns the list of collections with a particular name.
    List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement>
    getCollectionsByType(String userId, String classificationName, String collectionType, int startFrom, int pageSize)
    Returns the list of collections with a particular collectionType.
    void
    removeFromCollection(String userId, String collectionGUID, String elementGUID, Date effectiveTime)
    Remove an element from a collection.
    void
    updateCollection(String userId, String collectionGUID, boolean replaceAllProperties, org.odpi.openmetadata.frameworks.openmetadata.properties.collections.CollectionProperties properties, Date effectiveTime)
    Update the properties of a collection.
    void
    updateCollectionMembership(String userId, String collectionGUID, boolean replaceAllProperties, org.odpi.openmetadata.frameworks.openmetadata.properties.collections.CollectionMembershipProperties membershipProperties, String elementGUID, Date effectiveTime)
    Update an element's membership to a collection.
    void
    updateDigitalProduct(String userId, String collectionGUID, boolean replaceAllProperties, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalProductProperties properties, Date effectiveTime)
    Update the properties of the DigitalProduct classification attached to a collection.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • CollectionsClient

      public CollectionsClient(String serverName, String serverPlatformURLRoot, int maxPageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Create a new client with no authentication embedded in the HTTP request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      maxPageSize - number of elements that can be returned on a call
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

    • CollectionsClient

      public CollectionsClient(String serverName, String serverPlatformURLRoot, String userId, String password, int maxPageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException
      Create a new client that passes userId and password in each HTTP request. This is the userId/password of the calling server. The end user's userId is sent on each request.
      Parameters:
      serverName - name of the server to connect to
      serverPlatformURLRoot - the network address of the server running the OMAS REST services
      userId - caller's userId embedded in all HTTP requests
      password - caller's userId embedded in all HTTP requests
      maxPageSize - number of elements that can be returned on a call
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - there is a problem creating the client-side components to issue any REST API calls.

  • Method Details

    • getAttachedCollections

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement> getAttachedCollections(String userId, String parentGUID, String collectionType, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Returns the list of collections that are linked off of the supplied element.
      Specified by:
      getAttachedCollections in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request
      parentGUID - unique identifier of referenceable object (typically a personal profile, project or community) that the collections hang off of
      collectionType - filter response by collection type - if null, any value will do
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      Returns:
      a list of collections
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getClassifiedCollections

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement> getClassifiedCollections(String userId, String classificationName, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Returns the list of collections with a particular classification.
      Specified by:
      getClassifiedCollections in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request
      classificationName - name of the classification - if null, all collections are returned
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      Returns:
      a list of collections
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • findCollections

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement> findCollections(String userId, String classificationName, String searchString, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Returns the list of collections matching the search string - this is coded as a regular expression.
      Specified by:
      findCollections in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request
      classificationName - option name of a collection classification
      searchString - string to search for
      limitResultsByStatus - control the status of the elements to retrieve - default is everything but Deleted
      asOfTime - repository time to use
      sequencingOrder - order to retrieve results
      sequencingProperty - property to use for sequencing order
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - the retrieved elements are for lineage processing so include archived elements
      forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
      effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.
      Returns:
      a list of collections
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getCollectionsByName

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement> getCollectionsByName(String userId, String classificationName, String name, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, String sequencingProperty, int startFrom, int pageSize, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Returns the list of collections with a particular name.
      Specified by:
      getCollectionsByName in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request
      classificationName - option name of a collection classification
      name - name of the collections to return - match is full text match in qualifiedName or name
      limitResultsByStatus - control the status of the elements to retrieve - default is everything but Deleted
      asOfTime - repository time to use
      sequencingOrder - order to retrieve results
      sequencingProperty - property to use for sequencing order
      startFrom - paging start point
      pageSize - maximum results that can be returned
      forLineage - the retrieved elements are for lineage processing so include archived elements
      forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
      effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.
      Returns:
      a list of collections
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getCollectionsByType

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement> getCollectionsByType(String userId, String classificationName, String collectionType, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Returns the list of collections with a particular collectionType. This is an optional text field in the collection element.
      Specified by:
      getCollectionsByType in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request
      classificationName - option name of a collection classification
      collectionType - the collection type value to match on. If it is null, all collections with a null collectionType are returned
      startFrom - index of the list to start from (0 for start)
      pageSize - maximum number of elements to return
      Returns:
      a list of collections
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getCollection

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionElement getCollection(String userId, String collectionGUID, Date asOfTime, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Return the properties of a specific collection.
      Specified by:
      getCollection in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request
      collectionGUID - unique identifier of the required collection
      asOfTime - repository time to use
      forLineage - the retrieved elements are for lineage processing so include archived elements
      forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
      effectiveTime - only return an element if it is effective at this time. Null means anytime. Use "new Date()" for now.
      Returns:
      collection properties
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • createCollection

      public String createCollection(String userId, String anchorGUID, boolean isOwnAnchor, String anchorScopeGUID, String optionalClassification, org.odpi.openmetadata.frameworks.openmetadata.properties.collections.CollectionProperties properties, String parentGUID, String parentRelationshipTypeName, org.odpi.openmetadata.frameworks.openmetadata.search.ElementProperties parentRelationshipProperties, boolean parentAtEnd1, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Create a new generic collection.
      Specified by:
      createCollection in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request.
      anchorGUID - unique identifier of the element that should be the anchor for the new element. Set to null if no anchor, or the Anchors classification is included in the initial classifications.
      isOwnAnchor - boolean flag to day that the element should be classified as its own anchor once its element is created in the repository.
      anchorScopeGUID - optional scope of the anchor
      optionalClassification - classification of the collections - typically RootCollection, Set or Folder
      properties - properties for the collection.
      parentGUID - unique identifier of optional parent entity
      parentRelationshipTypeName - type of relationship to connect the new element to the parent
      parentRelationshipProperties - properties to include in parent relationship
      parentAtEnd1 - which end should the parent GUID go in the relationship
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Returns:
      unique identifier of the newly created Collection
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • createCollectionFromTemplate

      public String createCollectionFromTemplate(String userId, String anchorGUID, boolean isOwnAnchor, String anchorScopeGUID, Date effectiveFrom, Date effectiveTo, String templateGUID, org.odpi.openmetadata.frameworks.openmetadata.search.ElementProperties replacementProperties, Map<String,String> placeholderProperties, String parentGUID, String parentRelationshipTypeName, org.odpi.openmetadata.frameworks.openmetadata.search.ElementProperties parentRelationshipProperties, boolean parentAtEnd1, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.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.
      Specified by:
      createCollectionFromTemplate in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - calling user
      anchorGUID - unique identifier of the element that should be the anchor for the new element. Set to null if no anchor, or the Anchors classification is included in the initial classifications.
      isOwnAnchor - boolean flag to day that the element should be classified as its own anchor once its element is created in the repository.
      anchorScopeGUID - optional scope of the anchor
      effectiveFrom - the date when this element is active - null for active on creation
      effectiveTo - the date when this element becomes inactive - null for active until deleted
      templateGUID - the unique identifier of the existing asset to copy (this will copy all the attachments such as nested content, schema connection etc)
      replacementProperties - properties of the new metadata element. These override the template values
      placeholderProperties - property name-to-property value map to replace any placeholder values in the template element - and their anchored elements, which are also copied as part of this operation.
      parentGUID - unique identifier of optional parent entity
      parentRelationshipTypeName - type of relationship to connect the new element to the parent
      parentRelationshipProperties - properties to include in parent relationship
      parentAtEnd1 - which end should the parent GUID go in the relationship
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Returns:
      unique identifier of the new metadata element
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the user is not authorized to issue this request
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem reported in the open metadata server(s)

    • createDigitalProduct

      public String createDigitalProduct(String userId, String anchorGUID, boolean isOwnAnchor, String anchorScopeGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.collections.CollectionProperties collectionProperties, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalProductProperties digitalProductProperties, String parentGUID, String parentRelationshipTypeName, org.odpi.openmetadata.frameworks.openmetadata.search.ElementProperties parentRelationshipProperties, boolean parentAtEnd1, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Create a new collection that represents a digital product.
      Specified by:
      createDigitalProduct in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request.
      anchorGUID - unique identifier of the element that should be the anchor for the new element. Set to null if no anchor, or the Anchors classification is included in the initial classifications.
      isOwnAnchor - boolean flag to day that the element should be classified as its own anchor once its element is created in the repository.
      anchorScopeGUID - optional scope of the anchor
      collectionProperties - properties for the collection.
      digitalProductProperties - properties for the attached DigitalProduct classification
      parentGUID - unique identifier of optional parent entity
      parentRelationshipTypeName - type of relationship to connect the new element to the parent
      parentRelationshipProperties - properties to include in parent relationship
      parentAtEnd1 - which end should the parent GUID go in the relationship
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Returns:
      unique identifier of the newly created Collection
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateCollection

      public void updateCollection(String userId, String collectionGUID, boolean replaceAllProperties, org.odpi.openmetadata.frameworks.openmetadata.properties.collections.CollectionProperties properties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Update the properties of a collection.
      Specified by:
      updateCollection in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request.
      collectionGUID - unique identifier of the collection (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      properties - properties for the collection.
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateDigitalProduct

      public void updateDigitalProduct(String userId, String collectionGUID, boolean replaceAllProperties, org.odpi.openmetadata.frameworks.openmetadata.properties.digitalbusiness.DigitalProductProperties properties, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Update the properties of the DigitalProduct classification attached to a collection.
      Specified by:
      updateDigitalProduct in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request.
      collectionGUID - unique identifier of the collection (returned from create)
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      properties - properties for the DigitalProduct classification.
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • attachCollection

      public void attachCollection(String userId, String collectionGUID, String parentGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.resources.ResourceListProperties collectionUse, boolean makeAnchor, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Connect an existing collection to an element using the ResourceList relationship (0019).
      Specified by:
      attachCollection in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request
      collectionGUID - unique identifier of the collection
      parentGUID - unique identifier of referenceable object that the collection should be attached to
      collectionUse - description of how the collection will be used.
      makeAnchor - like the lifecycle of the collection to that of the parent so that if the parent is deleted, so is the collection
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • detachCollection

      public void detachCollection(String userId, String collectionGUID, String parentGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Detach an existing collection from an element. If the collection is anchored to the element, it is deleted.
      Specified by:
      detachCollection in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request.
      collectionGUID - unique identifier of the collection.
      parentGUID - unique identifier of referenceable object that the collection should be attached to.
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • deleteCollection

      public void deleteCollection(String userId, String collectionGUID, boolean cascadedDelete) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Delete a collection. It is detached from all parent elements. If members are anchored to the collection then they are also deleted.
      Specified by:
      deleteCollection in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request.
      collectionGUID - unique identifier of the collection
      cascadedDelete - should any nested collections be deleted? If false, the delete fails if there are nested collections. If true, nested collections are delete - but not member elements unless they are anchored to the collection
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is null or invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getCollectionMembers

      public List<org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionMember> getCollectionMembers(String userId, String collectionGUID, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Return a list of elements that are a member of a collection.
      Specified by:
      getCollectionMembers in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request.
      collectionGUID - unique identifier of the collection.
      limitResultsByStatus - By default, relationships in all statuses (other than DELETE) are returned. However, it is possible to specify a list of statuses (for example ACTIVE) to restrict the results to. Null means all status values.
      asOfTime - Requests a historical query of the entity. Null means return the present values.
      sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).
      sequencingOrder - Enum defining how the results should be ordered.
      forLineage - the retrieved element is for lineage processing so include archived elements
      forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
      effectiveTime - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of member details
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • getCollectionGraph

      public org.odpi.openmetadata.frameworks.openmetadata.metadataelements.CollectionGraph getCollectionGraph(String userId, String collectionGUID, List<org.odpi.openmetadata.frameworks.openmetadata.enums.ElementStatus> limitResultsByStatus, Date asOfTime, String sequencingProperty, org.odpi.openmetadata.frameworks.openmetadata.enums.SequencingOrder sequencingOrder, boolean forLineage, boolean forDuplicateProcessing, Date effectiveTime, int startFrom, int pageSize) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Return a graph of elements that are the nested members of a collection along with elements immediately connected to the starting collection. The result includes a mermaid graph of the returned elements.
      Specified by:
      getCollectionGraph in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request.
      collectionGUID - unique identifier of the collection.
      limitResultsByStatus - By default, relationships in all statuses (other than DELETE) are returned. However, it is possible to specify a list of statuses (for example ACTIVE) to restrict the results to. Null means all status values.
      asOfTime - Requests a historical query of the entity. Null means return the present values.
      sequencingProperty - String name of the property that is to be used to sequence the results. Null means do not sequence on a property name (see SequencingOrder).
      sequencingOrder - Enum defining how the results should be ordered.
      forLineage - the retrieved element is for lineage processing so include archived elements
      forDuplicateProcessing - the retrieved element is for duplicate processing so do not combine results from known duplicates.
      effectiveTime - only return the element if it is effective at this time. Null means anytime. Use "new Date()" for now.
      startFrom - paging start point
      pageSize - maximum results that can be returned
      Returns:
      list of member details
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem retrieving information from the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • addToCollection

      public void addToCollection(String userId, String collectionGUID, org.odpi.openmetadata.frameworks.openmetadata.properties.collections.CollectionMembershipProperties membershipProperties, String elementGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Add an element to a collection.
      Specified by:
      addToCollection in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request.
      collectionGUID - unique identifier of the collection.
      membershipProperties - properties describing the membership characteristics.
      elementGUID - unique identifier of the element.
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem updating information in the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • updateCollectionMembership

      public void updateCollectionMembership(String userId, String collectionGUID, boolean replaceAllProperties, org.odpi.openmetadata.frameworks.openmetadata.properties.collections.CollectionMembershipProperties membershipProperties, String elementGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Update an element's membership to a collection.
      Specified by:
      updateCollectionMembership in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request.
      collectionGUID - unique identifier of the collection.
      replaceAllProperties - flag to indicate whether to completely replace the existing properties with the new properties, or just update the individual properties specified on the request.
      membershipProperties - properties describing the membership characteristics.
      elementGUID - unique identifier of the element.
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem updating information in the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.

    • removeFromCollection

      public void removeFromCollection(String userId, String collectionGUID, String elementGUID, Date effectiveTime) throws org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException, org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException
      Remove an element from a collection.
      Specified by:
      removeFromCollection in interface org.odpi.openmetadata.accessservices.digitalservice.api.CollectionsInterface
      Parameters:
      userId - userId of user making request.
      collectionGUID - unique identifier of the collection.
      elementGUID - unique identifier of the element.
      effectiveTime - the time that the retrieved elements must be effective for (null for any time, new Date() for now)
      Throws:
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.InvalidParameterException - one of the parameters is invalid.
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.PropertyServerException - there is a problem updating information in the property server(s).
      org.odpi.openmetadata.frameworks.openmetadata.ffdc.UserNotAuthorizedException - the requesting user is not authorized to issue this request.