org.odpi.openmetadata.accessservices.communityprofile

Interface CollectionManagementInterface

public interface CollectionManagementInterface

The Community Profile Open Metadata Access Service (OMAS) is used by tools and administrators to maintain information associated with individuals and communities. The CollectionManagementInterface adds methods for managing collections that can be attached to communities and personal profiles

Method Summary

Modifier and Type	Method and Description
void	attachCollection(String userId, String collectionGUID, String anchorGUID) Connect an existing collection to an anchor point.
Collection	createCollection(String userId, String qualifiedName, String displayName, String description, String collectionUse, Map<String,Object> additionalProperties) Create a new generic collection.
Collection	createFolder(String userId, String qualifiedName, String displayName, String description, String collectionUse, CollectionOrder collectionOrder, Map<String,Object> additionalProperties) Create a collection that acts like a folder with an order.
Collection	createSet(String userId, String qualifiedName, String displayName, String description, String collectionUse, Map<String,Object> additionalProperties) Create a collection that acts like a set (this does not allow duplicate entries).
void	detachCollection(String userId, String collectionGUID, String anchorGUID) Detach an existing collection from an anchor point.
Collection	getCollection(String userId, String collectionGUID) Return the properties of a specific collection.
List<Collection>	getCollections(String userId, String anchorGUID, int startFrom, int pageSize) Returns the list of collections that are linked off of the supplied anchor point.
void	removeCollection(String userId, String collectionGUID) Delete a collection (the members are not affected).

Method Detail

getCollections

List<Collection> getCollections(String userId,
                                String anchorGUID,
                                int startFrom,
                                int pageSize)
                         throws InvalidParameterException,
                                PropertyServerException,
                                UserNotAuthorizedException

Returns the list of collections that are linked off of the supplied anchor point.

Parameters:

userId - userId of user making request

anchorGUID - unique identifier of referenceable object (typically a personal profile, project or community) that they collections hang off of.

startFrom - index of the list to start from (0 for start)

pageSize - maximum number of elements to return

Returns:

a list of collections

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

getCollection

Collection getCollection(String userId,
                         String collectionGUID)
                  throws InvalidParameterException,
                         PropertyServerException,
                         UserNotAuthorizedException

Return the properties of a specific collection.

Parameters:

userId - userId of user making request.

collectionGUID - unique identifier of the required connection.

Returns:

collection properties

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createCollection

Collection createCollection(String userId,
                            String qualifiedName,
                            String displayName,
                            String description,
                            String collectionUse,
                            Map<String,Object> additionalProperties)
                     throws InvalidParameterException,
                            PropertyServerException,
                            UserNotAuthorizedException

Create a new generic collection.

Parameters:

userId - userId of user making request.

qualifiedName - unique name of the collection.

displayName - short displayable name for the collection.

description - description of the collection.

collectionUse - description of how the collection is to be used.

additionalProperties - additional arbitrary properties.

Returns:

the newly created Collection

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createFolder

Collection createFolder(String userId,
                        String qualifiedName,
                        String displayName,
                        String description,
                        String collectionUse,
                        CollectionOrder collectionOrder,
                        Map<String,Object> additionalProperties)
                 throws InvalidParameterException,
                        PropertyServerException,
                        UserNotAuthorizedException

Create a collection that acts like a folder with an order.

Parameters:

userId - userId of user making request.

qualifiedName - unique name of the collection.

displayName - short displayable name for the collection.

description - description of the collection.

collectionUse - description of how the collection will be used.

collectionOrder - description of how the members in the collection should be organized.

additionalProperties - additional arbitrary properties.

Returns:

the newly created Collection

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

createSet

Collection createSet(String userId,
                     String qualifiedName,
                     String displayName,
                     String description,
                     String collectionUse,
                     Map<String,Object> additionalProperties)
              throws InvalidParameterException,
                     PropertyServerException,
                     UserNotAuthorizedException

Create a collection that acts like a set (this does not allow duplicate entries).

Parameters:

userId - userId of user making request.

qualifiedName - unique name of the collection.

displayName - short displayable name for the collection.

description - description of the collection.

collectionUse - description of how the collection will be used.

additionalProperties - additional arbitrary properties.

Returns:

the newly created Collection

Throws:

InvalidParameterException - one of the parameters is invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

attachCollection

void attachCollection(String userId,
                      String collectionGUID,
                      String anchorGUID)
               throws InvalidParameterException,
                      PropertyServerException,
                      UserNotAuthorizedException

Connect an existing collection to an anchor point.

Parameters:

userId - userId of user making request.

collectionGUID - unique identifier of the collection.

anchorGUID - unique identifier of referenceable object that the collection should be attached to.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

detachCollection

void detachCollection(String userId,
                      String collectionGUID,
                      String anchorGUID)
               throws InvalidParameterException,
                      PropertyServerException,
                      UserNotAuthorizedException

Detach an existing collection from an anchor point.

Parameters:

userId - userId of user making request.

collectionGUID - unique identifier of the collection.

anchorGUID - unique identifier of referenceable object that the collection should be attached to.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.

removeCollection

void removeCollection(String userId,
                      String collectionGUID)
               throws InvalidParameterException,
                      PropertyServerException,
                      UserNotAuthorizedException

Delete a collection (the members are not affected).

Parameters:

userId - userId of user making request.

collectionGUID - unique identifier of the collection.

Throws:

InvalidParameterException - one of the parameters is null or invalid.

PropertyServerException - there is a problem retrieving information from the property server(s).

UserNotAuthorizedException - the requesting user is not authorized to issue this request.