Package com.redwood.scheduler.api.model

Interface PeopleSoftSystem

All Superinterfaces:

ApplicationObject, BusinessKeyObject, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, PeopleSoftSystemComp, Readable, Root, SchedulerEntity, SchedulerEntityComp, UniqueNamedApplicationObject

public interface PeopleSoftSystem
extends PeopleSoftSystemComp, UniqueNamedApplicationObject, Readable

Settings relating to a Oracle PeopleSoft System.

Field Summary

Fields

Modifier and Type	Field	Description
static String	DEFAULT_J2EE_CONNECT_STRING	Default J2EE connect string.
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "PeopleSoftSystem" objects.
static String	SEC_PRIV_CREATE	This privilege can be granted at a group level.
static String	SEC_PRIV_DELETE	This privilege can be granted at a group level.
static String	SEC_PRIV_EDIT	This privilege can be granted at a group level.
static String	SEC_PRIV_VIEW	This privilege can be granted at a group level.
static String	SEC_RANK_ALL	This rank is made of the following privileges: create , view , edit , delete
static String	SEC_RANK_CREATE	This rank is made of the following privileges: create
static String	SEC_RANK_DELETE	This rank is made of the following privileges: create , view , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: create , view , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<PeopleSoftSystem>	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
RequiredPermission	checkCreatePrivilege()	Check whether or not the create action can be performed on this object.
RequiredPermission	checkDeletePrivilege()	Check whether or not the delete action can be performed on this object.
RequiredPermission	checkEditPrivilege()	Check whether or not the edit action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
PeopleSoftJobControlRule	createPeopleSoftJobControlRule()	Create a new PeopleSoftJobControlRule linked to this object.
PeopleSoftJobOutputLocation	createPeopleSoftJobOutputLocation()	Create a new PeopleSoftJobOutputLocation linked to this object.
TimeZone	getDefaultJobTimeZone()	Get the DefaultJobTimeZone.
String	getJ2EEConnectString()	Get the value for J2EEConnectString.
JobHandlingType	getJobHandlingEnabled()	Get the value for JobHandlingEnabled.
ProcessServer	getJobOutputRetrievalProcessServer()	Get the JobOutputRetrievalProcessServer.
String	getLanguage()	Get the value for Language.
RWIterable<PeopleSoftJobControlRule>	getPeopleSoftJobControlRules()	Get an RWIterable over a collection of PeopleSoftJobControlRules, the collection will be ordered by ProcessingOrder.
RWIterable<PeopleSoftJobOutputLocation>	getPeopleSoftJobOutputLocations()	Get an RWIterable over a collection of PeopleSoftJobOutputLocations, the collection will be ordered by ProcessingOrder.
ProcessServer	getProcessServer()	Get the ProcessServer.
Queue	getQueue()	Get the Queue.
String	getUserName()	Get the value for UserName.
void	init()	Perform initialization tasks for the Oracle PeopleSoft System.
void	setDefaultJobTimeZone(TimeZone newDefaultJobTimeZone)	Set the value for DefaultJobTimeZone.
void	setJ2EEConnectString(String newJ2EEConnectString)	Set the value for J2EEConnectString.
void	setJobHandlingEnabled(JobHandlingType newJobHandlingEnabled)	Set the value for JobHandlingEnabled.
void	setJobOutputRetrievalProcessServer(ProcessServer newJobOutputRetrievalProcessServer)	Set the value for JobOutputRetrievalProcessServer.
void	setLanguage(String newLanguage)	Set the value for Language.
void	setProcessServer(ProcessServer newProcessServer)	Set the value for ProcessServer.
void	setQueue(Queue newQueue)	Set the value for Queue.
void	setUserName(String newUserName)	Set the value for UserName.

Methods inherited from interface com.redwood.scheduler.api.model.ApplicationObject

getParentApplication, setParentApplication

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.NamedRootObject

createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

Methods inherited from interface com.redwood.scheduler.api.model.PartitionableObject

createObjectTag, getEditablePartitions, getObjectTagByObjectTagDefinition, getObjectTags, getPartition, setPartition

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<PeopleSoftSystem> TYPE

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

DEFAULT_J2EE_CONNECT_STRING

static final String DEFAULT_J2EE_CONNECT_STRING

Default J2EE connect string.

See Also:

Constant Field Values

SEC_PRIV_CREATE

static final String SEC_PRIV_CREATE

This privilege can be granted at a group level.

See Also:

Constant Field Values

SEC_PRIV_VIEW

static final String SEC_PRIV_VIEW

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_EDIT

static final String SEC_PRIV_EDIT

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_DELETE

static final String SEC_PRIV_DELETE

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_CREATE

static final String SEC_RANK_CREATE

This rank is made of the following privileges: create

See Also:

Constant Field Values

SEC_RANK_VIEW

static final String SEC_RANK_VIEW

This rank is made of the following privileges: view

See Also:

Constant Field Values

SEC_RANK_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: create , view , edit

See Also:

Constant Field Values

SEC_RANK_DELETE

static final String SEC_RANK_DELETE

This rank is made of the following privileges: create , view , delete

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges: create , view , edit , delete

See Also:

Constant Field Values

Method Detail

getJ2EEConnectString

String getJ2EEConnectString()

Get the value for J2EEConnectString. (Connection string for reaching the J2EE stack of this PeopleSoft system)

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.

