Package com.redwood.scheduler.api.model

Interface ObjectReference

All Superinterfaces:

BusinessKeyObject, Readable, Root, SchedulerEntity, SchedulerEntityComp

public interface ObjectReference
extends Root, BusinessKeyObject, Readable

Object Reference A link from the source object to the linked object. This ensures that the linked object cannot be deleted, and that the source object can refer to the linked object, even if the linked object changes name. The JDBC module uses ObjectReferences named 'Jdbc_ProcessServer_Database_Ref' to link the JDBC process server to the database object containing the connection details.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ObjectReference" objects.
static QueryObjectType<ObjectReference>	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	getDescription()	Get the value for Description.
NamedRootObject	getLinkedObject()	Return the linked object of this object reference.
String	getName()	Get the value for Name.
String	getSearchName()	Get the value for SearchName.
NamedRootObject	getSourceObject()	Return the source object of this object reference.
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.BusinessKeyObject

getBusinessKey

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<ObjectReference> TYPE

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

Method Detail

getName

String getName()

Get the value for Name. (The name that can be used to refer to this object. The default name of "<objectType>_n", where <objectType> is the type of the linked object, and n is the lowest number for which the name does not exist.

Note: Although the setter exists, calling it from user code is not recommneded.

) 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 that can be used to refer to this object, in search case.) 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.

getDescription

String getDescription()

Get the value for Description. (Optional description for the reference.)

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.

setName

void setName(String newName)

Set the value for Name. (The name that can be used to refer to this object. The default name of "<objectType>_n", where <objectType> is the type of the linked object, and n is the lowest number for which the name does not exist.

Note: Although the setter exists, calling it from user code is not recommneded.

) 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.

setDescription

void setDescription(String newDescription)

Set the value for Description. (Optional description for the reference.) 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.

getSourceObject

NamedRootObject getSourceObject()

Return the source object of this object reference.

Returns:

The source object of this reference.

getLinkedObject

NamedRootObject getLinkedObject()

Return the linked object of this object reference.

Returns:

The linked object of this reference.