Package com.redwood.scheduler.api.model

Interface ImportActionParameter

All Superinterfaces:

Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface ImportActionParameter
extends NamedDetailObject, Readable

Parameters defined for an import action Parameters enable you to parameterize the action to execute for an import rule set.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ImportActionParameter" 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<ImportActionParameter>	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
String	getDefaultValue()	Get the value for DefaultValue.
ImportRuleSet	getImportRuleSet()	Get the ImportRuleSet.
boolean	isNullable()	Get the value for Nullable.
void	setDefaultValue(String newDefaultValue)	Set the value for DefaultValue.
void	setNullable(boolean newNullable)	Set the value for Nullable.

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

getComment, getDescription, getName, getSearchName, setComment, setDescription, setName

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

See Also:

Constant Field Values

TYPE

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

getDefaultValue

String getDefaultValue()

Get the value for DefaultValue. (The parameter default value.)

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.

isNullable

boolean isNullable()

Get the value for Nullable. (Is the parameter optional?)

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.

setDefaultValue

void setDefaultValue(String newDefaultValue)

Set the value for DefaultValue. (The parameter default value.) This value is optional.

Parameters:

newDefaultValue - the new value for DefaultValue.

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.

setNullable

void setNullable(boolean newNullable)

Set the value for Nullable. (Is the parameter optional?)

Parameters:

newNullable - the new value for Nullable.

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.

getImportRuleSet

ImportRuleSet getImportRuleSet()

Get the ImportRuleSet.

Returns:

ImportRuleSet

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.