com.lf.commons.db.update

Class UpdateLogEntry

java.lang.Object

com.lf.commons.db.update.UpdateLogEntry

public class UpdateLogEntry
extends java.lang.Object

Simple data holding class documenting a single step during a database update (sql or task).

Since:

1.6

Version:

$Revision: 1.6 $, $Date: 2012/12/28 11:44:24 $

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_TYPE_POST Represents the post-update action.
static java.lang.String	ACTION_TYPE_PRE Represents the pre-update action.
static java.lang.String	ACTION_TYPE_UPDATE Represents the update action.
static int	STATUS_ERROR Update step produced an error (severe).
static int	STATUS_IGNORED Update step has been ignored.
static int	STATUS_OK Update step status is OK.
static int	STATUS_UNKNOWN Update step status is not known.
static int	STATUS_WARNING Update step was successful but with warnings.
static java.lang.String	STEP_TYPE_SQL Represents the <sql> element.
static java.lang.String	STEP_TYPE_TASK Represents the <task> element.

Constructor Summary

Constructors

Constructor and Description
UpdateLogEntry() Constructor method for i18n purposes only.
UpdateLogEntry(int actionno, java.lang.String actiontype, java.lang.String actionversionid, int groupno, java.lang.String steptype, java.lang.String stepdescription, int status) Constructor setting the initial values.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(UpdateLogEntry tocheck) Checks wether a given UpdateLog instance is equal to this.
int	getActionNo() Getter for the action index.
java.lang.String	getActionType() Getter for the action type.
java.lang.String	getActionVersionId() Getter for the action version identifier.
int	getGroupNo() Getter for the group index.
int	getStatus() Getter for the step status.
java.lang.String	getStepDescription() Getter for the step description.
java.lang.String	getStepType() Getter for the group index.
java.lang.String	toString() Overrides method java.lang.Object.toString.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

STATUS_IGNORED

public static final int STATUS_IGNORED

Update step has been ignored.

See Also:

Constant Field Values

STATUS_UNKNOWN

public static final int STATUS_UNKNOWN

Update step status is not known.

See Also:

Constant Field Values

STATUS_OK

public static final int STATUS_OK

Update step status is OK.

See Also:

Constant Field Values

STATUS_WARNING

public static final int STATUS_WARNING

Update step was successful but with warnings.

See Also:

Constant Field Values

STATUS_ERROR

public static final int STATUS_ERROR

Update step produced an error (severe).

See Also:

Constant Field Values

ACTION_TYPE_PRE

public static final java.lang.String ACTION_TYPE_PRE

Represents the pre-update action.

See Also:

Constant Field Values

ACTION_TYPE_UPDATE

public static final java.lang.String ACTION_TYPE_UPDATE

Represents the update action.

See Also:

Constant Field Values

ACTION_TYPE_POST

public static final java.lang.String ACTION_TYPE_POST

Represents the post-update action.

See Also:

Constant Field Values

STEP_TYPE_SQL

public static final java.lang.String STEP_TYPE_SQL

Represents the <sql> element.

See Also:

Constant Field Values

STEP_TYPE_TASK

public static final java.lang.String STEP_TYPE_TASK

Represents the <task> element.

See Also:

Constant Field Values

Constructor Detail

UpdateLogEntry

public UpdateLogEntry()
               throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

UpdateLogEntry

public UpdateLogEntry(int actionno,
              java.lang.String actiontype,
              java.lang.String actionversionid,
              int groupno,
              java.lang.String steptype,
              java.lang.String stepdescription,
              int status)

Constructor setting the initial values.

Parameters:

actionno - The index of the action, (pre-update, update, and post-update count separately)

actiontype - The type of action

actionversionid - The version identifier of the action, not set for pre/post-update actions

groupno - The index of the group within the action (also set for pre/post-update actions)

steptype - The type of step

stepdescription - Descriptive text for the step

status - The step status

Since:

1.6

Method Detail

toString

public java.lang.String toString()

Overrides method java.lang.Object.toString.

Overrides:

toString in class java.lang.Object

Returns:

The identifier for the represented object or empty string

Since:

1.6

equals

public boolean equals(UpdateLogEntry tocheck)

Checks wether a given UpdateLog instance is equal to this.

Parameters:

tocheck - The instance to be compared

Returns:

The UpdateLog instance to check for equality

Since:

1.6

getActionNo

public int getActionNo()

Getter for the action index.

Returns:

The index

Since:

1.6

getActionType

public java.lang.String getActionType()

Getter for the action type.

Returns:

The type

Since:

1.6

getActionVersionId

public java.lang.String getActionVersionId()

Getter for the action version identifier.

Returns:

The identifier

Since:

1.6

getGroupNo

public int getGroupNo()

Getter for the group index.

Returns:

The index

Since:

1.6

getStepType

public java.lang.String getStepType()

Getter for the group index.

Returns:

The index

Since:

1.6

getStepDescription

public java.lang.String getStepDescription()

Getter for the step description.

Returns:

The description

Since:

1.6

getStatus

public int getStatus()

Getter for the step status.

Returns:

The status

Since:

1.6