Package com.redwood.scheduler.api.model

Interface RELEntryPoint

All Superinterfaces:

BusinessKeyObject, Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface RELEntryPoint
extends Detail, BusinessKeyObject, Readable

A published point of entry to a library that can be used by REL.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "RELEntryPoint" 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<RELEntryPoint>	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	getFQClassName()	Get the value for FQClassName.
Library	getLibrary()	Get the Library.
String	getMethodSignature()	Get the value for MethodSignature.
String	getName()	Get the value for Name.
void	setFQClassName(String newFQClassName)	Set the value for FQClassName.
void	setMethodSignature(String newMethodSignature)	Set the value for MethodSignature.
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.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 "RELEntryPoint" objects.

See Also:

Constant Field Values

TYPE

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

getName

String getName()

Get the value for Name. (The name by which function is to be published) 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.

getFQClassName

String getFQClassName()

Get the value for FQClassName. (The fully qualified class name) 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.

getMethodSignature

String getMethodSignature()

Get the value for MethodSignature. (The string version of the method signature) 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.

setName

void setName(String newName)

Set the value for Name. (The name by which function is to be published) 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.

setFQClassName

void setFQClassName(String newFQClassName)

Set the value for FQClassName. (The fully qualified class name) This value is mandatory.

Parameters:

newFQClassName - the new value for FQClassName. 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.

setMethodSignature

void setMethodSignature(String newMethodSignature)

Set the value for MethodSignature. (The string version of the method signature) This value is mandatory.

Parameters:

newMethodSignature - the new value for MethodSignature. 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.

getLibrary

Library getLibrary()

Get the Library.

Returns:

Library

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.