org.xmlactions.db.actions

Class PK

java.lang.Object

org.xmlactions.action.actions.BaseAction

org.xmlactions.db.actions.BaseStorageField

org.xmlactions.db.actions.CommonStorageField

org.xmlactions.db.actions.PK

Direct Known Subclasses:

PKHtml

public class PK
extends CommonStorageField

Field Summary

Fields inherited from class org.xmlactions.action.actions.BaseAction

CHILD, CONTENT

Constructor Summary

Constructors

Constructor and Description
PK()

Method Summary

Modifier and Type	Method and Description
java.lang.String	execute(IExecContext execContext) Executes an action
java.lang.String	getPk_ref() Reference to sql that creates a PK value
java.lang.String	getPkCreateSql(Database database, java.lang.String dbSpecificName)
void	setPk_ref(java.lang.String pk_ref) Reference to sql that creates a PK value
java.lang.String	toString(int indent)
java.lang.String	validate(java.lang.String value) Validate the value against the configured settings.

Methods inherited from class org.xmlactions.db.actions.CommonStorageField

addBackLinkedFk, getAlias, getBackLinkedFks, getDate_format, getFunction_ref, getLength, getName, getName, getPattern, getPlaceholder, getPresentation_height, getPresentation_name, getPresentation_name, getPresentation_width, getQuery_sql, getRefFk, getRegex, getTooltip, getTooltip, isEditable, isMandatory, isUnique, setAlias, setDate_format, setEditable, setFunction_ref, setLength, setMandatory, setName, setPattern, setPlaceholder, setPresentation_height, setPresentation_name, setPresentation_width, setQuery_sql, setRefFk, setRegex, setTooltip, setUnique

Methods inherited from class org.xmlactions.db.actions.BaseStorageField

buildErrorString

Methods inherited from class org.xmlactions.action.actions.BaseAction

addChild, clearActions, doReplace, doReplace, getActions, getChild, getContent, getFirstValueFound, getParent, getReplacementContent, getReplacementMarker, isUsedForDisplay, processAction, setAction, setActions, setChild, setContent, setParent, setReplacementContent, setReplacementMarker, setUsedForDisplay

Methods inherited from class java.lang.Object

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

Constructor Detail

PK

public PK()

Method Detail

execute

public java.lang.String execute(IExecContext execContext)
                         throws java.lang.Exception

Description copied from class: BaseAction

Executes an action

Specified by:

execute in class BaseAction

Parameters:

execContext - the application execution context

Returns:

a String for replacement and to execute any child actions, else null to skip over child actions.

Throws:

java.lang.Exception

toString

public java.lang.String toString(int indent)

Specified by:

toString in class BaseStorageField

validate

public java.lang.String validate(java.lang.String value)

Description copied from class: BaseStorageField

Validate the value against the configured settings. Call this before attempting to store the value to the database

Specified by:

validate in class BaseStorageField

setPk_ref

public void setPk_ref(java.lang.String pk_ref)

Reference to sql that creates a PK value

getPk_ref

public java.lang.String getPk_ref()

Reference to sql that creates a PK value

getPkCreateSql

public java.lang.String getPkCreateSql(Database database,
                                       java.lang.String dbSpecificName)

Parameters:

database -

dbSpecificName -

Returns:

sql that creates a PK value