Package se.conciliate.extensions.store
Interface MTRevisionLogEntry
public interface MTRevisionLogEntry
Interface for revision log entries. Each revision of models and
symbols have log entries specifying the time and reason for the
revision being created or locked. It can also have any number
of log messages added by users for an open revision.
- Since:
- 3.0
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionReturns the log event type.long
getID()
Returns the unique ID of the log entry.Returns the log message.Returns the revision number for the model/symbol that this revision was created from.int
Returns the revision number for the model/symbol that this log entry belongs to.Returns the time when the event occurred.If the event occurred because of another revision event, e.g.getUser()
Returns the user responsible for the log event.boolean
Returns true if the event was a change in a revision.boolean
Returns true if the event was a locked revision.boolean
Returns true if the event was a new revision.
-
Method Details
-
getID
long getID()Returns the unique ID of the log entry.- Returns:
- The unique ID.
- Since:
- 3.0
-
getMessage
String getMessage()Returns the log message.- Returns:
- The log message
- Since:
- 3.0
-
getEventType
MTRevisionLogEntry.LogEventType getEventType()Returns the log event type.- Returns:
- The event type.
- Since:
- 3.0
-
getTimestamp
Date getTimestamp()Returns the time when the event occurred.- Returns:
- The event timestamp.
- Since:
- 3.0
-
isNewRevision
boolean isNewRevision()Returns true if the event was a new revision.- Returns:
- True for a new revision.
- Since:
- 3.0
-
isLockedRevision
boolean isLockedRevision()Returns true if the event was a locked revision.- Returns:
- True for a locked revision.
- Since:
- 3.3
-
isChangeInRevision
boolean isChangeInRevision()Returns true if the event was a change in a revision.- Returns:
- True for a change in a revision.
- Since:
- 3.3
-
getUser
MTUserHeader getUser()Returns the user responsible for the log event.- Returns:
- The responsible user.
- Since:
- 3.0
-
getRevisionNumber
int getRevisionNumber()Returns the revision number for the model/symbol that this log entry belongs to.- Returns:
- The revision number of the model/symbol.
- Since:
- 3.3
-
getParentRevisionNumber
Integer getParentRevisionNumber()Returns the revision number for the model/symbol that this revision was created from.- Returns:
- The revision number of the parent revision, or
null
if this log entry is for revision 0. - Since:
- 3.3
-
getTrigger
MTRevisionLogEntry getTrigger()If the event occurred because of another revision event, e.g. a symbol being locked because of a model being locked then this returns the trigging event.- Returns:
- The trigging event or null
- Since:
- 3.0
-
getWorkflowState
String getWorkflowState()- Returns:
- Returns the workflow state to which the model was transitioned. Can be
null
-