getJobHandlingEnabled

JobHandlingType getJobHandlingEnabled()

Get the value for JobHandlingEnabled. (Should the job synchronization for this PeopleSoft System be enabled?) 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.

getLanguage

String getLanguage()

Get the value for Language. (Language for connecting to an PeopleSoft system) 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.

getUserName

String getUserName()

Get the value for UserName. (User name that is used to connect to a PeopleSoft System) 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.

setJ2EEConnectString

void setJ2EEConnectString(String newJ2EEConnectString)

Set the value for J2EEConnectString. (Connection string for reaching the J2EE stack of this PeopleSoft system) This value is optional.

Parameters:

newJ2EEConnectString - the new value for J2EEConnectString.

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.

setJobHandlingEnabled

void setJobHandlingEnabled(JobHandlingType newJobHandlingEnabled)

Set the value for JobHandlingEnabled. (Should the job synchronization for this PeopleSoft System be enabled?) This value is mandatory.

Parameters:

newJobHandlingEnabled - the new value for JobHandlingEnabled. 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.

setLanguage

void setLanguage(String newLanguage)

Set the value for Language. (Language for connecting to an PeopleSoft system) This value is mandatory.

Parameters:

newLanguage - the new value for Language. 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.

setUserName

void setUserName(String newUserName)

Set the value for UserName. (User name that is used to connect to a PeopleSoft System) This value is mandatory.

Parameters:

newUserName - the new value for UserName. 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.

init

void init()

Perform initialization tasks for the Oracle PeopleSoft System.

getProcessServer

ProcessServer getProcessServer()

Get the ProcessServer.

Returns:

ProcessServer

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.

getQueue

Queue getQueue()

Get the Queue.

Returns:

Queue

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.

getDefaultJobTimeZone

TimeZone getDefaultJobTimeZone()

Get the DefaultJobTimeZone.

Returns:

DefaultJobTimeZone

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.

getJobOutputRetrievalProcessServer

ProcessServer getJobOutputRetrievalProcessServer()

Get the JobOutputRetrievalProcessServer.

Returns:

JobOutputRetrievalProcessServer

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.

setProcessServer

void setProcessServer(ProcessServer newProcessServer)

Set the value for ProcessServer. This value is mandatory.

Parameters:

newProcessServer - is the object to set ProcessServer to. Link the PeopleSoft system to its corresponding process server. If this is null, then the object cannot be persisted.

setQueue

void setQueue(Queue newQueue)

Set the value for Queue. This value is mandatory.

Parameters:

newQueue - is the object to set Queue to. Link the PeopleSoft system to its corresponding default queue. If this is null, then the object cannot be persisted.

setDefaultJobTimeZone

void setDefaultJobTimeZone(TimeZone newDefaultJobTimeZone)

Set the value for DefaultJobTimeZone. This value is mandatory.

Parameters:

newDefaultJobTimeZone - is the object to set DefaultJobTimeZone to. Which TimeZone will be ascribed to the Jobs DateTimeZone fields by default. If this is null, then the object cannot be persisted.

setJobOutputRetrievalProcessServer

void setJobOutputRetrievalProcessServer(ProcessServer newJobOutputRetrievalProcessServer)

Set the value for JobOutputRetrievalProcessServer. This value is optional.

Parameters:

newJobOutputRetrievalProcessServer - is the object to set JobOutputRetrievalProcessServer to. Assign a Process Server to perform PeopleSoft job output retrieval

getPeopleSoftJobControlRules

RWIterable<PeopleSoftJobControlRule> getPeopleSoftJobControlRules()

Get an RWIterable over a collection of PeopleSoftJobControlRules, the collection will be ordered by ProcessingOrder. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Collection of JobControlRules settings for an PeopleSoft system.

Specified by:

getPeopleSoftJobControlRules in interface PeopleSoftSystemComp

Returns:

An RWIterable over a collection of PeopleSoftJobControlRule objects , the collection will be ordered by ProcessingOrder.

createPeopleSoftJobControlRule

PeopleSoftJobControlRule createPeopleSoftJobControlRule()

Create a new PeopleSoftJobControlRule linked to this object.

Returns:

a new PeopleSoftJobControlRule.

getPeopleSoftJobOutputLocations

RWIterable<PeopleSoftJobOutputLocation> getPeopleSoftJobOutputLocations()

Get an RWIterable over a collection of PeopleSoftJobOutputLocations, the collection will be ordered by ProcessingOrder. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Collection of Job Outputfile locations settings for an PeopleSoft system.

Specified by:

getPeopleSoftJobOutputLocations in interface PeopleSoftSystemComp

Returns:

An RWIterable over a collection of PeopleSoftJobOutputLocation objects , the collection will be ordered by ProcessingOrder.

createPeopleSoftJobOutputLocation

PeopleSoftJobOutputLocation createPeopleSoftJobOutputLocation()

Create a new PeopleSoftJobOutputLocation linked to this object.

Returns:

a new PeopleSoftJobOutputLocation.

checkCreatePrivilege

RequiredPermission checkCreatePrivilege()

Check whether or not the create action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkViewPrivilege

RequiredPermission checkViewPrivilege()

Check whether or not the view action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkEditPrivilege

RequiredPermission checkEditPrivilege()

Check whether or not the edit action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkDeletePrivilege

RequiredPermission checkDeletePrivilege()

Check whether or not the delete action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.