Package com.redwood.scheduler.api.model

Interface ImportRule

All Superinterfaces:

BusinessKeyObject, Detail, ImportRuleComp, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface ImportRule
extends ImportRuleComp, NamedDetailObject, BusinessKeyObject, Readable

Transformation to apply to objects after import. The set of child ImportMatchRules is used to select the objects which this rule applies to. (All ImportMatchRules must match the object.) The set of child ImportOverrideRules are then applied to each selected object. The object-types for all matches and overrides must be compatible.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ImportRule" 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<ImportRule>	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
void	apply(Iterator<? extends SchedulerEntity> entities)	Apply this rule to a collection of objects.
ImportMatchRule	createImportMatchRule(ImportRuleDefinition newImportRuleDefinition)	Create a new ImportMatchRule linked to this object.
ImportOverrideRule	createImportOverrideRule(ImportRuleDefinition newImportRuleDefinition)	Create a new ImportOverrideRule linked to this object.
RWIterable<ImportMatchRule>	getImportMatchRules()	Get an RWIterable over an ordered collection of ImportMatchRules.
RWIterable<ImportOverrideRule>	getImportOverrideRules()	Get an RWIterable over an ordered collection of ImportOverrideRules.
ImportRuleSet	getImportRuleSet()	Get the ImportRuleSet.

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

getBusinessKey

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

See Also:

Constant Field Values

TYPE

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

apply

void apply(Iterator<? extends SchedulerEntity> entities)
    throws com.redwood.scheduler.api.exception.ImportOverrideException

Apply this rule to a collection of objects.

Parameters:

entities - The objects the override will be applied to.

Throws:

com.redwood.scheduler.api.exception.ImportOverrideException - An import override rule could not be applied to an object.

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.

getImportMatchRules

RWIterable<ImportMatchRule> getImportMatchRules()

Get an RWIterable over an ordered collection of ImportMatchRules. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Parameters for a criterion/override for objects processed by the ImportRule.

Specified by:

getImportMatchRules in interface ImportRuleComp

Returns:

An RWIterable over an ordered collection of ImportMatchRule objects .

createImportMatchRule

ImportMatchRule createImportMatchRule(ImportRuleDefinition newImportRuleDefinition)

Create a new ImportMatchRule linked to this object.

Parameters:

newImportRuleDefinition - The other parent of the ImportMatchRuleImportRuleDefinition association.

Returns:

a new ImportMatchRule.

getImportOverrideRules

RWIterable<ImportOverrideRule> getImportOverrideRules()

Get an RWIterable over an ordered collection of ImportOverrideRules. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Parameters for a criterion/override for objects processed by the ImportRule.

Specified by:

getImportOverrideRules in interface ImportRuleComp

Returns:

An RWIterable over an ordered collection of ImportOverrideRule objects .

createImportOverrideRule

ImportOverrideRule createImportOverrideRule(ImportRuleDefinition newImportRuleDefinition)

Create a new ImportOverrideRule linked to this object.

Parameters:

newImportRuleDefinition - The other parent of the ImportOverrideRuleImportRuleDefinition association.

Returns:

a new ImportOverrideRule.