Package com.redwood.scheduler.api.model

Interface ExportRule

All Superinterfaces:

BusinessKeyObject, Detail, ExportRuleComp, ExportRuleSetComponent, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface ExportRule
extends ExportRuleComp, NamedDetailObject, ExportRuleSetComponent, BusinessKeyObject, Readable

A rule that defines a set of objects to include in an object. The objects covered by a rule are always of the same type. The set of objects is those which match the associated QueryFilter.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ExportRule" 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<ExportRule>	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	getDescriptionTranslationKey()	a description that is useful for display purposes.
ExportRuleSet	getExportRuleSet()	Get the ExportRuleSet.
QueryFilter	getFilter()	Get the value for Filter.
ObjectDefinition	getFilterObjectType()	Get the value for FilterObjectType.
RWIterable<SchedulerEntity>	getItemsToExport()	This method returns a RWIterable with all of the items that this ExportRule would add to the ExportRuleSet.
boolean	isExportContents()	Get the value for ExportContents.
void	setExportContents(boolean newExportContents)	Set the value for ExportContents.
void	setFilterObjectType(ObjectDefinition newFilterObjectType)	Set the value for FilterObjectType.

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

See Also:

Constant Field Values

TYPE

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

getFilterObjectType

ObjectDefinition getFilterObjectType()

Get the value for FilterObjectType. (This is the object type for the objects to be filtered by this rule. Note that setting a new object type will create a QueryFilter if there no QueryFilter was set. All conditions that were already specified will be removed if the object type is changed. )

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.

isExportContents

boolean isExportContents()

Get the value for ExportContents. (Set whether the items should be exported recursively. )

Specified by:

isExportContents in interface ExportRuleSetComponent

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.

See Also:

ExportRuleItem.isExportContents(), isExportContents()

getFilter

QueryFilter getFilter()

Get the value for Filter. (Which query-filter this rule uses to select objects for export.)

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.

setFilterObjectType

void setFilterObjectType(ObjectDefinition newFilterObjectType)

Set the value for FilterObjectType. (This is the object type for the objects to be filtered by this rule. Note that setting a new object type will create a QueryFilter if there no QueryFilter was set. All conditions that were already specified will be removed if the object type is changed. ) This value is optional.

Parameters:

newFilterObjectType - the new value for FilterObjectType.

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.

setExportContents

void setExportContents(boolean newExportContents)

Set the value for ExportContents. (Set whether the items should be exported recursively. )

Specified by:

setExportContents in interface ExportRuleSetComponent

Parameters:

newExportContents - the new value for ExportContents.

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.

See Also:

ExportRuleItem.setExportContents(boolean), setExportContents(boolean)

getItemsToExport

RWIterable<SchedulerEntity> getItemsToExport()

This method returns a RWIterable with all of the items that this ExportRule would add to the ExportRuleSet.

Specified by:

getItemsToExport in interface ExportRuleComp

Specified by:

getItemsToExport in interface ExportRuleSetComponent

Returns:

The set of all items that would be exported by this ExportRuleSet

See Also:

ExportRuleItem.getItemsToExport(), getItemsToExport()

getDescriptionTranslationKey

String getDescriptionTranslationKey()

a description that is useful for display purposes. This might need translating by being passed to SchedulerSession.translateField(String).

Specified by:

getDescriptionTranslationKey in interface ExportRuleSetComponent

Returns:

either a description of this component or a translation key for the description of this component.

getExportRuleSet

ExportRuleSet getExportRuleSet()

Get the ExportRuleSet.

Specified by:

getExportRuleSet in interface ExportRuleSetComponent

Returns:

ExportRuleSet

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.

See Also:

ExportRuleItem.getExportRuleSet(), getExportRuleSet()