Index (collection-manager-server 5.2.1 API)

A C D E F G H I O R S T U V
All Classes and Interfaces|All Packages

A

addToCollection(String, String, String, CollectionMembershipProperties) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Add an element to a collection.
attachCollection(String, String, String, boolean, ResourceListProperties) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Connect an existing collection to an element using the ResourceList relationship (0019).

C

CollectionManagerAdmin - Class in org.odpi.openmetadata.viewservices.collectionmanager.admin: CollectionManagerAdmin is the class that is called by the View Server to initialize and terminate the Collection Manager OMVS.
CollectionManagerAdmin() - Constructor for class org.odpi.openmetadata.viewservices.collectionmanager.admin.CollectionManagerAdmin: Default constructor
CollectionManagerAuditCode - Enum Class in org.odpi.openmetadata.viewservices.collectionmanager.ffdc: The CollectionManagerAuditCode is used to define the message content for the OMRS Audit Log.
CollectionManagerInstance - Class in org.odpi.openmetadata.viewservices.collectionmanager.server: CollectionManagerInstance caches references to objects it needs for a specific server.
CollectionManagerInstance(String, AuditLog, String, int, String, String) - Constructor for class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerInstance: Set up the Collection Manager OMVS instance
CollectionManagerInstanceHandler - Class in org.odpi.openmetadata.viewservices.collectionmanager.server: CollectionManagerInstanceHandler retrieves information from the instance map for the view service instances.
CollectionManagerInstanceHandler() - Constructor for class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerInstanceHandler: Default constructor registers the view service
CollectionManagerRegistration - Class in org.odpi.openmetadata.viewservices.collectionmanager.server: CollectionManagerRegistration registers the view service with the OMAG Server administration services.
CollectionManagerRegistration() - Constructor for class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRegistration
CollectionManagerRESTServices - Class in org.odpi.openmetadata.viewservices.collectionmanager.server: The CollectionManagerRESTServices provides the implementation of the Collection Manager Open Metadata View Service (OMVS).
CollectionManagerRESTServices() - Constructor for class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Default constructor
createCollection(String, String, NewCollectionRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Create a new generic collection.
createCollectionFromTemplate(String, TemplateRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Create a new metadata element to represent a collection using an existing metadata element as a template.
createDataSpecCollection(String, NewCollectionRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Create a new collection with the DataSpecCollection classification.
createDigitalProduct(String, NewDigitalProductRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Create a new collection that represents a digital product.
createFolderCollection(String, NewCollectionRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Create a new collection with the Folder classification.
createRootCollection(String, NewCollectionRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Create a new collection with the RootCollection classification.

D

deleteCollection(String, String, NullRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Delete a collection.
detachCollection(String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Detach an existing collection from an element.

E

equals(Object) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.rest.TemplateRequestBody: Equals method that returns true if containing properties are the same.

F

findCollections(String, boolean, boolean, boolean, int, int, FilterRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Returns the list of collections matching the search string - this is coded as a regular expression.

G

getAttachedCollections(String, String, int, int, FilterRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Returns the list of collections that are linked off of the supplied element.
getClassifiedCollections(String, int, int, FilterRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Returns the list of collections with a particular classification.
getCollection(String, String) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Return the properties of a specific collection.
getCollectionMembers(String, String, int, int) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Return a list of elements that are a member of a collection.
getCollectionsByName(String, int, int, FilterRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Returns the list of collections with a particular name.
getCollectionsByType(String, int, int, FilterRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Returns the list of collections with a particular collectionType.
getCollectionsClient() - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerInstance: Return the collection management client.
getCollectionsClient(String, String, String) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerInstanceHandler: This method returns the object for the tenant to use to work with the Digital Service API.
getConnectedAssetClient() - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerInstance: Return the connected asset client.
getConnectedAssetClient(String, String, String) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerInstanceHandler: This method returns the object for the tenant to use to work with the Digital Service API.
getMessageDefinition() - Method in enum class org.odpi.openmetadata.viewservices.collectionmanager.ffdc.CollectionManagerAuditCode: Retrieve a message definition object for logging.
getMessageDefinition(String...) - Method in enum class org.odpi.openmetadata.viewservices.collectionmanager.ffdc.CollectionManagerAuditCode: Retrieve a message definition object for logging.
getOpenMetadataStoreClient() - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerInstance: Return the open metadata store client.
getOpenMetadataStoreClient(String, String, String) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerInstanceHandler: This method returns the object for the tenant to use to work with the Digital Service API.
getPlaceholderPropertyValues() - Method in class org.odpi.openmetadata.viewservices.collectionmanager.rest.TemplateRequestBody: Return the property values to replace placeholders in the template.
getReplacementProperties() - Method in class org.odpi.openmetadata.viewservices.collectionmanager.rest.TemplateRequestBody: Return the properties for the new metadata element.
getTemplateGUID() - Method in class org.odpi.openmetadata.viewservices.collectionmanager.rest.TemplateRequestBody: Returns the unique identifier of the element to use as a template (optional).

H

hashCode() - Method in class org.odpi.openmetadata.viewservices.collectionmanager.rest.TemplateRequestBody: Return hash code for this object

I

initialize(String, ViewServiceConfig, AuditLog, String, int) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.admin.CollectionManagerAdmin: Initialize the Collection Manager view service.

O

org.odpi.openmetadata.viewservices.collectionmanager.admin - package org.odpi.openmetadata.viewservices.collectionmanager.admin: The admin package controls the start-up and shutdown of the view service.
org.odpi.openmetadata.viewservices.collectionmanager.ffdc - package org.odpi.openmetadata.viewservices.collectionmanager.ffdc: This package provides the definition of the error handling for the Collection Manager OMVS.
org.odpi.openmetadata.viewservices.collectionmanager.rest - package org.odpi.openmetadata.viewservices.collectionmanager.rest: This package defines the beans used to build the REST request and response payloads.
org.odpi.openmetadata.viewservices.collectionmanager.server - package org.odpi.openmetadata.viewservices.collectionmanager.server

R

registerViewService() - Static method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRegistration: Pass information about this view service to the OMAG Server administration services.
removeFromCollection(String, String, String, NullRequestBody) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Remove an element from a collection.

S

SERVICE_INITIALIZED - Enum constant in enum class org.odpi.openmetadata.viewservices.collectionmanager.ffdc.CollectionManagerAuditCode: OMVS-COLLECTION-MANAGER-0002 The Collection Manager Open Metadata View Service (OMVS) is initialized
SERVICE_INITIALIZING - Enum constant in enum class org.odpi.openmetadata.viewservices.collectionmanager.ffdc.CollectionManagerAuditCode: OMVS-COLLECTION-MANAGER-0001 The Collection Manager Open Metadata View Service (OMVS) is initializing
SERVICE_INSTANCE_FAILURE - Enum constant in enum class org.odpi.openmetadata.viewservices.collectionmanager.ffdc.CollectionManagerAuditCode: OMVS-COLLECTION-MANAGER-0004 The Collection Manager Open Metadata View Service (OMVS) is unable to initialize a new instance; error message is {0}
SERVICE_SHUTDOWN - Enum constant in enum class org.odpi.openmetadata.viewservices.collectionmanager.ffdc.CollectionManagerAuditCode: OMVS-COLLECTION-MANAGER-0003 The Collection Manager Open Metadata View Service (OMVS) is shutting down
SERVICE_TERMINATING - Enum constant in enum class org.odpi.openmetadata.viewservices.collectionmanager.ffdc.CollectionManagerAuditCode: OMVS-COLLECTION-MANAGER-0005 The Collection Manager Open Metadata View Service (OMVS) is shutting down server instance {0}
setPlaceholderPropertyValues(Map<String, String>) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.rest.TemplateRequestBody: Set up the property values to replace placeholders in the template.
setReplacementProperties(ElementProperties) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.rest.TemplateRequestBody: Set up the properties for the new metadata element.
setTemplateGUID(String) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.rest.TemplateRequestBody: Set up the unique identifier of the element to use as a template (optional).
shutdown() - Method in class org.odpi.openmetadata.viewservices.collectionmanager.admin.CollectionManagerAdmin: Shutdown the Collection Manager service.

T

TemplateRequestBody - Class in org.odpi.openmetadata.viewservices.collectionmanager.rest: TemplateRequestBody provides a structure for passing the properties for a new metadata element that is to be created via a template.
TemplateRequestBody() - Constructor for class org.odpi.openmetadata.viewservices.collectionmanager.rest.TemplateRequestBody: Default constructor
TemplateRequestBody(TemplateRequestBody) - Constructor for class org.odpi.openmetadata.viewservices.collectionmanager.rest.TemplateRequestBody: Copy/clone constructor
toString() - Method in enum class org.odpi.openmetadata.viewservices.collectionmanager.ffdc.CollectionManagerAuditCode: JSON-style toString

U

UNEXPECTED_EXCEPTION - Enum constant in enum class org.odpi.openmetadata.viewservices.collectionmanager.ffdc.CollectionManagerAuditCode: OMVS-COLLECTION-MANAGER-0006 The Open Metadata Service has generated an unexpected {0} exception during method {1}.
updateCollection(String, String, boolean, CollectionProperties) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Update the properties of a collection.
updateCollectionMembership(String, String, String, boolean, CollectionMembershipProperties) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Update an element's membership to a collection.
updateDigitalProduct(String, String, boolean, DigitalProductProperties) - Method in class org.odpi.openmetadata.viewservices.collectionmanager.server.CollectionManagerRESTServices: Update the properties of the DigitalProduct classification attached to a collection.

V

valueOf(String) - Static method in enum class org.odpi.openmetadata.viewservices.collectionmanager.ffdc.CollectionManagerAuditCode: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.odpi.openmetadata.viewservices.collectionmanager.ffdc.CollectionManagerAuditCode: Returns an array containing the constants of this enum class, in the order they are declared.

A C D E F G H I O R S T U V
All Classes and Interfaces|All Packages