Package com.redwood.scheduler.api.model

Interface ReportSort

All Superinterfaces:

BusinessKeyObject, Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface ReportSort
extends Detail, BusinessKeyObject, Readable

The sort order definition for a Report

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ReportSort" 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<ReportSort>	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
Report	getReport()	Get the Report.
ReportColumn	getReportColumn()	Get the ReportColumn.
Long	getSortOrder()	Get the value for SortOrder.
boolean	isAscending()	Get the value for Ascending.
void	setAscending(boolean newAscending)	Set the value for Ascending.
void	setReportColumn(ReportColumn newReportColumn)	Set the value for ReportColumn.
void	setSortOrder(Long newSortOrder)	Set the value for SortOrder.

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

getBusinessKey

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

See Also:

Constant Field Values

TYPE

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

getSortOrder

Long getSortOrder()

Get the value for SortOrder. (The priority ordered of the sort.) 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.

isAscending

boolean isAscending()

Get the value for Ascending. (Whether the sort is ascending or not.)

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.

setSortOrder

void setSortOrder(Long newSortOrder)

Set the value for SortOrder. (The priority ordered of the sort.) This value is mandatory.

Parameters:

newSortOrder - the new value for SortOrder. 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.

setAscending

void setAscending(boolean newAscending)

Set the value for Ascending. (Whether the sort is ascending or not.)

Parameters:

newAscending - the new value for Ascending.

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.

getReportColumn

ReportColumn getReportColumn()

Get the ReportColumn.

Returns:

ReportColumn

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.

setReportColumn

void setReportColumn(ReportColumn newReportColumn)

Set the value for ReportColumn. This value is mandatory.

Parameters:

newReportColumn - is the object to set ReportColumn to. The ReportColumn of this ReportSort If this is null, then the object cannot be persisted.