All Classes Interface Summary Class Summary Enum Summary Exception Summary
| Class |
Description |
| ActorProfileElement |
The ActorProfileElement describes an individual, system, team or organization.
|
| ActorProfileListResponse |
ActorProfileListResponse is the response structure used on the OMAS REST API calls that return
a list of profile elements.
|
| ActorProfileProperties |
The ActorProfileProperties describes the common properties of a Personal Profile, IT Profile and Team Profile.
|
| ActorProfileRequestBody |
ActorProfileRequestBody provides the request body payload for working on ActorProfile entities.
|
| ActorProfileResponse |
ActorProfileResponse is the response structure used on the OMAS REST API calls that return a
ActorProfileElement object as a response.
|
| AdjacentLocationProperties |
AdjacentLocationProperties describes the properties for the AdjacentLocation relationship between adjacent locations.
|
| AppointmentProperties |
ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
|
| AppointmentRequestBody |
AppointmentRequestBody provides the request body payload for linking roles to people.
|
| AssetCollectionMember |
AssetCollectionMember describes an asset that is a member of an individual's my-assets collection.
|
| AssetCollectionRequestBody |
AssetCollectionRequestBody defines the properties used to create an asset connector anchor object.
|
| AssetListResponse |
AssetListResponse returns a list of assets from the server.
|
| AssetLocationProperties |
AssetLocationProperties describes the properties for the AssetLocation relationship between an asset and a location.
|
| AssetProperties |
AssetProperties describes an asset.
|
| AssignmentScopeProperties |
AssignmentScopeProperties provides a details of the scope of work/influence expected by the assigned actor(s).
|
| ClassificationProperties |
ClassificationProperties provides the base class for classification items.
|
| ClassificationRequestBody |
ClassificationRequestBody describes the request body used when attaching classification to elements.
|
| CollectionElement |
CollectionElement contains the properties and header for a collection retrieved from the metadata repository.
|
| CollectionManagementInterface |
The CollectionManagementInterface adds methods for managing collections that can be attached to communities
and personal profiles.
|
| CollectionMember |
CollectionMember describes a member of a collection.
|
| CollectionMemberHeader |
CollectionMemberHeader describes the common properties of a item in a favorite things list.
|
| CollectionOrder |
CollectionOrder specifies the sequencing to use in a specific collection.
|
| CollectionProperties |
CollectionProperties describes the core properties of a collection.
|
| CollectionStatus |
CollectionStatus specifies which subset of a collection should be returned.
|
| CommentElement |
CommentElement contains the properties and header for a comment retrieved from the metadata repository.
|
| CommentProperties |
The CommentProperties bean stores information about a comment connected to an asset.
|
| CommentType |
The CommentType allows comments to be used to ask and answer questions as well as make suggestions and
provide useful information to other users.
|
| CommunityCollectionMember |
CommunityCollectionMember describes a community that is a member of an individual's my-communities collection.
|
| CommunityElement |
CommunityElement contains the properties and header for a community.
|
| CommunityForum |
CommunityForum is used to maintain the content for a community forum.
|
| CommunityForumContribution |
CommunityForumContribution is used to add an entry to a community forum.
|
| CommunityListResponse |
CommunityListResponse is the response structure used on the OMAS REST API calls that return
a list of community elements.
|
| CommunityManagementInterface |
The CommunityManagementInterface provides methods for managing communities, their membership and content.
|
| CommunityMembershipElement |
CommunityMembershipElement describes an individual who is a member of a community.
|
| CommunityMembershipProperties |
CommunityMembershipProperties provides a details of the purpose (and privileges) of the membership role.
|
| CommunityMembershipType |
CollectionStatus specifies which subset of a collection should be returned.
|
| CommunityProfileAuditCode |
The CommunityProfileAuditCode is used to define the message content for the OMRS Audit Log.
|
| CommunityProfileCheckedExceptionBase |
CommunityProfileCheckedExceptionBase provides a checked exception for reporting errors found when using
the Community Profile OMAS services.
|
| CommunityProfileErrorCode |
The CommunityProfileErrorCode is used to define first failure data capture (FFDC) for errors that occur when working with
the Community Profile OMAS Services.
|
| CommunityProfileEventHeader |
CommunityProfileEventHeader provides a common base for all events from the access service.
|
| CommunityProfileEventInterface |
CommunityProfileEventInterface defines how a client gets access to the events produced by the Community Profile OMAS.
|
| CommunityProfileEventListener |
CommunityProfileEventListener is the interface that a client implements to
register to receive the events from the Community Profile OMAS's out topic.
|
| CommunityProfileOMASAPIRequestBody |
CommunityProfileOMASAPIRequestBody provides a common header for Community Profile OMAS request bodies for its REST API.
|
| CommunityProfileOMASAPIResponse |
CommunityProfileOMASAPIResponse provides a common header for Community Profile OMAS managed rest to its REST API.
|
| CommunityProfileOutboundEvent |
CommunityProfileOutboundEvent describes the structure of the events emitted by the Community Profile OMAS.
|
| CommunityProfileOutboundEventType |
CommunityProfileOutboundEventType describes the different types of events produced by the Community Profile OMAS.
|
| CommunityProperties |
CommunityProperties describes the core properties of a community.
|
| CommunityResponse |
CommunityResponse is the response structure used on the OMAS REST API calls that return a
CommunityElement object as a response.
|
| ContactMethodElement |
ContactMethodElement contains the properties and header for a contract method retrieved from the metadata repository.
|
| ContactMethodProperties |
ContactMethodProperties describes a single mechanism that can be used to contact an individual.
|
| ContactMethodRequestBody |
ContactMethodRequestBody provides the request body payload for working on ContactMethod entities.
|
| ContactMethodType |
ContactMethodType specifies the contact mechanism to use to contact an individual.
|
| ContributionRecord |
The ContributionRecord holds the information about an individual's contribution to the open metadata
ecosystem.
|
| ContributionRecordElement |
ContributionRecordElement contains the properties and header for a contribution record retrieved from the metadata repository.
|
| DigitalLocationProperties |
DigitalLocationProperties carries the parameters for marking a location as a digital (cyber) location.
|
| EffectiveDatesRequestBody |
ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
|
| EffectiveTimeRequestBody |
EffectiveTimeRequestBody carries the date/time for a query.
|
| ElementStubsResponse |
ElementStubListResponse is the response structure used on the OMAS REST API calls that return a
list of element identifiers as a response.
|
| ExternalReferenceElement |
ExternalReferenceElement stores information about an link to an external resource that is relevant to this element.
|
| ExternalReferenceManagementInterface |
ExternalReferenceManagementInterface defines the Java API for managing external references.
|
| ExternalReferenceProperties |
ExternalReferenceProperties stores information about an link to an external resource that is relevant to a personal
profile or a community.
|
| ExternalSourceRequestBody |
ExternalSourceRequestBody carries the parameters for marking an asset or schema as external.
|
| FixedLocationProperties |
FixedLocationProperties carries the parameters for marking a location as a fixed physical location.
|
| GovernanceDefinitionProperties |
GovernanceDefinitionProperties provides the base class for many of the definitions that define the data strategy
and governance program.
|
| GovernanceDefinitionStatus |
GovernanceDefinitionStatus indicates whether the definition is complete and operational or in a state that means
it is either under development or obsolete.
|
| InformalTagElement |
InformalTagElement contains the properties and header for an informal retrieved from the metadata repository.
|
| InformalTagProperties |
InformalTagProperties stores information about a tag connected to an asset.
|
| LikeElement |
LikeElement contains the properties and header for a like entity retrieved from the metadata repository.
|
| LikeProperties |
The LikeProperties properties object records a single user's "like" of an asset.
|
| LocationElement |
LocationElement contains the properties and header for a location definition retrieved from the metadata repository.
|
| LocationListResponse |
LocationListResponse is a response object for passing back a list of location objects.
|
| LocationManagementInterface |
LocationManagementInterface defines the client side interface for the Community Profile OMAS that is relevant for managing definitions of locations.
|
| LocationProperties |
LocationProperties is a class for representing a generic location.
|
| LocationResponse |
LocationResponse is a response object for passing back a single location object.
|
| MetadataElement |
MetadataElement is the common interface for all metadata elements.
|
| MetadataSourceElement |
MetadataSourceElement contains the properties and header for a software server capability retrieved from the metadata repository.
|
| MetadataSourceInterface |
MetadataSourceInterface is the interface used to define information about the third party technologies that
an integration daemon is extracting metadata from.
|
| MetadataSourceProperties |
MetadataSourceProperties describe the properties for a capability that is supplying profile
information to the Community Profile OMAS.
|
| MetadataSourceResponse |
MetadataSourceResponse is the response structure used on the OMAS REST API calls that return a
MetadataSourceElement object as a response.
|
| MyFavouriteCollectionsInterface |
MyFavouriteCollectionsInterface covers the management of the MyAssets, MyProjects and MyCommunities
collections associated with a person's personal profile.
|
| MyPersonalMessagesInterface |
|
| MyPersonalNetworkInterface |
MyPersonalNetworkInterface provides interfaces to query the personal network of the individual.
|
| MyPersonalNotesInterface |
MyPersonalNotesInterface provides the ability for a person to create and manage their personal notes.
|
| MyPersonalProfileInterface |
MyPersonalProfileInterface covers the management of a user's personal profile.
|
| MyProfileRequestBody |
MyProfileRequestBody provides a structure for passing personal details over a REST API.
|
| MyRolesAndActionsInterface |
MyRolesAndActionsInterface covers the ability to query a person's roles and any actions (to dos) assigned
to those roles.
|
| NestedLocationProperties |
NestedLocationProperties describes the properties for the NestedLocation relationship between locations.
|
| NoProfileForUserException |
The NoProfileForUserException is thrown by the OMAS when a userId passed on a request does not have an associated
actor profile.
|
| NoteLogEntryElement |
NoteLogEntryElement contains the properties and header for an entry in a note log such as a persona note log or a community forum.
|
| NoteLogEntryProperties |
NoteLogEntryProperties covers the entries in a community forum and personal notes since they are based on a note log.
|
| NoteLogHeaderElement |
NoteLogHeaderElement contains the properties and header for the root of a note log such as a personal note log or a community forum.
|
| NoteLogHeaderProperties |
NoteLogHeaderProperties covers the properties that are common between a community forum and a persona note log.
|
| OrganizationManagementInterface |
OrganizationManagementInterface defines the client interface for setting up the profiles, roles and relationships for an organization.
|
| PersonalMessage |
Personal message is a comment added to a personal profile.
|
| PersonalNote |
PersonalNote is used to add a personal note to a personal profile.
|
| PersonalNoteLog |
PersonalNoteLog is used to maintain the list of personal notes for a personal profile.
|
| PersonalProfileElement |
The PersonalProfileElement describes an individual who has (or will be) appointed to one of the
governance roles defined in the governance program.
|
| PersonalProfileListResponse |
PersonalProfileListResponse is the response structure used on the OMAS REST API calls that return
a list of personal profile objects.
|
| PersonalProfileManagementInterface |
PersonalProfileManagementInterface defines the client interface for an administrator setting up a profile for an
individual.
|
| PersonalProfileProperties |
The PersonalProfileProperties describes an individual.
|
| PersonalProfileRequestBody |
PersonalDetailsRequestBody provides a structure for passing personal details over a REST API.
|
| PersonalProfileResponse |
PersonalProfileResponse is the response structure used on the OMAS REST API calls that return a
PersonalProfileUniverse object as a response.
|
| PersonalProfileUniverse |
PersonalProfileUniverse contains the properties and header for a personal profile
retrieved from the metadata repository along with details of the contribution record, user ids, contact methods, peers and
roles that the profile is linked to.
|
| PersonalProfileValidatorRequestBody |
PersonalDetailsRequestBody provides a structure for passing personal details over a REST API.
|
| PersonalRoleElement |
PersonalRoleElement contains the properties and header for a person role assigned to a profile retrieved from the metadata repository.
|
| PersonalRoleProperties |
PersonalRoleProperties provides a structure for describe a role assigned to a person.
|
| PersonRoleAppointee |
PersonRoleAppointee describes an individual's appointment to a specific governance role.
|
| PersonRoleAppointeeListResponse |
PersonRoleListResponse is the response structure used on the OMAS REST API calls that return a
a list of person role elements.
|
| PersonRoleElement |
PersonalRoleElement contains the properties and header for a person role assigned to a profile retrieved from the metadata repository.
|
| PersonRoleListResponse |
PersonRoleListResponse is the response structure used on the OMAS REST API calls that return
a list of person role elements.
|
| PersonRoleProperties |
PersonRoleProperties covers a role that has been defined in an organization.
|
| PersonRoleRequestBody |
PersonRoleRequestBody provides the request body payload for working on PersonRole entities.
|
| PersonRoleResponse |
PersonRoleResponse is the response structure used on the OMAS REST API calls that return a
PersonRoleElement object as a response.
|
| ProfileIdentityElement |
ProfileIdentityElement contains the properties and header for a relationship between a profile and a user identity retrieved
from the metadata repository.
|
| ProfileIdentityProperties |
ProfileIdentityProperties describes the properties for the ProfileIdentity relationship between a profile
and a user identity.
|
| ProfileLocationElement |
ProfileLocationElement contains the properties and header for a relationship between a profile and a user identity retrieved
from the metadata repository.
|
| ProfileLocationProperties |
ProfileLocationProperties describes the properties for the ProfileLocation relationship between a profile
and a location.
|
| ProjectCollectionMember |
ProjectCollectionMember describes a project that is a member of an individual's my-projects collection.
|
| ProjectProperties |
ProjectProperties describes a project.
|
| RatingElement |
RatingElement contains the properties and header for a rating retrieved from the metadata repository.
|
| RatingProperties |
RatingProperties stores information about a rating connected to an asset.
|
| ReferenceableProperties |
Many open metadata entities are referenceable.
|
| ReferenceableRequestBody |
ReferenceableRequestBody describes the request body used when working with referenceables.
|
| ReferenceValueAssignmentProperties |
ReferenceValueAssignmentProperties is a java bean used to create a link between a valid value and a referenceable item
to enable the valid value to be used as a semiformal tag/classifier.
|
| RelatedElement |
RelatedElement contains the properties and header for a relationship retrieved from the metadata repository along with the stub
of the related element.
|
| RelatedElementListResponse |
RelatedElementListResponse is a response object for passing back a list of relatedElement objects.
|
| RelatedElementsManagementInterface |
Defines the interface that is common to multiple element types
|
| RelationshipElement |
RelationshipElement contains the properties and header for a relationship retrieved from the metadata repository.
|
| RelationshipElementResponse |
RelationshipElementResponse is the response structure used on the OMAS REST API calls that return the properties
for a relationship.
|
| RelationshipElementsResponse |
RelationshipElementsResponse is a response object for passing back a list of relationships
or an exception if the request failed.
|
| RelationshipProperties |
RelationshipProperties provides the base class for relationships items.
|
| RelationshipRequestBody |
RelationshipRequestBody describes the request body used when linking elements together.
|
| ResourceElement |
ResourceElement contains the properties and header for a referenceable retrieved from the metadata repository.
|
| ResourceListProperties |
ResourceListProperties provides a details of why an element providing resources (such as a community) has been attached to an initiative
such as a governance domain.
|
| ResourceProperties |
ResourceProperties provides a summary of a resource linked to a community or personal profile or something similar.
|
| SecureLocationProperties |
SecureLocationProperties carries the parameters for marking a location as secure.
|
| SecurityGroupElement |
SecurityGroupElement is the superclass used to return the common properties of a governance definition stored in the
open metadata repositories.
|
| SecurityGroupInterface |
|
| SecurityGroupProperties |
SecurityGroupProperties defines a security group technical control.
|
| SecurityGroupResponse |
SecurityGroupResponse is the response structure used on the OMAS REST API calls that return the properties
for a security group.
|
| SecurityGroupsResponse |
SecurityGroupsResponse is a response object for passing back a a list of security groups
or an exception if the request failed.
|
| StakeholderProperties |
StakeholderProperties provides a details of a stakeholder for an initiative.
|
| StarRating |
A StarRating defines the rating that a user has placed against an element.
|
| TeamMembershipElement |
TeamMembershipElement contains the properties and header for a role that shows a person is a leader or a member of
a team as retrieved from the metadata repository.
|
| TeamPlayerRequestBody |
TeamPlayerRequestBody provides the request body payload for linking roles to teams.
|
| TeamProfileElement |
TeamProfileElement contains the properties and header for a team profile retrieved from the metadata repository.
|
| TeamProfileProperties |
The TeamProfileProperties describes an team of people.
|
| TemplateProperties |
TemplateProperties defined the properties that can be overridden from the template object
when creating an object from a template.
|
| TemplateRequestBody |
TemplateRequestBody carries the parameters for creating a new asset using a template.
|
| ToDoElement |
ToDoElement contains the properties and header for a "to do" (informal task) retrieved from the metadata repository.
|
| ToDoManagementInterface |
|
| ToDoProperties |
The "To Do" describes an action - it may be assigned to a person role (see PersonRoleAction).
|
| ToDoStatus |
ToDoStatus defines the progress towards completing a to do.
|
| UserIdentityElement |
UserIdentityElement contains the properties and header for a user identity retrieved from the metadata repository.
|
| UserIdentityListResponse |
UserIdentityListResponse is the response structure used on the OMAS REST API calls that return
a list of user identity elements.
|
| UserIdentityManagementInterface |
UserIdentityManagementInterface provides administrative function to alter the association between
a profile (either personal profile or IT profile) and a user identity.
|
| UserIdentityProperties |
UserIdentityProperties describes an element that is linked to a single userId.
|
| UserIdentityResponse |
UserIdentityResponse is the response structure used on the OMAS REST API calls that return a
UserIdentityElement object as a response.
|
| ValidValueAssignmentProperties |
ValidValueAssignmentProperties describes the properties between a referenceable and its valid values.
|
| ValidValueElement |
ValidValueElement contains the properties and header for a valid value definition or set entity retrieved from the metadata repository.
|
| ValidValueListResponse |
ValidValueListResponse is a response object for passing back a list of valid value objects.
|
| ValidValueManagementInterface |
The ValidValueManagementInterface provides methods for managing valid values.
|
| ValidValueMembershipProperties |
ValidValueMembershipProperties provides a flag to indicate if this value is the default value for the set.
|
| ValidValueProperties |
ValidValueProperties provides the common super class for ValidValueSet and ValidValueDefinition.
|
| ValidValueResponse |
ValidValueResponse is a response object for passing back a single valid value object.
|
| WatchStatus |
WatchStatus specifies whether changes to assets in an asset collection should be
passed as notifications to the actor who's profile is linked to the collection.
|