Package com.redwood.scheduler.api.model

Interface TableValue

All Superinterfaces:

Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface TableValue
extends Detail, Readable

A value in a user defined table.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "TableValue" objects.
static String	SEC_RANK_ALL	This rank is made of the following privileges:
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static QueryObjectType<TableValue>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
String	getColumnName()	Get the value for ColumnName.
String	getColumnValue()	Get the value for ColumnValue.
String	getKey()	Get the value for Key.
String	getSearchColumnName()	Get the value for SearchColumnName.
String	getSearchKey()	Get the value for SearchKey.
Table	getTable()	Get the Table.
void	setColumnName(String newColumnName)	Set the value for ColumnName.
void	setColumnValue(String newColumnValue)	Set the value for ColumnValue.
void	setKey(String newKey)	Set the value for Key.
void	setSearchKey(String newSearchKey)	Set the value for SearchKey.

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "TableValue" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<TableValue> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges:

See Also:

Constant Field Values

Method Detail

getKey

String getKey()

Get the value for Key. (The row key.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getSearchKey

String getSearchKey()

Get the value for SearchKey. (The row search key.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getColumnName

String getColumnName()

Get the value for ColumnName. (The column name.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getSearchColumnName

String getSearchColumnName()

Get the value for SearchColumnName. (The column search name.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getColumnValue

String getColumnValue()

Get the value for ColumnValue. (The column value.)

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setKey

void setKey(String newKey)

Set the value for Key. (The row key.) This value is mandatory.

Parameters:

newKey - the new value for Key. If this is null, then the object cannot be persisted.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setSearchKey

void setSearchKey(String newSearchKey)

Set the value for SearchKey. (The row search key.) This value is mandatory.

Parameters:

newSearchKey - the new value for SearchKey. If this is null, then the object cannot be persisted.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setColumnName

void setColumnName(String newColumnName)

Set the value for ColumnName. (The column name.) This value is mandatory.

Parameters:

newColumnName - the new value for ColumnName. If this is null, then the object cannot be persisted.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

setColumnValue

void setColumnValue(String newColumnValue)

Set the value for ColumnValue. (The column value.) This value is optional.

Parameters:

newColumnValue - the new value for ColumnValue.

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getTable

Table getTable()

Get the Table.

Returns:

Table

Throws:

com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.