public interface

History

implements KnowledgebaseObject
vars.knowledgebase.History
Known Indirect Subclasses

Summary

Constants
String ACTION_ADD String representation of the add action.
String ACTION_DELETE String representation of the delete action.
String ACTION_REJECT Prefix for action that has been rejected.
String ACTION_REPLACE String representation of the replace action.
String FIELD_CONCEPT Field description
String FIELD_CONCEPTNAME
String FIELD_CONCEPTNAME_AUTHOR
String FIELD_CONCEPTNAME_PRIMARY
String FIELD_CONCEPT_CHILD
String FIELD_CONCEPT_NODCCODE
String FIELD_CONCEPT_ORIGINATOR
String FIELD_CONCEPT_PARENT
String FIELD_CONCEPT_RANKLEVEL
String FIELD_CONCEPT_RANKNAME
String FIELD_CONCEPT_REFERENCE
String FIELD_CONCEPT_STRUCTURETYPE
String FIELD_LINKREALIZATION
String FIELD_LINKTEMPLATE
String FIELD_MEDIA
String FIELD_SECTIONINFO
Date NOT_APPROVED Special Date used to indicate the approval Date has not been set.
String PROP_ACTION
String PROP_APPROVAL_DATE
String PROP_APPROVER_NAME
String PROP_COMMENT
String PROP_CREATION_DATE
String PROP_CREATOR_NAME
String PROP_FIELD
String PROP_NEW_VALUE
String PROP_OLD_VALUE
Public Methods
abstract String getAction()
Gets the action of this History as a String.
abstract String getComment()
Method description
abstract ConceptMetadata getConceptMetadata()
Not for Developer use.
abstract Date getCreationDate()
Gets the creation date of this History.
abstract String getCreatorName()
Gets the previous value of the field name from the description of this History.
abstract String getField()
abstract String getNewValue()
Method description
abstract String getOldValue()
Method description
abstract Date getProcessedDate()
Gets the date that this History was processed (i.e.
abstract String getProcessorName()
abstract boolean isAdd()
Determines whether the action of this History is an add.
abstract Boolean isApproved()
Gets whether this History has been approved.
abstract boolean isDelete()
Determines whether the action of this History is a delete.
abstract boolean isProcessed()
abstract boolean isRejected()
Determines whether this History was rejected.
abstract boolean isReplace()
Determines whether the action of this History is a replace.
abstract void setAction(String action)
Method description
abstract void setApproved(Boolean approved)
Method description
abstract void setComment(String comment)
Method description
abstract void setCreationDate(Date creationDate)
Sets the Date the user created this History.
abstract void setCreatorName(String creatorName)
Sets the name of the user that created this History.
abstract void setField(String field)
Method description
abstract void setNewValue(String newValue)
Method description
abstract void setOldValue(String oldValue)
Method description
abstract void setProcessedDate(Date approvalDate)
Sets the approval Date this History.
abstract void setProcessorName(String approverName)
abstract String stringValue()
[Expand]
Inherited Methods
From interface vars.VARSObject

Constants

public static final String ACTION_ADD

String representation of the add action.

Constant Value: "ADD"

public static final String ACTION_DELETE

String representation of the delete action.

Constant Value: "DELETE"

public static final String ACTION_REJECT

Prefix for action that has been rejected.

Constant Value: "REJECT:"

public static final String ACTION_REPLACE

String representation of the replace action.

Constant Value: "REPLACE"

public static final String FIELD_CONCEPT

Field description

Constant Value: "Concept"

public static final String FIELD_CONCEPTNAME

Constant Value: "ConceptName"

public static final String FIELD_CONCEPTNAME_AUTHOR

Constant Value: "ConceptName.author"

public static final String FIELD_CONCEPTNAME_PRIMARY

Constant Value: "Concept.primaryConceptName"

public static final String FIELD_CONCEPT_CHILD

Constant Value: "Concept.child"

public static final String FIELD_CONCEPT_NODCCODE

Constant Value: "NodcCode"

public static final String FIELD_CONCEPT_ORIGINATOR

Constant Value: "Originator"

public static final String FIELD_CONCEPT_PARENT

Constant Value: "Concept.parent"

public static final String FIELD_CONCEPT_RANKLEVEL

Constant Value: "RankLevel"

public static final String FIELD_CONCEPT_RANKNAME

Constant Value: "RankName"

public static final String FIELD_CONCEPT_REFERENCE

Constant Value: "Reference"

public static final String FIELD_CONCEPT_STRUCTURETYPE

Constant Value: "StructureType"

public static final String FIELD_LINKREALIZATION

Constant Value: "LinkRealization"

public static final String FIELD_LINKTEMPLATE

Constant Value: "LinkTemplate"

public static final String FIELD_MEDIA

Constant Value: "Media"

public static final String FIELD_SECTIONINFO

Constant Value: "SectionInfo"

public static final Date NOT_APPROVED

Special Date used to indicate the approval Date has not been set.

public static final String PROP_ACTION

Constant Value: "action"

public static final String PROP_APPROVAL_DATE

Constant Value: "approvalDate"

public static final String PROP_APPROVER_NAME

Constant Value: "approverName"

public static final String PROP_COMMENT

Constant Value: "comment"

public static final String PROP_CREATION_DATE

Constant Value: "creationDate"

public static final String PROP_CREATOR_NAME

Constant Value: "creatorName"

public static final String PROP_FIELD

Constant Value: "field"

public static final String PROP_NEW_VALUE

Constant Value: "newValue"

public static final String PROP_OLD_VALUE

Constant Value: "oldValue"

Public Methods

public abstract String getAction ()

Gets the action of this History as a String.

Returns
  • The action of this History.

public abstract String getComment ()

Method description

public abstract ConceptMetadata getConceptMetadata ()

Not for Developer use. This is required for Castor/DAO

Returns
  • The conceptDelegate value

public abstract Date getCreationDate ()

Gets the creation date of this History.

Returns
  • The creation date of this History.

public abstract String getCreatorName ()

Gets the previous value of the field name from the description of this History. This value represents the value of the field name before the action occurred.

Returns
  • The previous value of the field name from the description of this History.

public abstract String getField ()

public abstract String getNewValue ()

Method description

public abstract String getOldValue ()

Method description

public abstract Date getProcessedDate ()

Gets the date that this History was processed (i.e. approved or rejected.

Returns
  • The approval date of this History.

public abstract String getProcessorName ()

Returns
  • the Username of whoever processed this history

public abstract boolean isAdd ()

Determines whether the action of this History is an add.

Returns
  • true if the action of this History is an add.

public abstract Boolean isApproved ()

Gets whether this History has been approved.

Returns
  • true if this History has been approved.

public abstract boolean isDelete ()

Determines whether the action of this History is a delete.

Returns
  • true if the action of this History is a delete.

public abstract boolean isProcessed ()

Returns
  • true if this History has already been process (i.e. approved or rejected

public abstract boolean isRejected ()

Determines whether this History was rejected.

Returns
  • true if this History was rejected.

public abstract boolean isReplace ()

Determines whether the action of this History is a replace.

Returns
  • true if the action of this History is an replace.

public abstract void setAction (String action)

Method description

public abstract void setApproved (Boolean approved)

Method description

public abstract void setComment (String comment)

Method description

public abstract void setCreationDate (Date creationDate)

Sets the Date the user created this History. Necessary for Castor. Developers should use appropriate constructor.

Parameters
creationDate The Date the user created this History.

public abstract void setCreatorName (String creatorName)

Sets the name of the user that created this History.

Parameters
creatorName The name of the user that created this History.

public abstract void setField (String field)

Method description

public abstract void setNewValue (String newValue)

Method description

public abstract void setOldValue (String oldValue)

Method description

public abstract void setProcessedDate (Date approvalDate)

Sets the approval Date this History. DO NOT CALL THIS DIRECTLY! USE approve() INSTEAD.

Parameters
approvalDate The approval Data of this History.

public abstract void setProcessorName (String approverName)

Parameters
approverName the approverName to set

public abstract String stringValue ()