Class AssetManagerOutTopicEvent

  • All Implemented Interfaces:
    java.io.Serializable

    public class AssetManagerOutTopicEvent
    extends java.lang.Object
    implements java.io.Serializable
    AssetManagerOutTopicEvent provides the structure of the Asset Manager OMAS's OutTopic events. The values for elements and their classifications come from the events. They are not guaranteed to be current. If the latest values are required, the element should be queried from the repository using its GUID. The event values are useful if the third party catalog needs to maintain an exact record of all the versions.
    See Also:
    Serialized Form
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object objectToCompare)
      Compare the values of the supplied object with those stored in the current object.
      java.lang.String getClassificationName()
      Return the name of the classification if the event relates to classifications.
      ElementHeader getElementHeader()
      Return details of the subject of the event.
      java.util.Map<java.lang.String,​java.lang.Object> getElementProperties()
      Return the map of properties for the element provided with the event.
      ElementHeader getEndOneElementHeader()
      Return the element at end one of the relationship that is described in the principleElement.
      java.util.Map<java.lang.String,​java.lang.Object> getEndOneElementProperties()
      Return the property map for end one's properties (used for relationship events).
      ElementHeader getEndTwoElementHeader()
      Return the element at end two of the relationship that is described in the principleElement.
      java.util.Map<java.lang.String,​java.lang.Object> getEndTwoElementProperties()
      Return the property map for end two's properties (used for relationship events).
      java.util.Date getEventTime()
      Return the time that the element was updated.
      AssetManagerEventType getEventType()
      Return the event type.
      long getEventVersionId()
      Return the event version id.
      java.util.Map<java.lang.String,​java.lang.Object> getPreviousClassificationProperties()
      Return the property map for the previous version of a classification's properties (used for reclassify events).
      ElementHeader getPreviousElementHeader()
      Return the previous version of the element's header (if the event is related to an element update).
      java.util.Map<java.lang.String,​java.lang.Object> getPreviousElementProperties()
      Return the previous version of the element's properties (if the event is related to an element update).
      int hashCode()
      Create a hash code for this element type.
      void setClassificationName​(java.lang.String classificationName)
      Set up the name of the classification if the event relates to classifications.
      void setElementHeader​(ElementHeader elementHeader)
      Set up details of the subject of the event.
      void setElementProperties​(java.util.Map<java.lang.String,​java.lang.Object> elementProperties)
      Set up the map of properties for the element provided with the event.
      void setEndOneElementHeader​(ElementHeader endOneElementHeader)
      Set up the element at end one of the relationship that is described in the principleElement.
      void setEndOneElementProperties​(java.util.Map<java.lang.String,​java.lang.Object> properties)
      Set up tthe property map for end one's properties (used for relationship events).
      void setEndTwoElementHeader​(ElementHeader endTwoElementHeader)
      Set up the element at end two of the relationship that is described in the principleElement.
      void setEndTwoElementProperties​(java.util.Map<java.lang.String,​java.lang.Object> properties)
      Set up the property map for end two's properties (used for relationship events).
      void setEventTime​(java.util.Date eventTime)
      Set up the time that the element was updated.
      void setEventType​(AssetManagerEventType eventType)
      Set up the event type.
      void setEventVersionId​(long eventVersionId)
      Set up the event version id.
      void setPreviousClassificationProperties​(java.util.Map<java.lang.String,​java.lang.Object> previousClassificationProperties)
      Set up the property map for the previous version of a classification's properties (used for reclassify events).
      void setPreviousElementHeader​(ElementHeader previousElementHeader)
      Set up the previous version of the element's header (if the event is related to an element update).
      void setPreviousElementProperties​(java.util.Map<java.lang.String,​java.lang.Object> previousElementProperties)
      Set up the previous version of the element's properties (if the event is related to an element update).
      java.lang.String toString()
      Standard toString method.
      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • AssetManagerOutTopicEvent

        public AssetManagerOutTopicEvent()
        Default Constructor
      • AssetManagerOutTopicEvent

        public AssetManagerOutTopicEvent​(AssetManagerOutTopicEvent template)
        Copy/clone constructor
        Parameters:
        template - object to copy
    • Method Detail

      • getEventVersionId

        public long getEventVersionId()
        Return the event version id.
        Returns:
        long
      • setEventVersionId

        public void setEventVersionId​(long eventVersionId)
        Set up the event version id.
        Parameters:
        eventVersionId - long
      • getEventType

        public AssetManagerEventType getEventType()
        Return the event type.
        Returns:
        the event type enum
      • setEventType

        public void setEventType​(AssetManagerEventType eventType)
        Set up the event type.
        Parameters:
        eventType - event type enum
      • getEventTime

        public java.util.Date getEventTime()
        Return the time that the element was updated.
        Returns:
        date/time
      • setEventTime

        public void setEventTime​(java.util.Date eventTime)
        Set up the time that the element was updated.
        Parameters:
        eventTime - date/time
      • getElementHeader

        public ElementHeader getElementHeader()
        Return details of the subject of the event.
        Returns:
        element header
      • setElementHeader

        public void setElementHeader​(ElementHeader elementHeader)
        Set up details of the subject of the event.
        Parameters:
        elementHeader - element header
      • getElementProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getElementProperties()
        Return the map of properties for the element provided with the event. These values are not guaranteed to be current.
        Returns:
        property map
      • setElementProperties

        public void setElementProperties​(java.util.Map<java.lang.String,​java.lang.Object> elementProperties)
        Set up the map of properties for the element provided with the event. These values are not guaranteed to be current.
        Parameters:
        elementProperties - property map
      • getPreviousElementHeader

        public ElementHeader getPreviousElementHeader()
        Return the previous version of the element's header (if the event is related to an element update).
        Returns:
        element header
      • setPreviousElementHeader

        public void setPreviousElementHeader​(ElementHeader previousElementHeader)
        Set up the previous version of the element's header (if the event is related to an element update).
        Parameters:
        previousElementHeader - element header
      • getPreviousElementProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getPreviousElementProperties()
        Return the previous version of the element's properties (if the event is related to an element update).
        Returns:
        property map
      • setPreviousElementProperties

        public void setPreviousElementProperties​(java.util.Map<java.lang.String,​java.lang.Object> previousElementProperties)
        Set up the previous version of the element's properties (if the event is related to an element update).
        Parameters:
        previousElementProperties - property map
      • getClassificationName

        public java.lang.String getClassificationName()
        Return the name of the classification if the event relates to classifications.
        Returns:
        string name
      • setClassificationName

        public void setClassificationName​(java.lang.String classificationName)
        Set up the name of the classification if the event relates to classifications.
        Parameters:
        classificationName - string name
      • getPreviousClassificationProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getPreviousClassificationProperties()
        Return the property map for the previous version of a classification's properties (used for reclassify events).
        Returns:
        property map
      • setPreviousClassificationProperties

        public void setPreviousClassificationProperties​(java.util.Map<java.lang.String,​java.lang.Object> previousClassificationProperties)
        Set up the property map for the previous version of a classification's properties (used for reclassify events).
        Parameters:
        previousClassificationProperties - property map
      • getEndOneElementHeader

        public ElementHeader getEndOneElementHeader()
        Return the element at end one of the relationship that is described in the principleElement. This is only set up on relationship events.
        Returns:
        element stub of entity at end 1
      • setEndOneElementHeader

        public void setEndOneElementHeader​(ElementHeader endOneElementHeader)
        Set up the element at end one of the relationship that is described in the principleElement. This is only set up on relationship events.
        Parameters:
        endOneElementHeader - element stub of entity at end 1
      • getEndOneElementProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getEndOneElementProperties()
        Return the property map for end one's properties (used for relationship events).
        Returns:
        property map
      • setEndOneElementProperties

        public void setEndOneElementProperties​(java.util.Map<java.lang.String,​java.lang.Object> properties)
        Set up tthe property map for end one's properties (used for relationship events).
        Parameters:
        properties - property map
      • getEndTwoElementHeader

        public ElementHeader getEndTwoElementHeader()
        Return the element at end two of the relationship that is described in the principleElement. This is only set up on relationship events.
        Returns:
        element stub of entity at end 2
      • setEndTwoElementHeader

        public void setEndTwoElementHeader​(ElementHeader endTwoElementHeader)
        Set up the element at end two of the relationship that is described in the principleElement. This is only set up on relationship events.
        Parameters:
        endTwoElementHeader - element stub of entity at end 2
      • getEndTwoElementProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getEndTwoElementProperties()
        Return the property map for end two's properties (used for relationship events).
        Returns:
        property map
      • setEndTwoElementProperties

        public void setEndTwoElementProperties​(java.util.Map<java.lang.String,​java.lang.Object> properties)
        Set up the property map for end two's properties (used for relationship events).
        Parameters:
        properties - property map
      • toString

        public java.lang.String toString()
        Standard toString method.
        Overrides:
        toString in class java.lang.Object
        Returns:
        print out of variables in a JSON-style
      • equals

        public boolean equals​(java.lang.Object objectToCompare)
        Compare the values of the supplied object with those stored in the current object.
        Overrides:
        equals in class java.lang.Object
        Parameters:
        objectToCompare - supplied object
        Returns:
        boolean result of comparison
      • hashCode

        public int hashCode()
        Create a hash code for this element type.
        Overrides:
        hashCode in class java.lang.Object
        Returns:
        int hash code