Package com.redwood.scheduler.api.model

Interface MailConnectionSetting

All Superinterfaces:

Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface MailConnectionSetting
extends Detail, Readable

Connection settings.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "MailConnectionSetting" 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<MailConnectionSetting>	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
MailConnector	getMailConnector()	Get the MailConnector.
String	getPropertyName()	Get the value for PropertyName.
String	getPropertyValue()	Get the value for PropertyValue.
void	setPropertyName(String newPropertyName)	Set the value for PropertyName.
void	setPropertyValue(String newPropertyValue)	Set the value for PropertyValue.

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

See Also:

Constant Field Values

TYPE

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

getPropertyName

String getPropertyName()

Get the value for PropertyName. (Mail connection property. Please refer to java's com.sun.mail.imap package documentation for infos which properties could be set.) 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.

getPropertyValue

String getPropertyValue()

Get the value for PropertyValue. (Value for specified mail property.) 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.

setPropertyName

void setPropertyName(String newPropertyName)

Set the value for PropertyName. (Mail connection property. Please refer to java's com.sun.mail.imap package documentation for infos which properties could be set.) This value is mandatory.

Parameters:

newPropertyName - the new value for PropertyName. 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.

setPropertyValue

void setPropertyValue(String newPropertyValue)

Set the value for PropertyValue. (Value for specified mail property.) This value is mandatory.

Parameters:

newPropertyValue - the new value for PropertyValue. 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.

getMailConnector

MailConnector getMailConnector()

Get the MailConnector.

Returns:

MailConnector

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.