Package com.redwood.scheduler.api.model

Interface PeopleSoftJobOutputLocation

All Superinterfaces:

Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface PeopleSoftJobOutputLocation
extends Detail, Readable

PeopleSoft job output file location settings.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "PeopleSoftJobOutputLocation" 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<PeopleSoftJobOutputLocation>	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.
String	getHostName()	Get the value for HostName.
String	getInstanceName()	Get the value for InstanceName.
PeopleSoftSystem	getPeopleSoftSystem()	Get the PeopleSoftSystem.
Long	getPort()	Get the value for Port.
Long	getProcessingOrder()	Get the value for ProcessingOrder.
String	getProtocol()	Get the value for Protocol.
boolean	isEnabled()	Get the value for Enabled.
void	setDescription(String newDescription)	Set the value for Description.
void	setEnabled(boolean newEnabled)	Set the value for Enabled.
void	setHostName(String newHostName)	Set the value for HostName.
void	setInstanceName(String newInstanceName)	Set the value for InstanceName.
void	setPort(Long newPort)	Set the value for Port.
void	setProcessingOrder(Long newProcessingOrder)	Set the value for ProcessingOrder.
void	setProtocol(String newProtocol)	Set the value for Protocol.

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

See Also:

Constant Field Values

TYPE

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

getDescription

String getDescription()

Get the value for Description. (The description of this output file location)

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.

getProcessingOrder

Long getProcessingOrder()

Get the value for ProcessingOrder. (In which order are the OutputRules applied?) 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.

getProtocol

String getProtocol()

Get the value for Protocol. (PeopleSoft protocol to retrieve the output files.) 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.

getHostName

String getHostName()

Get the value for HostName. (PeopleSoft hostname to retrieve the output files.) 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.

getPort

Long getPort()

Get the value for Port. (Port to connect to on the hostname.)

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.

getInstanceName

String getInstanceName()

Get the value for InstanceName. (PeopleSoft instance 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.

isEnabled

boolean isEnabled()

Get the value for Enabled. (Whether this rule is currently enabled or not.)

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.

setDescription

void setDescription(String newDescription)

Set the value for Description. (The description of this output file location) 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.

setProcessingOrder

void setProcessingOrder(Long newProcessingOrder)

Set the value for ProcessingOrder. (In which order are the OutputRules applied?) This value is mandatory.

Parameters:

newProcessingOrder - the new value for ProcessingOrder. 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.

setProtocol

void setProtocol(String newProtocol)

Set the value for Protocol. (PeopleSoft protocol to retrieve the output files.) This value is mandatory.

Parameters:

newProtocol - the new value for Protocol. 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.

setHostName

void setHostName(String newHostName)

Set the value for HostName. (PeopleSoft hostname to retrieve the output files.) This value is mandatory.

Parameters:

newHostName - the new value for HostName. 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.

setPort

void setPort(Long newPort)

Set the value for Port. (Port to connect to on the hostname.) This value is optional.

Parameters:

newPort - the new value for Port.

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.

setInstanceName

void setInstanceName(String newInstanceName)

Set the value for InstanceName. (PeopleSoft instance name.) This value is mandatory.

Parameters:

newInstanceName - the new value for InstanceName. 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.

setEnabled

void setEnabled(boolean newEnabled)

Set the value for Enabled. (Whether this rule is currently enabled or not.)

Parameters:

newEnabled - the new value for Enabled.

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.

getPeopleSoftSystem

PeopleSoftSystem getPeopleSoftSystem()

Get the PeopleSoftSystem.

Returns:

PeopleSoftSystem

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.