Package com.redwood.scheduler.api.model

Interface ObjectIndexColumn

All Superinterfaces:

Association, SchedulerEntity, SchedulerEntityComp

public interface ObjectIndexColumn
extends Association

Contains the columns for custom defined indexes

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ObjectIndexColumn" objects.
static QueryObjectType<ObjectIndexColumn>	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
Long	getColumnOrder()	Get the value for ColumnOrder.
ObjectFieldDefinition	getObjectFieldDefinition()	Get the ObjectFieldDefinition.
ObjectIndex	getObjectIndex()	Get the ObjectIndex.
void	setColumnOrder(Long newColumnOrder)	Set the value for ColumnOrder.

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<ObjectIndexColumn> TYPE

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

Method Detail

getColumnOrder

Long getColumnOrder()

Get the value for ColumnOrder. (The order of the columns in the index) 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.

setColumnOrder

void setColumnOrder(Long newColumnOrder)

Set the value for ColumnOrder. (The order of the columns in the index) 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.

getObjectIndex

ObjectIndex getObjectIndex()

Get the ObjectIndex.

Returns:

ObjectIndex

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.

getObjectFieldDefinition

ObjectFieldDefinition getObjectFieldDefinition()

Get the ObjectFieldDefinition.

Returns:

ObjectFieldDefinition

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.