Package com.redwood.scheduler.api.model

Interface OracleConnection

All Superinterfaces:

Root, SchedulerEntity, SchedulerEntityComp

public interface OracleConnection
extends Root

Show all Oracle connections that are present.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "OracleConnection" objects.
static QueryObjectType<OracleConnection>	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
Long	getIdletime()	Get the value for Idletime.
Long	getOracleInstanceId()	Get the value for OracleInstanceId.
String	getOracleSessionId()	Get the value for OracleSessionId.
String	getOracleUsername()	Get the value for OracleUsername.
String	getPipeNameIn()	Get the value for PipeNameIn.
String	getPipeNameOut()	Get the value for PipeNameOut.
DateTimeZone	getPrivateLastAccesstime()	Get the value for PrivateLastAccesstime.
void	setOracleInstanceId(Long newOracleInstanceId)	Set the value for OracleInstanceId.
void	setOracleSessionId(String newOracleSessionId)	Set the value for OracleSessionId.
void	setOracleUsername(String newOracleUsername)	Set the value for OracleUsername.
void	setPipeNameIn(String newPipeNameIn)	Set the value for PipeNameIn.
void	setPipeNameOut(String newPipeNameOut)	Set the value for PipeNameOut.
void	setPrivateLastAccesstime(DateTimeZone newPrivateLastAccesstime)	Set the value for PrivateLastAccesstime.
void	StopConnection()	Stops only the connection.
void	StopEverything()	Stops everything .

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<OracleConnection> TYPE

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

Method Detail

getOracleSessionId

String getOracleSessionId()

Get the value for OracleSessionId. (Unique oracle session ID.) 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.

getPipeNameIn

String getPipeNameIn()

Get the value for PipeNameIn. (Unique incoming Pipe 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.

getPipeNameOut

String getPipeNameOut()

Get the value for PipeNameOut. (Unique outgoing Pipe 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.

getOracleUsername

String getOracleUsername()

Get the value for OracleUsername. (Oracle username.) 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.

getPrivateLastAccesstime

DateTimeZone getPrivateLastAccesstime()

Get the value for PrivateLastAccesstime. (This attribute is used to set the last access time from the oracle to cronacle.) 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.

getIdletime

Long getIdletime()

Get the value for Idletime. (Calculated idletime) 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.

getOracleInstanceId

Long getOracleInstanceId()

Get the value for OracleInstanceId. (The Oracle instance ID) 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.

setOracleSessionId

void setOracleSessionId(String newOracleSessionId)

Set the value for OracleSessionId. (Unique oracle session ID.) This value is mandatory.

Parameters:

newOracleSessionId - the new value for OracleSessionId. 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.

setPipeNameIn

void setPipeNameIn(String newPipeNameIn)

Set the value for PipeNameIn. (Unique incoming Pipe name.) This value is mandatory.

Parameters:

newPipeNameIn - the new value for PipeNameIn. 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.

setPipeNameOut

void setPipeNameOut(String newPipeNameOut)

Set the value for PipeNameOut. (Unique outgoing Pipe name.) This value is mandatory.

Parameters:

newPipeNameOut - the new value for PipeNameOut. 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.

setOracleUsername

void setOracleUsername(String newOracleUsername)

Set the value for OracleUsername. (Oracle username.) This value is mandatory.

Parameters:

newOracleUsername - the new value for OracleUsername. 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.

setPrivateLastAccesstime

void setPrivateLastAccesstime(DateTimeZone newPrivateLastAccesstime)

Set the value for PrivateLastAccesstime. (This attribute is used to set the last access time from the oracle to cronacle.) This value is mandatory.

Parameters:

newPrivateLastAccesstime - the new value for PrivateLastAccesstime. 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.

setOracleInstanceId

void setOracleInstanceId(Long newOracleInstanceId)

Set the value for OracleInstanceId. (The Oracle instance ID) This value is mandatory.

Parameters:

newOracleInstanceId - the new value for OracleInstanceId. 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.

StopEverything

void StopEverything()

Stops everything .

StopConnection

void StopConnection()

Stops only the connection.