Package org.odpi.openmetadata.accessservices.communityprofile.events

Class CommunityProfileOutboundEvent

java.lang.Object

org.odpi.openmetadata.accessservices.communityprofile.events.CommunityProfileEventHeader

org.odpi.openmetadata.accessservices.communityprofile.events.CommunityProfileOutboundEvent

All Implemented Interfaces:

Serializable

public class CommunityProfileOutboundEvent
extends CommunityProfileEventHeader

CommunityProfileOutboundEvent describes the structure of the events emitted by the Community Profile OMAS.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
CommunityProfileOutboundEvent()	Default constructor
CommunityProfileOutboundEvent(CommunityProfileOutboundEvent template)	Copy/clone constructor

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object objectToCompare)	Return comparison result based on the content of the properties.
String	getClassificationName()	Return the name of the classification that has changed.
ElementStub	getEndOneElement()	Return the element at end one of the relationship that is described in the principleElement.
ElementStub	getEndTwoElement()
CommunityProfileOutboundEventType	getEventType()	Return the type of event.
long	getPlateau()	Return the current karma point plateau for this individual.
long	getPointsTotal()	Return the total number of karma points that an individual has achieved.
ElementStub	getPrincipleElement()	Return the element that is the subject of the event.
String	getUserId()	Return user identity of associated user.
int	hashCode()	Return hash code for this object
void	setClassificationName(String classificationName)	Set up the name of the classification that has changed.
void	setEndOneElement(ElementStub endOneElement)
void	setEndTwoElement(ElementStub endTwoElement)
void	setEventType(CommunityProfileOutboundEventType eventType)	Set up the type of event.
void	setPlateau(long plateau)	Set up the current karma point plateau for this individual.
void	setPointsTotal(long pointsTotal)	Set up the total number of karma points that an individual has achieved.
void	setPrincipleElement(ElementStub principleElement)	Set up the element that is the subject of the event.
void	setUserId(String userId)	Set up the user id of the associated user.
String	toString()	JSON-style toString

Methods inherited from class org.odpi.openmetadata.accessservices.communityprofile.events.CommunityProfileEventHeader

getEventVersionId, setEventVersionId

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CommunityProfileOutboundEvent

public CommunityProfileOutboundEvent()

Default constructor

CommunityProfileOutboundEvent

public CommunityProfileOutboundEvent(CommunityProfileOutboundEvent template)

Copy/clone constructor

Parameters:

template - object to copy

Method Detail

getEventType

public CommunityProfileOutboundEventType getEventType()

Return the type of event.

Returns:

event type enum

setEventType

public void setEventType(CommunityProfileOutboundEventType eventType)

Set up the type of event.

Parameters:

eventType - - event type enum

getPrincipleElement

public ElementStub getPrincipleElement()

Return the element that is the subject of the event.

Returns:

element identifiers

setPrincipleElement

public void setPrincipleElement(ElementStub principleElement)

Set up the element that is the subject of the event.

Parameters:

principleElement - element identifiers

getClassificationName

public String getClassificationName()

Return the name of the classification that has changed. Only set up for classify, reclassify and declassify events.

Returns:

string name

setClassificationName

public void setClassificationName(String classificationName)

Set up the name of the classification that has changed. Only set up for classify, reclassify and declassify events.

Parameters:

classificationName - string name

getEndOneElement

public ElementStub getEndOneElement()

Return the element at end one of the relationship that is described in the principleElement. This is only set up on

Returns:

setEndOneElement

public void setEndOneElement(ElementStub endOneElement)

getEndTwoElement

public ElementStub getEndTwoElement()

setEndTwoElement

public void setEndTwoElement(ElementStub endTwoElement)

getUserId

public String getUserId()

Return user identity of associated user.

Returns:

user id

setUserId

public void setUserId(String userId)

Set up the user id of the associated user.

Parameters:

userId - user id

getPointsTotal

public long getPointsTotal()

Return the total number of karma points that an individual has achieved.

Returns:

long

setPointsTotal

public void setPointsTotal(long pointsTotal)

Set up the total number of karma points that an individual has achieved.

Parameters:

pointsTotal - long

getPlateau

public long getPlateau()

Return the current karma point plateau for this individual.

Returns:

long

setPlateau

public void setPlateau(long plateau)

Set up the current karma point plateau for this individual.

Parameters:

plateau - long

toString

public String toString()

JSON-style toString

Overrides:

toString in class CommunityProfileEventHeader

Returns:

return string containing the property names and values

equals

public boolean equals(Object objectToCompare)

Return comparison result based on the content of the properties.

Overrides:

equals in class CommunityProfileEventHeader

Parameters:

objectToCompare - test object

Returns:

result of comparison

hashCode

public int hashCode()

Return hash code for this object

Overrides:

hashCode in class CommunityProfileEventHeader

Returns:

int hash code