Package com.redwood.scheduler.api.model

Interface PeopleSoftSystem

    • 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:
        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:
        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:
        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:
        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:
        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:
        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:
        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:
        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.

      • getDefaultJobTimeZone

        TimeZone getDefaultJobTimeZone()
        Get the DefaultJobTimeZone.
        Returns:
        DefaultJobTimeZone
        Throws:
        ObjectDeletedException - If this method is called when the object has been marked for deletion.
        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:
        ObjectDeletedException - If this method is called when the object has been marked for deletion.
        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

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