Package com.redwood.scheduler.api.model

Interface ReportColumn

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface ReportColumn
extends NamedDetailObject, BusinessKeyObject, Readable

A column for the definition of the Report

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ReportColumn" 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<ReportColumn>	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
ReportColumnFormat	getColumnFormat()	Get the value for ColumnFormat.
Long	getColumnOrder()	Get the value for ColumnOrder.
Report	getReport()	Get the Report.
String	getValue()	Get the value for Value.
boolean	isDisplay()	Get the value for Display.
void	setColumnFormat(ReportColumnFormat newColumnFormat)	Set the value for ColumnFormat.
void	setColumnOrder(Long newColumnOrder)	Set the value for ColumnOrder.
void	setDisplay(boolean newDisplay)	Set the value for Display.
void	setValue(String newValue)	Set the value for Value.

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

getBusinessKey

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

getComment, getDescription, getName, getSearchName, setComment, setDescription, setName

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 "ReportColumn" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<ReportColumn> 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

isDisplay

boolean isDisplay()

Get the value for Display. (Whether this column is displayed or not. Defaults to true.)

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.

getColumnFormat

ReportColumnFormat getColumnFormat()

Get the value for ColumnFormat. (The format for the column.)

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.

getValue

String getValue()

Get the value for Value. (The Query Column value or an Expression for determining 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.

getColumnOrder

Long getColumnOrder()

Get the value for ColumnOrder. (The ordered position of the column.) 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.

setDisplay

void setDisplay(boolean newDisplay)

Set the value for Display. (Whether this column is displayed or not. Defaults to true.)

Parameters:

newDisplay - the new value for Display.

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.

setColumnFormat

void setColumnFormat(ReportColumnFormat newColumnFormat)

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

Parameters:

newColumnFormat - the new value for ColumnFormat.

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.

setValue

void setValue(String newValue)

Set the value for Value. (The Query Column value or an Expression for determining the column value) This value is optional.

Parameters:

newValue - the new value for Value.

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.

setColumnOrder

void setColumnOrder(Long newColumnOrder)

Set the value for ColumnOrder. (The ordered position of the column.) This value is mandatory.

Parameters:

newColumnOrder - the new value for ColumnOrder. 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.

getReport

Report getReport()

Get the Report.

Returns:

Report

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.