Package com.redwood.scheduler.api.model

Interface ExportRuleItem

All Superinterfaces:

Detail, ExportRuleItemComp, ExportRuleSetComponent, Readable, SchedulerEntity, SchedulerEntityComp

public interface ExportRuleItem
extends ExportRuleItemComp, Detail, ExportRuleSetComponent, Readable

The export item which is manually selected by the users and is part of a fixed list of exported objects. Sibling objects can be of any SchedulerEntity type.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ExportRuleItem" 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<ExportRuleItem>	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.
SchedulerEntity	getExportObject()	Get the value for ExportObject.
ExportRuleSet	getExportRuleSet()	Get the ExportRuleSet.
RWIterable<SchedulerEntity>	getItemsToExport()	This method returns a RWIterable with all of the items that this ExportRuleItem would add to the ExportRuleSet.
ObjectDefinition	getObjectDefinition()	Get the ObjectDefinition.
boolean	isExportContents()	Get the value for ExportContents.
void	setExportContents(boolean newExportContents)	Set the value for ExportContents.
void	setExportObject(SchedulerEntity newExportObject)	Set the value for ExportObject.
void	setObjectDefinition(ObjectDefinition newObjectDefinition)	Set the value for ObjectDefinition.

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

See Also:

Constant Field Values

TYPE

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

getExportObject

SchedulerEntity getExportObject()

Get the value for ExportObject. (The object that will be exported.) 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.

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:

isExportContents(), ExportRule.isExportContents()

setExportObject

void setExportObject(SchedulerEntity newExportObject)

Set the value for ExportObject. (The object that will be exported.) This value is mandatory.

Parameters:

newExportObject - the new value for ExportObject. 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.

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:

setExportContents(boolean), ExportRule.setExportContents(boolean)

getItemsToExport

RWIterable<SchedulerEntity> getItemsToExport()

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

Specified by:

getItemsToExport in interface ExportRuleItemComp

Specified by:

getItemsToExport in interface ExportRuleSetComponent

Returns:

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

See Also:

getItemsToExport(), ExportRule.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.

getObjectDefinition

ObjectDefinition getObjectDefinition()

Get the ObjectDefinition.

Returns:

ObjectDefinition

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.

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:

getExportRuleSet(), ExportRule.getExportRuleSet()

setObjectDefinition

void setObjectDefinition(ObjectDefinition newObjectDefinition)

Set the value for ObjectDefinition. This value is mandatory.

Parameters:

newObjectDefinition - is the object to set ObjectDefinition to. The ObjectDefinition for the ExportRuleItem If this is null, then the object cannot be persisted.