Package com.redwood.scheduler.api.model

Interface CommonImportRule

All Superinterfaces:

Association, SchedulerEntity, SchedulerEntityComp

All Known Subinterfaces:

ImportMatchRule, ImportOverrideRule

public interface CommonImportRule
extends Association

Common base-class for import rules. This class acts as a container for a sequence of values. These values act as parameters that are used by the concrete classes.

Field Summary

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	getArgumentCount()	Get the value for ArgumentCount.
String	getArgumentDescription(Long index)	Obtain a description for an argument.
ImportRule	getImportRule()	Get the ImportRule.
ImportRuleDefinition	getImportRuleDefinition()	Retrieve the underlying ImportRuleDefinition.
String	getVar1()	Get the value for Var1.
String	getVar2()	Get the value for Var2.
void	setVar1(String newVar1)	Set the value for Var1.
void	setVar2(String newVar2)	Set the value for Var2.

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

Method Detail

getArgumentCount

Long getArgumentCount()

Get the value for ArgumentCount. (How many arguments are expected for this object.) 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.

getVar1

String getVar1()

Get the value for Var1. (Variable 1)

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.

getVar2

String getVar2()

Get the value for Var2. (Variable 2)

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.

setVar1

void setVar1(String newVar1)

Set the value for Var1. (Variable 1) This value is optional.

Parameters:

newVar1 - the new value for Var1.

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.

setVar2

void setVar2(String newVar2)

Set the value for Var2. (Variable 2) This value is optional.

Parameters:

newVar2 - the new value for Var2.

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.

getArgumentDescription

String getArgumentDescription(Long index)

Obtain a description for an argument.

Parameters:

index - Index (zero-based) of the argument whose description is sought.

Returns:

Translatable description of the argument field, or null if the argument is neither expected nor used.

getImportRuleDefinition

ImportRuleDefinition getImportRuleDefinition()

Retrieve the underlying ImportRuleDefinition.

Returns:

ImportRuleDefinition

getImportRule

ImportRule getImportRule()

Get the ImportRule.

Returns:

ImportRule

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.