Package com.redwood.scheduler.api.model

Interface ExportRuleSet

All Superinterfaces:

ApplicationObject, BusinessKeyObject, ExportRuleSetComp, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, Readable, Root, SchedulerEntity, SchedulerEntityComp, UniqueNamedApplicationObject

public interface ExportRuleSet
extends ExportRuleSetComp, UniqueNamedApplicationObject, Readable

Set of rules that define what should be included in an export. During export a union of the objects covered by the export rules for this ExportRuleSet will be included in the export.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ExportRuleSet" objects.
static String	SEC_PRIV_CREATE	This privilege can be granted at a group level.
static String	SEC_PRIV_DELETE	This privilege can be granted at a group level.
static String	SEC_PRIV_EDIT	This privilege can be granted at a group level.
static String	SEC_PRIV_VIEW	This privilege can be granted at a group level.
static String	SEC_RANK_ALL	This rank is made of the following privileges: create , view , edit , delete
static String	SEC_RANK_CREATE	This rank is made of the following privileges: create
static String	SEC_RANK_DELETE	This rank is made of the following privileges: create , view , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: create , view , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<ExportRuleSet>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

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

COPYRIGHT_MESSAGE_BKO, ID_BKO

Fields inherited from interface com.redwood.scheduler.api.model.Readable

COPYRIGHT_MESSAGE_E, ID_E

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
RequiredPermission	checkCreatePrivilege()	Check whether or not the create action can be performed on this object.
RequiredPermission	checkDeletePrivilege()	Check whether or not the delete action can be performed on this object.
RequiredPermission	checkEditPrivilege()	Check whether or not the edit action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
ExportRule	createExportRule()	Create a new ExportRule linked to this object.
ExportRuleItem	createExportRuleItem()	Create a new ExportRuleItem linked to this object.
RWIterable<com.redwood.scheduler.api.export.ExportedItem>	getExportedItems()	This method returns a RWIterable with all the items that this ExportRuleSet would export.
ExportRule	getExportRuleByName(String name)	Get the ExportRule by NameExportRuleSet.
RWIterable<ExportRuleItem>	getExportRuleItems()	Get an RWIterable over a collection of ExportRuleItems, the collection will be ordered by UniqueId.
RWIterable<ExportRule>	getExportRules()	Get an RWIterable over a collection of ExportRules, the collection will be ordered by UniqueId.
RWIterable<Export>	getExports()	Get an RWIterable over an ordered collection of Exports.
void	setDefaultPromotionName()	Sets the default name for a promotion ExportRuleSet Sets the default name for a promotion ExportRuleSet

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

getParentApplication, setParentApplication

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

getBusinessKey

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

createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

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

createObjectTag, getEditablePartitions, getObjectTagByObjectTagDefinition, getObjectTags, getPartition, setPartition

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

getCreationTime, getLastModificationTime, getLastModifierSubject

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<ExportRuleSet> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_PRIV_CREATE

static final String SEC_PRIV_CREATE

This privilege can be granted at a group level.

See Also:

Constant Field Values

SEC_PRIV_VIEW

static final String SEC_PRIV_VIEW

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_EDIT

static final String SEC_PRIV_EDIT

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_DELETE

static final String SEC_PRIV_DELETE

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_CREATE

static final String SEC_RANK_CREATE

This rank is made of the following privileges: create

See Also:

Constant Field Values

SEC_RANK_VIEW

static final String SEC_RANK_VIEW

This rank is made of the following privileges: view

See Also:

Constant Field Values

SEC_RANK_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: create , view , edit

See Also:

Constant Field Values

SEC_RANK_DELETE

static final String SEC_RANK_DELETE

This rank is made of the following privileges: create , view , delete

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges: create , view , edit , delete

See Also:

Constant Field Values

Method Detail

setDefaultPromotionName

void setDefaultPromotionName()

Sets the default name for a promotion ExportRuleSet Sets the default name for a promotion ExportRuleSet

getExportedItems

RWIterable<com.redwood.scheduler.api.export.ExportedItem> getExportedItems()

This method returns a RWIterable with all the items that this ExportRuleSet would export.

Specified by:

getExportedItems in interface ExportRuleSetComp

Returns:

Returns an RWIterable <ExportedItem> with all items that should be exported with this exportRuleSet. The items come from the list of items and the rules of this exportRuleSet.

getExports

RWIterable<Export> getExports()

Get an RWIterable over an ordered collection of Exports. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Export rule-set defining what to include in this export.

Specified by:

getExports in interface ExportRuleSetComp

Returns:

An RWIterable over an ordered collection of Export objects .

getExportRuleItems

RWIterable<ExportRuleItem> getExportRuleItems()

Get an RWIterable over a collection of ExportRuleItems, the collection will be ordered by UniqueId. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Export rule item, allows a fixed set of objects to be exported.

Specified by:

getExportRuleItems in interface ExportRuleSetComp

Returns:

An RWIterable over a collection of ExportRuleItem objects , the collection will be ordered by UniqueId.

createExportRuleItem

ExportRuleItem createExportRuleItem()

Create a new ExportRuleItem linked to this object.

Returns:

a new ExportRuleItem.

getExportRules

RWIterable<ExportRule> getExportRules()

Get an RWIterable over a collection of ExportRules, the collection will be ordered by UniqueId. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Set of ExportRules that make up the ExportRuleSet.

Specified by:

getExportRules in interface ExportRuleSetComp

Returns:

An RWIterable over a collection of ExportRule objects , the collection will be ordered by UniqueId.

createExportRule

ExportRule createExportRule()

Create a new ExportRule linked to this object.

Returns:

a new ExportRule.

getExportRuleByName

ExportRule getExportRuleByName(String name)

Get the ExportRule by NameExportRuleSet.

Parameters:

name -

Returns:

the ExportRule, or null if it could not be found

checkCreatePrivilege

RequiredPermission checkCreatePrivilege()

Check whether or not the create action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkViewPrivilege

RequiredPermission checkViewPrivilege()

Check whether or not the view action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkEditPrivilege

RequiredPermission checkEditPrivilege()

Check whether or not the edit action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkDeletePrivilege

RequiredPermission checkDeletePrivilege()

Check whether or not the delete action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.