Package com.redwood.scheduler.api.model

Interface ReportSelection

All Superinterfaces:

Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface ReportSelection
extends Detail, Readable

The selection criteria for the results of a Report

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ReportSelection" 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<ReportSelection>	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
JobDefinitionParameter	getJobDefinitionParameter()	Get the JobDefinitionParameter.
ReportColumn	getLeftReportColumn()	Get the LeftReportColumn.
ReportSelectionOperation	getOperation()	Get the value for Operation.
Report	getReport()	Get the Report.
ReportColumn	getRightReportColumn()	Get the RightReportColumn.
String	getValue()	Get the value for Value.
void	setJobDefinitionParameter(JobDefinitionParameter newJobDefinitionParameter)	Set the value for JobDefinitionParameter.
void	setLeftReportColumn(ReportColumn newLeftReportColumn)	Set the value for LeftReportColumn.
void	setOperation(ReportSelectionOperation newOperation)	Set the value for Operation.
void	setRightReportColumn(ReportColumn newRightReportColumn)	Set the value for RightReportColumn.
void	setValue(String newValue)	Set the value for Value.

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

See Also:

Constant Field Values

TYPE

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

getOperation

ReportSelectionOperation getOperation()

Get the value for Operation. (The operation to execute on this selection.) 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.

getValue

String getValue()

Get the value for Value. (The optional value to compare the LeftReportColumn against.)

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.

setOperation

void setOperation(ReportSelectionOperation newOperation)

Set the value for Operation. (The operation to execute on this selection.) This value is mandatory.

Parameters:

newOperation - the new value for Operation. 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.

setValue

void setValue(String newValue)

Set the value for Value. (The optional value to compare the LeftReportColumn against.) 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.

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.

getLeftReportColumn

ReportColumn getLeftReportColumn()

Get the LeftReportColumn.

Returns:

LeftReportColumn

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.

getRightReportColumn

ReportColumn getRightReportColumn()

Get the RightReportColumn.

Returns:

RightReportColumn

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.

getJobDefinitionParameter

JobDefinitionParameter getJobDefinitionParameter()

Get the JobDefinitionParameter.

Returns:

JobDefinitionParameter

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.

setLeftReportColumn

void setLeftReportColumn(ReportColumn newLeftReportColumn)

Set the value for LeftReportColumn. This value is mandatory.

Parameters:

newLeftReportColumn - is the object to set LeftReportColumn to. The left hand ReportColumn of this ReportSelection operation. If this is null, then the object cannot be persisted.

setRightReportColumn

void setRightReportColumn(ReportColumn newRightReportColumn)

Set the value for RightReportColumn. This value is optional.

Parameters:

newRightReportColumn - is the object to set RightReportColumn to. The right hand ReportColumn of this ReportSelection operation.

setJobDefinitionParameter

void setJobDefinitionParameter(JobDefinitionParameter newJobDefinitionParameter)

Set the value for JobDefinitionParameter. This value is optional.

Parameters:

newJobDefinitionParameter - is the object to set JobDefinitionParameter to. The right hand ReportColumn of this ReportSelection operation.