Package com.redwood.scheduler.api.model

Interface Export

All Superinterfaces:

Root, SchedulerEntity, SchedulerEntityComp, WrappedJob

public interface Export
extends WrappedJob

An export of a set of objects. An export is performed using a system job. This object acts as a place-holder to gather up the exports scheduled and completed for this system.

Field Summary

Fields

Modifier and Type	Field	Description
static String	JOB_DEFINITION_NAME	The name of the job definition that does the export.
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "Export" objects.
static String	SEC_PRIV_MANAGE	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: view , manage
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<Export>	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
RequiredPermission	checkManagePrivilege()	Check whether or not the manage action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
JobFile	getArchiveJobFile()	Get the ArchiveJobFile.
Long	getExportId()	Get the value for ExportId.
ExportRuleSet	getExportRuleSet()	Get the value for ExportRuleSet.
void	setArchiveJobFile(JobFile newArchiveJobFile)	Set the value for ArchiveJobFile.
void	setExportRuleSet(ExportRuleSet newExportRuleSet)	Set the value for ExportRuleSet.

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

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

getComment, getDescription, getIsolationGroup, getJob, getRequestedStartTime, getWrappedJob, getWrappedJobDefinition, setComment, setDescription, setIsolationGroup, setRequestedStartTime, setWrappedJobDefinition

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "Export" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<Export> TYPE

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

JOB_DEFINITION_NAME

static final String JOB_DEFINITION_NAME

The name of the job definition that does the export.

See Also:

Constant Field Values

SEC_PRIV_VIEW

static final String SEC_PRIV_VIEW

This privilege can be granted at a group level.

See Also:

Constant Field Values

SEC_PRIV_MANAGE

static final String SEC_PRIV_MANAGE

This privilege can be granted at a group 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_VIEW

static final String SEC_RANK_VIEW

This rank is made of the following privileges: view

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges: view , manage

See Also:

Constant Field Values

Method Detail

getExportId

Long getExportId()

Get the value for ExportId. (The Export ID for this Export. This is unique for every Export.) 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.

getExportRuleSet

ExportRuleSet getExportRuleSet()

Get the value for ExportRuleSet. (The ExportRuleSet that is used for the export.) 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.

setExportRuleSet

void setExportRuleSet(ExportRuleSet newExportRuleSet)

Set the value for ExportRuleSet. (The ExportRuleSet that is used for the export.) This value is mandatory.

Parameters:

newExportRuleSet - the new value for ExportRuleSet. 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.

getArchiveJobFile

JobFile getArchiveJobFile()

Get the ArchiveJobFile.

Returns:

ArchiveJobFile

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.

setArchiveJobFile

void setArchiveJobFile(JobFile newArchiveJobFile)

Set the value for ArchiveJobFile. This value is optional.

Parameters:

newArchiveJobFile - is the object to set ArchiveJobFile to. The jobfile containing the archive that results from the export.

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.

checkManagePrivilege

RequiredPermission checkManagePrivilege()

Check whether or not the manage 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.