Package com.redwood.scheduler.api.model

Interface QueryConditionValue

All Superinterfaces:

Association, Readable, SchedulerEntity, SchedulerEntityComp

public interface QueryConditionValue
extends Association, Readable

Values provided by the user for the given QueryFilter / QueryCondition combination. When a QueryCondition is selected for a QueryFilter, a QueryConditionValue is created, with the appropriate values for the input fields the QueryCondition require.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "QueryConditionValue" 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<QueryConditionValue>	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
QueryConditionValueInclude	getInclude()	Get the value for Include.
QueryCondition	getQueryCondition()	Get the QueryCondition.
QueryFilter	getQueryFilter()	Get the QueryFilter.
String	getValue1()	Get the value for Value1.
String	getValue2()	Get the value for Value2.
void	setInclude(QueryConditionValueInclude newInclude)	Set the value for Include.
void	setValue1(String newValue1)	Set the value for Value1.
void	setValue2(String newValue2)	Set the value for Value2.

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

See Also:

Constant Field Values

TYPE

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

getInclude

QueryConditionValueInclude getInclude()

Get the value for Include. (Does this condition show (true) or hide (false) the objects that match the QueryConditions.) 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.

getValue1

String getValue1()

Get the value for Value1. (Value for the first field (if required by QueryCondition), or the default value if prompt1 is 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.

getValue2

String getValue2()

Get the value for Value2. (Value for the second field (if required by QueryCondition), or the default value if prompt2 is 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.

setInclude

void setInclude(QueryConditionValueInclude newInclude)

Set the value for Include. (Does this condition show (true) or hide (false) the objects that match the QueryConditions.) This value is mandatory.

Parameters:

newInclude - the new value for Include. 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.

setValue1

void setValue1(String newValue1)

Set the value for Value1. (Value for the first field (if required by QueryCondition), or the default value if prompt1 is true.) This value is optional.

Parameters:

newValue1 - the new value for Value1.

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.

setValue2

void setValue2(String newValue2)

Set the value for Value2. (Value for the second field (if required by QueryCondition), or the default value if prompt2 is true.) This value is optional.

Parameters:

newValue2 - the new value for Value2.

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.

getQueryCondition

QueryCondition getQueryCondition()

Get the QueryCondition.

Returns:

QueryCondition

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.

getQueryFilter

QueryFilter getQueryFilter()

Get the QueryFilter.

Returns:

QueryFilter

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.