Class ReconEvent

java.lang.Object
oracle.iam.reconciliation.vo.ReconEvent
All Implemented Interfaces:
Serializable

public class ReconEvent extends Object implements Serializable
Encapsulates an instance of a Reconciliation Event for the Event Management APIs. Note that this Event object may differ from the actual Recon Event Data Object. It is a view from a management perspective only.
See Also:
  • Constructor Details

    • ReconEvent

      public ReconEvent()
      Constructor, instantiates a blank Event.
    • ReconEvent

      public ReconEvent(boolean fromSch)
      Constructor, instantiates an Event with a given the 'from search' property.
      Parameters:
      fromSch - specifies whether the Recon Event is instantiated from a UI search (TRUE in that case, FALSE otherwise).
  • Method Details

    • getRetryCount

      public Long getRetryCount()
      Returns:
      the reRetryCount
    • setRetryCount

      public void setRetryCount(Long reRetryCount)
      Parameters:
      reRetryCount - the reRetryCount to set
    • addToReconEventAssignmentCollection

      public void addToReconEventAssignmentCollection(ReconEventAssignment aReconEventAssignment)
      Deprecated.
      Add Event Assignments to the list of Assignments for the current Event.
      Parameters:
      aReconEventAssignment - a ReconEventAssignment to add to the list of assignments.
    • getActKey

      public Long getActKey()
      Gets the Account Key ) ACT key of the current Event.
      Returns:
      a long representing the act key.
    • getObjKey

      public Long getObjKey()
      Gets the Object Key of the current Event.
      Returns:
      a long representing the obj key.
    • getRjKey

      public Long getRjKey()
      Gets the Job key (RJ Key) of the job which generated the current Event.
      Returns:
      a long representing the RJ key.
    • getOrcKey

      public Long getOrcKey()
      Gets the ORC Key of the current Event.
      Returns:
      a Long representing the ORC key.
    • getReChangeType

      public String getReChangeType()
      Gets the Change Type (i.e., the operation) of the Current Event. This can REGULAR or DELETE.
      Returns:
      a string.
    • getProfileName

      public String getProfileName()
      Gets the Name of the Profile this Event pertains to.
      Returns:
      a String.
    • getReCreate

      public Date getReCreate()
      Gets the Recon Event creation date.
      Returns:
      a Date
    • getReCreator

      public Long getReCreator()
      Gets the Users ID of the Event Creator (note: this does not return the creator's Login ID, but his/her User ID).
      Returns:
      a Long.
    • getReEntityType

      public String getReEntityType()
      Gets the type of Entity this Event pertains to, either User or Account or Role.
      Returns:
      a String.
    • getReIsManualMatch

      public String getReIsManualMatch()
      Determines whether the Event has been manually or automatically mached.
      Returns:
      a String.
    • getReKey

      public Long getReKey()
      Gets the Key of the current Event.
      Returns:
      a Long.
    • getReModifier

      public Long getReModifier()
      Gets the ID of the last mofified of the current Event (note: this does not return the modifier's Login ID, but his/her User ID).
      Returns:
      a Long.
    • getReModify

      public Date getReModify()
      Gets the date the Event was last modified.
      Returns:
      a Date.
    • getReRowver

      public Long getReRowver()
      Gets the current Row Version of the Event. Every change made to the Recon Event increments this database field. This value could be used for Optimistic locking.
      Returns:
      a Long.
    • getReStatus

      public String getReStatus()
      Gets the status of the Event.
      Returns:
      a String.
    • getReNote

      public String getReNote()
      Gets the current note attached to the Event. Notes can describe validation errors, closure reasons or any issue reported by the Reconciliation engine.
      Returns:
      a String.
    • getAccountOwnerType

      public String getAccountOwnerType()
      Gets the Account owner type, i.e., whether the current Event is owned by a User or an Organization.
      Returns:
      a String
    • getReconEventAssignmentCollection

      public Collection getReconEventAssignmentCollection()
      Gets the list of assignments for the Events.
      Returns:
      a collection of ReconEventAssignments.
    • getReconEventAssignment

      public ReconEventAssignment getReconEventAssignment()
      Gets the latest Assignment for the current Event.
      Returns:
      a ReconEventAssignment instance.
    • getUsrKey

      public Long getUsrKey()
      Gets the User ID this Event pertains to.
      Returns:
      a Long.
    • getText

      public String getText()
      Returns blank, used by Canonic Fwk only.
      Returns:
      blank.
    • removeFromReconEventAssignmentCollection

      public void removeFromReconEventAssignmentCollection(ReconEventAssignment aReconEventAssignment)
      Removes the given Assignment from the collection of Assignments.
      Parameters:
      aReconEventAssignment - the ReconEventAssignment to remove from the collection.
    • setActKey

      public void setActKey(Long actKey)
      Set the Account Key (ACT) of the current Event.
      Parameters:
      actKey - the new ACT key this Event pertains to.
    • setRjKey

      public void setRjKey(Long rjKey)
      Set the Job Key (RJ) of the current Event.
      Parameters:
      rjKey - the new RK Key this Event pertains to.
    • setObjKey

      public void setObjKey(Long objKey)
      Set the OBJ key of the current Event.
      Parameters:
      objKey - the new Obj key this Event pertains to.
    • setOrcKey

      public void setOrcKey(Long orcKey)
      Set the Orc key of the current Event.
      Parameters:
      orcKey - the new Orc key this Event pertains to.
    • setReChangeType

      public void setReChangeType(String reChangeType)
      Set the Change type, i.e., operation, for the current Event.
      Parameters:
      reChangeType - the new Change type for this Event.
    • setProfileName

      public void setProfileName(String profName)
      Set the Profile name.
      Parameters:
      profName - the new profile name.
    • setReCreate

      public void setReCreate(Date reCreate)
      Set the creation date for the current Event.
      Parameters:
      reCreate - the new creation date.
    • setReCreator

      public void setReCreator(Long reCreator)
      Set the ID of the Event Creator.
      Parameters:
      reCreator - the user ID of the Event creator.
    • setReEntityType

      public void setReEntityType(String reEntityType)
      Sets the type of Entity this Event pertains to.
      Parameters:
      reEntityType - the new Entity Type.
    • setReIsManualMatch

      public void setReIsManualMatch(String reIsManualMatch)
      Determines whether the Event was matched Manually or not.
      Parameters:
      reIsManualMatch - the string representing the manual match.
    • setReKey

      public void setReKey(Long reKey)
      Set the Key of the Event.
      Parameters:
      reKey - the new Event Key.
    • setReModifier

      public void setReModifier(Long reModifier)
      Set the ID of the Modifier of the Event.
      Parameters:
      reModifier - the new ID of the Event Modifier.
    • setReModify

      public void setReModify(Date reModify)
      Set the last date of Event modification.
      Parameters:
      reModify - the modify date.
    • setReRowver

      public void setReRowver(Long reRowver)
      Set the row version of the Event database row. This could be used for optimistic locking.
      Parameters:
      reRowver - the new row version number.
    • setReStatus

      public void setReStatus(String reStatus)
      Set the Event status.
      Parameters:
      reStatus - the new status of the Event.
    • setReNote

      public void setReNote(String reNote)
      Set the Event Note.
      Parameters:
      reNote - the new note for thew Event.
    • setAccountOwnerType

      public void setAccountOwnerType(String acctOwnerType)
      Set the type of the Event Account Owner (only valid for Account Events).
      Parameters:
      acctOwnerType - the new account type.
    • setReconEventAssignmentCollection

      public void setReconEventAssignmentCollection(Collection reconEventAssignmentCollection)
      Set the Assignment Collection of the current Event.
      Parameters:
      reconEventAssignmentCollection - the new collection of assignments for this Event.
    • setUsrKey

      public void setUsrKey(Long usrKey)
      Set the User Key this Event pertains to.
      Parameters:
      usrKey - the user key.
    • setBatchStatus

      public void setBatchStatus(String status)
      Set the status of the Batch in which this Event was processed.
      Parameters:
      status - the new batch Status.
    • getBatchStatus

      public String getBatchStatus()
      Gets the status of the Batch in which this Event was processed.
      Returns:
      a String.
    • setResourceName

      public void setResourceName(String name)
      Set the name of the resource this Event pertains to.
      Parameters:
      name - the new resource name.
    • getResourceName

      public String getResourceName()
      Gets the name of the resource this Event pertains to.
      Returns:
      a String.
    • getReason

      public String getReason()
      Gets the reason field, which can be populate to justify an action performed on the Event.
      Returns:
      a String.
    • setReason

      public void setReason(String reason)
      Set the reason field, which can be populate to justify an action performed on the Event.
      Parameters:
      reason - the new reason string.
    • getLinkSource

      public String getLinkSource()
      Gets the source of the Linking, if the Event is linked.
      Returns:
      a String.
    • setLinkSource

      public void setLinkSource(String src)
      the source of the Linking, if the Event is being linked.
      Parameters:
      src - the link source.
    • setReModifierLogin

      public void setReModifierLogin(String param)
      Sets the Login ID of the Event modifier.
      Parameters:
      param - the new Loging ID.
    • getReModifierLogin

      public String getReModifierLogin()
      Gets the login ID of the Event Modifier.
      Returns:
      a String.
    • setReModifierName

      public void setReModifierName(String param)
      Sets the name of the user who last modified the Event.
      Parameters:
      param - the new modifier name.
    • getReModifierName

      public String getReModifierName()
      Gets the name of the user who last modified the Event.
      Returns:
      a String.
    • getLoginFullName

      public String getLoginFullName(Long ID)
      Gets a string computed by concatenating the Login ID and Full Name of the user who's ID is provided as parameter. Note that this method also populates the reModifierName and reModifierLogin properties of the class.
      Parameters:
      ID - The Id of the user who's Name/Login ID is to be fetched.
      Returns:
      the String composed of Login and Full name.
    • setFromSearch

      public void setFromSearch(boolean fromSearch)
      Set the from Search property, which specifies whether the Recon Event is instantiated from a UI search (TRUE in that case, FALSE otherwise).
      Parameters:
      fromSearch - the new value.
    • isFromSearch

      public boolean isFromSearch()
      Determines whether the Event was instantiated from a UI Search or not.
      Returns:
      TRUE is the Event was instantiated from a UI Search, FALSE otherwise.
    • setUgpKey

      public void setUgpKey(Long ugpKey)
      Set the Role Key property, which specifies the Role the Recon Event pertains to.
      Parameters:
      ugpKey - The key of the role to set.
    • getUgpKey

      public Long getUgpKey()
      Gets the key of the Role this Event instance pertains to.
      Returns:
      the key of the Role.
    • setReKeyField

      public void setReKeyField(String reIdentifier)
    • getReKeyField

      public String getReKeyField()
    • setReActionDate

      public void setReActionDate(Date reActionDate)
    • getReActionDate

      public Date getReActionDate()
    • getRbKey

      public Long getRbKey()
      To set Recon event batch id
      Returns:
      Recon Event Batch ID
    • setRbKey

      public void setRbKey(Long rbKey)
      To get recon event batch id
      Parameters:
      rbKey - Recon Event Batch ID