Package com.redwood.scheduler.api.model

Interface NamedDetailObject

All Superinterfaces:

Detail, SchedulerEntity, SchedulerEntityComp

All Known Subinterfaces:

BuiltInWebService, ExportRule, ImportActionParameter, ImportRule, JARFile, JobChainStep, JobDefinitionForm, JobDefinitionParameter, JobDefinitionRuntimeLimit, JobRuntimeLimit, MonitorCondition, MonitorValue, ProcessMonitorItem, ProcessMonitorItemDefinition, ProcessServerCheck, PublishedWebService, R2WCatalogAlias, ReportColumn, SAPAbapProgram, SAPAbapProgramParameter, SAPAbapVariant, SAPAbapVariantParameter, SAPAbapVariantParameterValue, SAPAbapVariantSelopt, SAPApplicationServer, SAPApplicationServerGroup, SAPArchiveDocumentType, SAPArchiveObject, SAPBatchEvent, SAPExternalCommand, SAPInfoPackage, SAPInfoPackageGroup, SAPInfoPackageGroupStep, SAPLanguage, SAPMassActivity, SAPMassActivityFieldParameter, SAPMassActivityFieldTable, SAPMassActivityFieldTableRowValue, SAPMassActivityLayoutField, SAPMassActivityObject, SAPMassActivityParameter, SAPMassActivityParameterSet, SAPMassActivityStructure, SAPNWCallbackVariant, SAPOutputDevice, SAPOutputFormat, SAPPIChannel, SAPProcessChain, SAPRecipient, SoftwareItem, UserMessageDefinitionResponse

public interface NamedDetailObject
extends Detail

An object which has a Name, comment and description.

Field Summary

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	getComment()	Get the value for Comment.
String	getDescription()	Get the value for Description.
String	getName()	Get the value for Name.
String	getSearchName()	Get the value for SearchName.
void	setComment(String newComment)	Set the value for Comment.
void	setDescription(String newDescription)	Set the value for Description.
void	setName(String newName)	Set the value for Name.

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

Method Detail

getComment

String getComment()

Get the value for Comment. (Optional comment)

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.

getDescription

String getDescription()

Get the value for Description. (Optional description)

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.

getName

String getName()

Get the value for Name. (The unique name of this object) 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.

getSearchName

String getSearchName()

Get the value for SearchName. (The name of this object, normalized to allow for convenient database searching.) 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.

setComment

void setComment(String newComment)

Set the value for Comment. (Optional comment) This value is optional.

Parameters:

newComment - the new value for Comment.

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.

setDescription

void setDescription(String newDescription)

Set the value for Description. (Optional description) This value is optional.

Parameters:

newDescription - the new value for Description.

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.

setName

void setName(String newName)

Set the value for Name. (The unique name of this object) This value is mandatory.

Parameters:

newName - the new value for Name. 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.