A C D E F G H I L M N O P R S T U V

A

addCommentReply(String, String, String, CommentType, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface

Adds a comment to another comment.

addCommentToAsset(String, String, CommentType, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface

Adds a comment to the asset.

addLikeToAsset(String, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface

Adds a "LikeProperties" to the asset.

addLogMessageToAsset(String, String, String, String, String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerLoggingInterface

Creates an Audit log record about the asset.

addRatingToAsset(String, String, StarRating, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface

Adds a star rating and optional review text to the asset.

addTagToAsset(String, String, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Adds a tag (either private of public) to an asset.

addTagToElement(String, String, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Adds a tag (either private of public) to an element attached to an asset - such as schema element, glossary term, ...

AssetConsumerAssetInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api

AssetConsumerAssetInterface supports queries to retrieve information about an asset.

AssetConsumerAuditCode - Enum in org.odpi.openmetadata.accessservices.assetconsumer.ffdc

The AssetConsumerAuditCode is used to define the message content for the OMRS Audit Log.

AssetConsumerConnectorFactoryInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api

AssetConsumerConnectorFactoryInterface is used by applications and tools as a factory for Open Connector Framework (OCF) connectors.

AssetConsumerErrorCode - Enum in org.odpi.openmetadata.accessservices.assetconsumer.ffdc

The AssetConsumerErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with the Asset Consumer OMAS Services.

AssetConsumerEvent - Class in org.odpi.openmetadata.accessservices.assetconsumer.events

AssetConsumerEvent provides a common base for all events from the access service.

AssetConsumerEventInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api

AssetConsumerEventInterface defines how a client gets access to the events produced by the Asset Consumer OMAS

AssetConsumerEventListener - Class in org.odpi.openmetadata.accessservices.assetconsumer.api

AssetConsumerEventListener is the interface that a client implements to register to receive the events from the Asset Consumer OMAS.

AssetConsumerEventListener() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerEventListener

AssetConsumerEventType - Enum in org.odpi.openmetadata.accessservices.assetconsumer.events

AssetConsumerEventType describes the different types of events produced by the Asset Consumer OMAS.

AssetConsumerFeedbackInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api

AssetConsumerFeedbackInterface supports the ability to add and remove feedback for an asset.

AssetConsumerGlossaryInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api

AssetConsumerGlossaryInterface supports the lookup of the meaning of a glossary term.

AssetConsumerLoggingInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api

AssetConsumerLoggingInterface supports the ability to add log messages to the local server's audit log about an asset.

AssetConsumerOMASAPIRequestBody - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest

AssetConsumerOMASAPIRequestBody provides a common header for Asset Consumer OMAS request bodies for its REST API.

AssetConsumerOMASAPIRequestBody() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIRequestBody

Default constructor

AssetConsumerOMASAPIRequestBody(AssetConsumerOMASAPIRequestBody) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIRequestBody

Copy/clone constructor

AssetConsumerOMASAPIResponse - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest

AssetConsumerOMASAPIResponse provides a common header for Asset Consumer OMAS managed rest to its REST API.

AssetConsumerOMASAPIResponse() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse

Default constructor

AssetConsumerOMASAPIResponse(AssetConsumerOMASAPIResponse) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse

Copy/clone constructor

AssetConsumerOutTopicClientConnector - Class in org.odpi.openmetadata.accessservices.assetconsumer.connectors

AssetConsumerOutTopicClientConnector is the java implementation of the the client side connector that receives events from the Asset Consumer OMAS's out topic

AssetConsumerOutTopicClientConnector() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.connectors.AssetConsumerOutTopicClientConnector

AssetConsumerTaggingInterface - Interface in org.odpi.openmetadata.accessservices.assetconsumer.api

AssetConsumerTaggingInterface support the management and use of informal tags, whether public or private.

AssetElement - Class in org.odpi.openmetadata.accessservices.assetconsumer.elements

AssetElement contains the properties and header for an asset retrieved from the metadata repository.

AssetElement() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.AssetElement

Default constructor

AssetElement(AssetElement) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.AssetElement

Copy/clone constructor

AssetEvent - Class in org.odpi.openmetadata.accessservices.assetconsumer.events

AssetEvent describes the structure of the events emitted by the Asset Consumer OMAS that are about assets.

AssetEvent() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent

Default constructor

AssetEvent(AssetEvent) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent

Copy/clone constructor

AssetProperties - Class in org.odpi.openmetadata.accessservices.assetconsumer.properties

Asset holds asset properties that are used for displaying details of an asset in summary lists or hover text.

AssetProperties() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Default constructor

AssetProperties(AssetProperties) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Copy/clone constructor.

C

CommentElement - Class in org.odpi.openmetadata.accessservices.assetconsumer.elements

CommentElement contains the properties and header for a comment entity retrieved from the metadata repository.

CommentElement() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.CommentElement

Default constructor

CommentElement(CommentElement) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.CommentElement

Copy/clone constructor

CommentProperties - Class in org.odpi.openmetadata.accessservices.assetconsumer.properties

The CommentProperties bean stores information about a comment connected to an asset.

CommentProperties() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Default constructor

CommentProperties(CommentProperties) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Copy/clone constructor.

CommentType - Enum in org.odpi.openmetadata.accessservices.assetconsumer.properties

The CommentType allows comments to be used to ask and answer questions as well as make suggestions and provide useful information to other users.

createPrivateTag(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Creates a new private informal tag and returns the unique identifier for it.

createPublicTag(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Creates a new public informal tag and returns the unique identifier for it.

D

deleteTag(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Removes a tag from the repository.

E

ElementClassification - Class in org.odpi.openmetadata.accessservices.assetconsumer.elements

The ElementClassification bean describes a single classification associated with an element.

ElementClassification() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementClassification

Default constructor

ElementClassification(ElementClassification) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementClassification

Copy/clone constructor

ElementHeader - Class in org.odpi.openmetadata.accessservices.assetconsumer.elements

ElementHeader provides the common identifier and type information for all properties objects that link off of the asset and have a guid associated with them.

ElementHeader() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Default constructor used by subclasses

ElementHeader(ElementHeader) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Copy/clone constructor.

ElementOrigin - Class in org.odpi.openmetadata.accessservices.assetconsumer.elements

The ElementType bean provides details of the type information associated with a metadata element.

ElementOrigin() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Default constructor

ElementOrigin(ElementOrigin) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Copy/clone constructor

ElementOriginCategory - Enum in org.odpi.openmetadata.accessservices.assetconsumer.elements

ElementOriginCategory defines where the metadata comes from.

ElementType - Class in org.odpi.openmetadata.accessservices.assetconsumer.elements

The ElementType bean provides details of the type information associated with a metadata element.

ElementType() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Default constructor

ElementType(ElementType) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Copy/clone constructor

ENUM_TYPE_GUID - Static variable in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType

ENUM_TYPE_GUID - Static variable in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.OwnerType

ENUM_TYPE_GUID - Static variable in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating

ENUM_TYPE_NAME - Static variable in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType

ENUM_TYPE_NAME - Static variable in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.OwnerType

ENUM_TYPE_NAME - Static variable in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.AssetElement

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.CommentElement

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementClassification

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.LikeElement

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.RatingElement

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.LikeProperties

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.MeaningProperties

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Equals method that returns true if containing properties are the same.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.SecurityTagsProperties

Compare the values of the supplied object with those stored in the current object.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.FeedbackRequestBody

Equals method that returns true if containing properties are the same.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermListResponse

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermResponse

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Equals method that returns true if containing properties are the same.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.PagedResponse

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse

Return comparison result based on the content of the properties.

equals(Object) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagsResponse

Return comparison result based on the content of the properties.

F

FeedbackRequestBody - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest

FeedbackRequestBody provides a base class for passing feedback objects as a request body over a REST API.

FeedbackRequestBody() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.FeedbackRequestBody

Default constructor

FeedbackRequestBody(FeedbackRequestBody) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.FeedbackRequestBody

Copy/clone constructor

findAssets(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface

Return a list of assets with the requested search string in their name, qualified name or description.

findMeanings(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface

Return the full definition (meaning) of the terms matching the supplied name.

findMyTags(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Return the list of the calling user's private tags containing the supplied string in either the name or description.

findTags(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Return the list of tags containing the supplied string in either the name or description.

G

getAdditionalProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Return a copy of the additional properties.

getAsset() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent

Return the asset description.

getAssetForConnection(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface

Returns the unique identifier for the asset connected to the requested connection.

getAssetForConnectionName(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface

Returns the asset corresponding to the supplied connection name.

getAssetProperties(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface

Returns a comprehensive collection of properties about the requested asset.

getAssetProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.AssetElement

Retrieve details of the asset itself.

getAssetsByMeaning(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface

Return the list of unique identifiers for assets that are linked to a specific (meaning) either directly or via fields in the schema.

getAssetsByName(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface

Return a list of assets with the requested name.

getAssetsByTag(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Return the list of unique identifiers for assets that are linked to a specific tag either directly, or via one of its schema elements.

getAssetsByToken(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerAssetInterface

Returns a list of assets that match the token which may be the GUID or the qualified name.

getClassificationName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementClassification

Return the name of the classification

getClassificationProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementClassification

Return a collection of the additional stored properties for the classification.

getClassifications() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Return the list of classifications associated with the metadata element.

getCommentProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.CommentElement

Return the properties for the comment.

getCommentText() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Return the comment text.

getCommentType() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Return an enum that describes the type of comment.

getConnectionName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Return the name of the connection used to create the connector making the log request.

getConnectorByConnection(String, Connection) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerConnectorFactoryInterface

Returns the connector corresponding to the supplied connection.

getConnectorByGUID(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerConnectorFactoryInterface

Returns the connector corresponding to the supplied connection GUID.

getConnectorByName(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerConnectorFactoryInterface

Returns the connector corresponding to the supplied connection name.

getConnectorForAsset(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerConnectorFactoryInterface

Returns the connector corresponding to the supplied asset GUID.

getConnectorInstanceId() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Return the instance id of the connector making the log record.

getConnectorType() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Return the type of connector making the log record.

getContextId() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Return the function name, or processId of the activity that the caller is performing.

getCreationTime() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.NewAssetEvent

Return the time that the asset was created.

getDescription() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOriginCategory

Return the description of the metadata element origin.

getDescription() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Returns the stored description property for the asset.

getDescription() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType

Return the default description for the star rating for this enum instance.

getDescription() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Return the tag description null means no description is available.

getDescription() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.MeaningProperties

Return the description of the glossary term.

getDescription() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.OwnerType

Return the default description of the enumeration.

getDescription() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating

Return the default description for the star rating for this enum instance.

getDisplayName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Returns the stored display name property for the asset.

getElementHeader() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.AssetElement

Return the element header associated with the properties.

getElementHeader() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.CommentElement

Return the element header associated with the properties.

getElementHeader() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement

Return the element header associated with the properties.

getElementHeader() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.LikeElement

Return the element header associated with the properties.

getElementHeader() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement

Return the element header associated with the properties.

getElementHeader() - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.elements.MetadataElement

Return the element header associated with the properties.

getElementHeader() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.RatingElement

Return the element header associated with the properties.

getEventType() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent

Return the type of event.

getEventTypeCode() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType

Return the int identifier used for indexing based on the enum.

getEventTypeDescription() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType

Return the default description for the enum value - used when natural resource bundle is not available.

getEventTypeName() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType

Return the string name used for messages that include the enum.

getEventVersionId() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent

Return the event version id for this event structure.

getExtendedProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Return the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.

getGUID() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Return the unique id for the properties object.

getHomeMetadataCollectionId() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Returns the OMRS identifier for the metadata collection that is managed by the repository where the element originates (its home repository).

getHomeMetadataCollectionName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Return the name of the metadata collection that this asset belongs to.

getInformalTagProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement

Return the properties of the informal tag.

getIsPrivateTag() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Return boolean flag to say whether the tag is private or not.

getIsPublic() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Return whether the comment is private to the creating user or not.

getIsPublic() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Return if the link to the tag is private to the creating user.

getIsPublic() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.LikeProperties

Return if this like is private to the creating user.

getIsPublic() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.FeedbackRequestBody

Return whether the feedback is private or not

getLicense() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Return the license associated with this metadata element (null means none).

getLikeProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.LikeElement

Return the properties for the like.

getMeaning(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface

Return the full definition (meaning) of a term using the unique identifier of the glossary term that contains the definition.

getMeaning() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermResponse

Return the glossary term object.

getMeaningByName(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerGlossaryInterface

Return the full definition (meaning) of the terms exactly matching the supplied name.

getMeaningProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement

Return the properties for a meaning.

getMeanings() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Return the assigned meanings for this metadata entity.

getMeanings() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermListResponse

Return the list of glossary terms in the response.

getMessage() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Return the actual log message.

getMessageDefinition() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode

Retrieve a message definition object for logging.

getMessageDefinition(String...) - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode

Retrieve a message definition object for logging.

getMessageDefinition() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode

Retrieve a message definition object for an exception.

getMessageDefinition(String...) - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode

Retrieve a message definition object for an exception.

getMyTagsByName(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Return the list of the calling user's private tags exactly matching the supplied name.

getName() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOriginCategory

Return the name of the metadata element origin.

getName() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType

Return the default type name for this enum instance.

getName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Return the name of the tag.

getName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.MeaningProperties

Return the glossary term name.

getName() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.OwnerType

Return the default name of the enumeration.

getName() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating

Return the default symbol for this enum instance.

getOpenTypeGUID() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType

Return the unique identifier for the open metadata enum type that this enum class represents.

getOpenTypeGUID() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.OwnerType

Return the unique identifier for the open metadata enum type that this enum class represents.

getOpenTypeGUID() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating

Return the unique identifier for the open metadata enum type that this enum class represents.

getOpenTypeName() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType

Return the unique name for the open metadata enum type that this enum class represents.

getOpenTypeName() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.OwnerType

Return the unique name for the open metadata enum type that this enum class represents.

getOpenTypeName() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating

Return the unique name for the open metadata enum type that this enum class represents.

getOpenTypeOrdinal() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType

Return the code for this enum that comes from the Open Metadata Type that this enum represents.

getOpenTypeOrdinal() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.OwnerType

Return the code for this enum that comes from the Open Metadata Type that this enum represents.

getOpenTypeOrdinal() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating

Return the code for this enum that comes from the Open Metadata Type that this enum represents.

getOrdinal() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOriginCategory

Return the code for metadata element.

getOrdinal() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType

Return the code for this enum instance

getOrdinal() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.OwnerType

Return the numeric representation of the enumeration.

getOrdinal() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating

Return the code for this enum instance

getOrigin() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Return information about the origin of the element.

getOriginalAsset() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent

Return the original values of the Asset before the update.

getOriginBusinessCapabilityGUID() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Return the unique identifier of the business capability that originated this asset.

getOriginCategory() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Return the origin of the metadata element.

getOriginOrganizationGUID() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Return the unique identifier for the organization that originated this asset.

getOtherOriginValues() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Return the properties that characterize where this asset is from.

getOwner() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Returns the name of the owner for this asset.

getOwnerPropertyName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Returns the property name used to identify the owner for this asset.

getOwnerType() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Deprecated.

getOwnerTypeName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Returns the name of the type used to identify of the owner for this asset.

getQualifiedName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Returns the stored qualified name property for the metadata entity.

getRatingProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.RatingElement

Return the properties for the rating.

getReview() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Return the review comments - null means no review is available.

getSecurityLabels() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.SecurityTagsProperties

Return the list of security labels attached to the element.

getSecurityProperties() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.SecurityTagsProperties

Return the security properties associated with the element.

getSecurityTags() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Return the information used by security engines to secure access to the asset's content.

getSourceServer() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Return the name of the server where the element was retrieved from.

getStarRating() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Return the stars for the rating.

getStartingFromElement() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermListResponse

Return the starting element number from the server side list that this response contains.

getStartingFromElement() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.PagedResponse

Return the starting element number from the server side list that this response contains.

getSuperTypeNames() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Return the list of type names for this type's supertypes.

getTag(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Return the tag for the supplied unique identifier (guid).

getTag() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse

Return the Tag object.

getTags() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagsResponse

Return the list of informal tags in the response.

getTagsByName(String, String, int, int) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Return the list of tags exactly matching the supplied name.

getType() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Return the element type properties for this properties object.

getTypeDescription() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Return the description for this element's type.

getTypeId() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Return unique identifier for the element's type.

getTypeName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Return name of element's type.

getTypeName() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Return the open metadata type name of this object - this is used to create a subtype of the referenceable.

getTypeVersion() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Return the version number for this element's type.

getUpdateTime() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent

Return the time that the asset was updated.

getUser() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Return the user id of the person who created the comment.

getUser() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Return the user id of the person who created the tag.

getUser() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.LikeProperties

Return the user id of the person who created the like.

getUser() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Return the user id of the person who created the rating.

getZoneMembership() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Return the names of the zones that this asset is a member of.

GlossaryTermListResponse - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest

GlossaryTermListResponse returns a list of meanings from the server.

GlossaryTermListResponse() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermListResponse

Default constructor

GlossaryTermListResponse(GlossaryTermListResponse) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermListResponse

Copy/clone constructor

GlossaryTermResponse - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest

GlossaryTermResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns a Glossary Term object as a response.

GlossaryTermResponse() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermResponse

Default constructor

GlossaryTermResponse(GlossaryTermResponse) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermResponse

Copy/clone constructor

H

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.AssetElement

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.CommentElement

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementClassification

Create a hash code for this element type.

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Create a hash code for this element type.

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Create a hash code for this element type.

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Create a hash code for this element type.

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.LikeElement

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.RatingElement

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Return has code based on properties.

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Create a hash code for this element type.

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.LikeProperties

Create a hash code for this element type.

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.MeaningProperties

Create a hash code for this element type.

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.SecurityTagsProperties

Create a hash code for this element type.

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.FeedbackRequestBody

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermListResponse

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermResponse

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.PagedResponse

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse

Return hash code for this object

hashCode() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagsResponse

Return hash code for this object

I

InformalTagElement - Class in org.odpi.openmetadata.accessservices.assetconsumer.elements

InformalTagElement contains the properties and header for a InformalTag entity retrieved from the metadata repository.

InformalTagElement() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement

Default constructor

InformalTagElement(InformalTagElement) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement

Copy/clone constructor

InformalTagProperties - Class in org.odpi.openmetadata.accessservices.assetconsumer.properties

InformalTagProperties stores information about a tag connected to an asset.

InformalTagProperties() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Default constructor

InformalTagProperties(InformalTagProperties) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Copy/clone constructor.

isPublic() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Return if this rating is private ot the creating user.

L

LikeElement - Class in org.odpi.openmetadata.accessservices.assetconsumer.elements

LikeElement contains the properties and header for a Like entity retrieved from the metadata repository.

LikeElement() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.LikeElement

Default constructor

LikeElement(LikeElement) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.LikeElement

Copy/clone constructor

LikeProperties - Class in org.odpi.openmetadata.accessservices.assetconsumer.properties

The LikeProperties properties object records a single user's "like" of an asset.

LikeProperties() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.LikeProperties

Default constructor

LikeProperties(LikeProperties) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.LikeProperties

Copy/clone constructor.

LogRecordRequestBody - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest

LogRecordRequestBody provides a structure for passing a log record as a request body over a REST API.

LogRecordRequestBody() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Default constructor

LogRecordRequestBody(LogRecordRequestBody) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Copy/clone constructor

M

MeaningElement - Class in org.odpi.openmetadata.accessservices.assetconsumer.elements

MeaningElement contains the properties and header for a GlossaryTerm entity retrieved from the metadata repository.

MeaningElement() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement

Default constructor

MeaningElement(MeaningElement) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement

Copy/clone constructor

MeaningProperties - Class in org.odpi.openmetadata.accessservices.assetconsumer.properties

MeaningProperties is a cut-down summary of a glossary term to aid the asset consumer in understanding the content of an asset.

MeaningProperties() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.MeaningProperties

Default constructor

MeaningProperties(MeaningProperties) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.MeaningProperties

Copy/clone constructor.

MetadataElement - Interface in org.odpi.openmetadata.accessservices.assetconsumer.elements

MetadataElement is the common interface for all metadata elements.

N

NewAssetEvent - Class in org.odpi.openmetadata.accessservices.assetconsumer.events

NewAssetEvent describes the payload sent when a new Asset is added to the cohort metadata repository.

NewAssetEvent() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.NewAssetEvent

Default constructor

NewAssetEvent(NewAssetEvent) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.NewAssetEvent

Copy/clone constructor

O

org.odpi.openmetadata.accessservices.assetconsumer.api - package org.odpi.openmetadata.accessservices.assetconsumer.api

The API package defines the Java interfaces supported by the Asset Consumer OMAS.

org.odpi.openmetadata.accessservices.assetconsumer.connectors - package org.odpi.openmetadata.accessservices.assetconsumer.connectors

org.odpi.openmetadata.accessservices.assetconsumer.elements - package org.odpi.openmetadata.accessservices.assetconsumer.elements

The metadata elements describe the way that metadata is returned from the repository.

org.odpi.openmetadata.accessservices.assetconsumer.events - package org.odpi.openmetadata.accessservices.assetconsumer.events

This package defines the event payloads sent on the Asset Consumer OMAS's out topic.

org.odpi.openmetadata.accessservices.assetconsumer.ffdc - package org.odpi.openmetadata.accessservices.assetconsumer.ffdc

This package provides the first failure data capture support for the Asset Consumer OMAS module.

org.odpi.openmetadata.accessservices.assetconsumer.properties - package org.odpi.openmetadata.accessservices.assetconsumer.properties

These beans describe the core properties that are passed to the server to create and update metadata.

org.odpi.openmetadata.accessservices.assetconsumer.rest - package org.odpi.openmetadata.accessservices.assetconsumer.rest

This package defines the beans used to build the REST request payloads.

OwnerType - Enum in org.odpi.openmetadata.accessservices.assetconsumer.properties

OwnerType defines the identifier used in an Asset's owner property.

P

PagedResponse - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest

PagedResponse is used for responses that can contain paged responses

PagedResponse() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.PagedResponse

Default constructor

PagedResponse(PagedResponse) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.PagedResponse

Copy/clone constructor

processEvent(AssetConsumerEvent) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerEventListener

Process an event that was published by the Asset Consumer OMAS.

R

RatingElement - Class in org.odpi.openmetadata.accessservices.assetconsumer.elements

RatingElement contains the properties and header for a Rating entity retrieved from the metadata repository.

RatingElement() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.RatingElement

Default constructor

RatingElement(RatingElement) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.elements.RatingElement

Copy/clone constructor

RatingProperties - Class in org.odpi.openmetadata.accessservices.assetconsumer.properties

RatingProperties stores information about a rating connected to an asset.

RatingProperties() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Default constructor

RatingProperties(RatingProperties) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Copy/clone constructor.

ReferenceableProperties - Class in org.odpi.openmetadata.accessservices.assetconsumer.properties

ReferenceableProperties provides a structure for passing a referenceables' properties over the Java API.

ReferenceableProperties() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Default constructor

ReferenceableProperties(ReferenceableProperties) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Copy/clone constructor

registerListener(String, AssetConsumerEventListener) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerEventInterface

Register a listener object that will be passed each of the events published by the Asset Consumer OMAS.

registerListener(String, AssetConsumerEventListener) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.connectors.AssetConsumerOutTopicClientConnector

Register a listener object that will be passed each of the events published by the Asset Consumer OMAS.

removeComment(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface

Removes a comment added to the asset by this user.

removeLikeFromAsset(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface

Removes a "LikeProperties" added to the asset by this user.

removeRatingFromAsset(String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface

Removes of a review that was added to the asset by this user.

removeTagFromAsset(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Removes a tag from the asset that was added by this user.

removeTagFromElement(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Removes a tag from an element attached to an asset - such as schema element, glossary term, ...

S

SecurityTagsProperties - Class in org.odpi.openmetadata.accessservices.assetconsumer.properties

SecurityTagsProperties holds the list of labels and properties used by a security enforcement engine to control access and visibility to the contents of the real-world object described by the Referenceable.

SecurityTagsProperties() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.SecurityTagsProperties

Default constructor

SecurityTagsProperties(SecurityTagsProperties) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.properties.SecurityTagsProperties

Copy/clone constructor

setAdditionalProperties(Map<String, String>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Set up additional properties.

setAsset(Asset) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent

Set up the asset description.

setAssetProperties(AssetProperties) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.AssetElement

Save details of the asset itself

setClassificationName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementClassification

Set up the name of the classification.

setClassificationProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementClassification

Set up a collection of the additional stored properties for the classification.

setClassifications(List<ElementClassification>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Set up the classifications associated with this metadata element.

setCommentProperties(CommentProperties) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.CommentElement

Set up the properties for the comment.

setCommentText(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Set up the comment text.

setCommentType(CommentType) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Set up the enum that describes the type of comment.

setConnectionName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Set up the name of the connection used to create the connector making the log request.

setConnectorInstanceId(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Set up the instance id of the connector making the log record.

setConnectorType(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Set up the type of connector making the log record.

setContextId(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Set up the function name, or processId of the activity that the caller is performing.

setCreationTime(Date) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.NewAssetEvent

Set up the time that the asset was created.

setDescription(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Set up the stored description property associated with the asset.

setDescription(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Set up the tag description null means no description is available.

setDescription(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.MeaningProperties

Set up the description of the glossary term.

setDisplayName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Set up the stored display name property for the asset.

setElementHeader(ElementHeader) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.AssetElement

Set up the element header associated with the properties.

setElementHeader(ElementHeader) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.CommentElement

Set up the element header associated with the properties.

setElementHeader(ElementHeader) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement

Set up the element header associated with the properties.

setElementHeader(ElementHeader) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.LikeElement

Set up the element header associated with the properties.

setElementHeader(ElementHeader) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement

Set up the element header associated with the properties.

setElementHeader(ElementHeader) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.elements.MetadataElement

Set up the element header associated with the properties.

setElementHeader(ElementHeader) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.RatingElement

Set up the element header associated with the properties.

setEventType(AssetConsumerEventType) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent

Set up the type of event.

setEventVersionId(long) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent

Set up the event version id for this event structure.

setExtendedProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Set up the properties that are defined for a subtype of referenceable but are not explicitly supported by the bean.

setGUID(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Set up the guid for the element.

setHomeMetadataCollectionId(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Set up the unique identifier for the metadata collection that is managed by the repository where the element originates (its home repository).

setHomeMetadataCollectionName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Set up the name of the metadata collection that this asset belongs to.

setInformalTagProperties(InformalTagProperties) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement

Set up the properties of the informal tag.

setIsPrivateTag(boolean) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Set up boolean flag to say whether the tag is private or not.

setIsPublic(boolean) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Set up whether the comment is private to the creating user or not.

setIsPublic(boolean) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Set up whether the link to the tag is private to the creating user or not.

setIsPublic(boolean) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.LikeProperties

Set up whether the like is private to the creating user or not.

setIsPublic(boolean) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.FeedbackRequestBody

Set up the privacy flag.

setLicense(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Set up the license associated with this metadata element (null means none)

setLikeProperties(LikeProperties) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.LikeElement

Set up the properties for the like.

setMeaning(MeaningElement) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermResponse

Set up the glossary term object.

setMeaningProperties(MeaningProperties) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement

Set up the properties for a meaning.

setMeanings(List<MeaningProperties>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Set up the assigned meanings for this metadata entity.

setMeanings(List<MeaningElement>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermListResponse

Set up the list of glossary terms for the response.

setMessage(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

Set up the actual log message.

setName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Set up the name of the tag.

setName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.MeaningProperties

Set up the glossary term name.

setOrigin(ElementOrigin) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Set up information about the origin of the element.

setOriginalAsset(Asset) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent

Set up details of the original asset - if available.

setOriginBusinessCapabilityGUID(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Set up the unique identifier of the business capability that originated this asset.

setOriginCategory(ElementOriginCategory) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Set up the details of this element's origin.

setOriginOrganizationGUID(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Set up the unique identifier for the organization that originated this asset.

setOtherOriginValues(Map<String, String>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Set up the properties that characterize where this asset is from.

setOwner(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Set up the name of the owner for this asset.

setOwnerPropertyName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Set up the property name used to identify the owner for this asset.

setOwnerType(OwnerType) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Deprecated.

setOwnerTypeName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Set up the name of the type used to identify the owner for this asset.

setPublic(boolean) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Set up whether the rating is private to the creating user or not.

setQualifiedName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Set up the fully qualified name.

setRatingProperties(RatingProperties) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.RatingElement

Set up the properties for the rating.

setReview(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Set up the review comments - null means no review is available.

setSecurityLabels(List<String>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.SecurityTagsProperties

Set up the list of security labels for the element.

setSecurityProperties(Map<String, Object>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.SecurityTagsProperties

Set up the security properties associated with the element.

setSecurityTags(SecurityTagsProperties) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Set up the information used by security engines to secure access to the asset's content.

setSourceServer(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Set up the name of the server where the element was retrieved from.

setStarRating(StarRating) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Set up the stars for the rating.

setStartingFromElement(int) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermListResponse

Set up the starting element number from the server side list that this response contains.

setStartingFromElement(int) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.PagedResponse

Set up the starting element number from the server side list that this response contains.

setSuperTypeNames(List<String>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Set up the list of type names for this type's supertypes.

setTag(InformalTagElement) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse

Set up the Tag object.

setTags(List<InformalTagElement>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagsResponse

Set up the list of informal tags for the response.

setType(ElementType) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Set up the type of this element.

setTypeDescription(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Set up a short description of this element's type.

setTypeId(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Set up the unique identifier for the element's type.

setTypeName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Set up the name of this element's type

setTypeName(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

Set up the open metadata type name of this object - this is used to create a subtype of the referenceable.

setTypeVersion(long) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Set up the version number for this element's type

setUpdateTime(Date) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent

Set up the time that the asset was updated.

setUser(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Set up the user id of the person who created the comment.

setUser(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Set up the user id of the person who created the tag.

setUser(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.LikeProperties

Set up he user id of the person who created the like.

setUser(String) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Set up the user id of the person who created the rating.

setZoneMembership(List<String>) - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Set up the names of the zones that this asset is a member of.

StarRating - Enum in org.odpi.openmetadata.accessservices.assetconsumer.properties

A StarRating defines the rating that a user has placed against an asset.

T

TagResponse - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest

TagResponse is the response structure used on the Asset Consumer OMAS REST API calls that returns a Tag object as a response.

TagResponse() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse

Default constructor

TagResponse(TagResponse) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse

Copy/clone constructor

TagsResponse - Class in org.odpi.openmetadata.accessservices.assetconsumer.rest

TagsResponse returns a list of tags from the server.

TagsResponse() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagsResponse

Default constructor

TagsResponse(TagsResponse) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagsResponse

Copy/clone constructor

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.AssetElement

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.CommentElement

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementClassification

Standard toString method.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementHeader

Standard toString method.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOrigin

Standard toString method.

toString() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOriginCategory

Standard toString method.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementType

Standard toString method.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.InformalTagElement

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.LikeElement

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.MeaningElement

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.elements.RatingElement

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEvent

JSON-style toString

toString() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.AssetEvent

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.NewAssetEvent

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent

JSON-style toString

toString() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode

JSON-style toString

toString() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.AssetProperties

Standard toString method.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentProperties

Standard toString method.

toString() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType

Standard toString method.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.InformalTagProperties

Standard toString method.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.LikeProperties

Standard toString method.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.MeaningProperties

Standard toString method.

toString() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.OwnerType

toString() JSON-style

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.RatingProperties

Standard toString method.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.ReferenceableProperties

JSON-style toString.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.properties.SecurityTagsProperties

Standard toString method.

toString() - Method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating

Standard toString method.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIRequestBody

JSON-like toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.AssetConsumerOMASAPIResponse

JSON-like toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.FeedbackRequestBody

JSON-style toString.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermListResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.GlossaryTermResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.LogRecordRequestBody

JSON-style toString.

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.PagedResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagResponse

JSON-style toString

toString() - Method in class org.odpi.openmetadata.accessservices.assetconsumer.rest.TagsResponse

JSON-style toString

U

updateComment(String, String, String, CommentType, String, boolean) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerFeedbackInterface

Update an existing comment.

UpdatedAssetEvent - Class in org.odpi.openmetadata.accessservices.assetconsumer.events

UpdatedAssetEvent() - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent

Default constructor

UpdatedAssetEvent(UpdatedAssetEvent) - Constructor for class org.odpi.openmetadata.accessservices.assetconsumer.events.UpdatedAssetEvent

Copy/clone constructor

updateTagDescription(String, String, String) - Method in interface org.odpi.openmetadata.accessservices.assetconsumer.api.AssetConsumerTaggingInterface

Updates the description of an existing tag (either private or public).

V

valueOf(String) - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOriginCategory

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.OwnerType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating

Returns the enum constant of this type with the specified name.

values() - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.elements.ElementOriginCategory

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.events.AssetConsumerEventType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerAuditCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.ffdc.AssetConsumerErrorCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.CommentType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.OwnerType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum org.odpi.openmetadata.accessservices.assetconsumer.properties.StarRating

Returns an array containing the constants of this enum type, in the order they are declared.

A C D E F G H I L M N O P R S T U V