Package com.redwood.scheduler.api.model

Interface ObjectIndex

All Superinterfaces:

BusinessKeyObject, Detail, ObjectIndexComp, SchedulerEntity, SchedulerEntityComp

public interface ObjectIndex
extends ObjectIndexComp, Detail, BusinessKeyObject

Contains custom defined indexes

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ObjectIndex" 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<ObjectIndex>	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
ObjectIndexColumn	createObjectIndexColumn(ObjectFieldDefinition newObjectFieldDefinition)	Create a new ObjectIndexColumn linked to this object.
String	getDescription()	Get the value for Description.
String	getName()	Get the value for Name.
ObjectDefinition	getObjectDefinition()	Get the ObjectDefinition.
ObjectIndexColumn	getObjectIndexColumnByColumnOrder(Long columnOrder)	Get the ObjectIndexColumn by ObjectIndexColumnOrder.
RWIterable<ObjectIndexColumn>	getObjectIndexColumns()	Get an RWIterable over a collection of ObjectIndexColumns, the collection will be ordered by ColumnOrder.
String	getSearchName()	Get the value for SearchName.
boolean	isUnique()	Get the value for Unique.
void	setDescription(String newDescription)	Set the value for Description.
void	setName(String newName)	Set the value for Name.
void	setUnique(boolean newUnique)	Set the value for Unique.

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

See Also:

Constant Field Values

TYPE

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

getDescription

String getDescription()

Get the value for Description. (Optional description)

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.

getName

String getName()

Get the value for Name. (The name that can be used to refer to this index (the name of the actual index in the database is prefixed with C_ to ensure the names are unique)) 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.

getSearchName

String getSearchName()

Get the value for SearchName. (The name that can be used to refer to this index, in search case.) 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.

isUnique

boolean isUnique()

Get the value for Unique. (Flag stating that this index is an unique index, unique indexes can only be declared on custom objects)

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.

setDescription

void setDescription(String newDescription)

Set the value for Description. (Optional description) This value is optional.

Parameters:

newDescription - the new value for Description.

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.

setName

void setName(String newName)

Set the value for Name. (The name that can be used to refer to this index (the name of the actual index in the database is prefixed with C_ to ensure the names are unique)) This value is mandatory.

Parameters:

newName - the new value for Name. 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.

setUnique

void setUnique(boolean newUnique)

Set the value for Unique. (Flag stating that this index is an unique index, unique indexes can only be declared on custom objects)

Parameters:

newUnique - the new value for Unique.

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.

getObjectDefinition

ObjectDefinition getObjectDefinition()

Get the ObjectDefinition.

Returns:

ObjectDefinition

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.

getObjectIndexColumns

RWIterable<ObjectIndexColumn> getObjectIndexColumns()

Get an RWIterable over a collection of ObjectIndexColumns, the collection will be ordered by ColumnOrder. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The index to which this index column belongs

Specified by:

getObjectIndexColumns in interface ObjectIndexComp

Returns:

An RWIterable over a collection of ObjectIndexColumn objects , the collection will be ordered by ColumnOrder.

createObjectIndexColumn

ObjectIndexColumn createObjectIndexColumn(ObjectFieldDefinition newObjectFieldDefinition)

Create a new ObjectIndexColumn linked to this object.

Parameters:

newObjectFieldDefinition - The other parent of the ObjectIndexColumnObjectFieldDefinition association.

Returns:

a new ObjectIndexColumn.

getObjectIndexColumnByColumnOrder

ObjectIndexColumn getObjectIndexColumnByColumnOrder(Long columnOrder)

Get the ObjectIndexColumn by ObjectIndexColumnOrder.

Parameters:

columnOrder -

Returns:

the ObjectIndexColumn, or null if it could not be found