Package com.redwood.scheduler.api.model

Interface OraAppsSystem

    • Method Detail

      • getJobHandlingEnabled

        JobHandlingType getJobHandlingEnabled()
        Get the value for JobHandlingEnabled. (Should the job interception and synchronization for this Oracle Applications 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 Oracle Applications 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.

      • getCredential

        Long getCredential()
        Get the value for Credential. (Deprecated; Link to a credential field. Use UserName and OraAppsSystem to get the CredentialHelper) 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.

      • getSubmitUserType

        OraAppsSubmitUserType getSubmitUserType()
        Get the value for SubmitUserType. (Indicates the type of the submit user: (F)ixed, (C)urrent logon user or (L)OV from Oracle Applications.) 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.

      • getSubmitUserName

        String getSubmitUserName()
        Get the value for SubmitUserName. (Fixed User name that is used to submit jobs in an Oracle Applications 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.

      • getOutputRetrievalType

        OutputRetrievalType getOutputRetrievalType()
        Get the value for OutputRetrievalType. (Indicates how to retrieve the output.) 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.

      • getDefaultValueOption

        OraAppsDefaultValueOption getDefaultValueOption()
        Get the value for DefaultValueOption. (Indicates the type for pre-filling default values: Always, Mandatory fields only or Never from Oracle Applications. When jobs are submitted by Cronacle the customer can define how he want to pre-fill default values to submit jobs in Oracle Applications. The LOV's are checked everytime a new value is added, but with this option it is possible to skip pre-filling certain LOVs. ) 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.

      • setJobHandlingEnabled

        void setJobHandlingEnabled​(JobHandlingType newJobHandlingEnabled)
        Set the value for JobHandlingEnabled. (Should the job interception and synchronization for this Oracle Applications 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 Oracle Applications 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.

      • setSubmitUserType

        void setSubmitUserType​(OraAppsSubmitUserType newSubmitUserType)
        Set the value for SubmitUserType. (Indicates the type of the submit user: (F)ixed, (C)urrent logon user or (L)OV from Oracle Applications.) This value is mandatory.
        Parameters:
        newSubmitUserType - the new value for SubmitUserType. 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.

      • setSubmitUserName

        void setSubmitUserName​(String newSubmitUserName)
        Set the value for SubmitUserName. (Fixed User name that is used to submit jobs in an Oracle Applications System) This value is optional.
        Parameters:
        newSubmitUserName - the new value for SubmitUserName.
        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.

      • setOutputRetrievalType

        void setOutputRetrievalType​(OutputRetrievalType newOutputRetrievalType)
        Set the value for OutputRetrievalType. (Indicates how to retrieve the output.) This value is mandatory.
        Parameters:
        newOutputRetrievalType - the new value for OutputRetrievalType. 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.

      • setDefaultValueOption

        void setDefaultValueOption​(OraAppsDefaultValueOption newDefaultValueOption)
        Set the value for DefaultValueOption. (Indicates the type for pre-filling default values: Always, Mandatory fields only or Never from Oracle Applications. When jobs are submitted by Cronacle the customer can define how he want to pre-fill default values to submit jobs in Oracle Applications. The LOV's are checked everytime a new value is added, but with this option it is possible to skip pre-filling certain LOVs. ) This value is mandatory.
        Parameters:
        newDefaultValueOption - the new value for DefaultValueOption. 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.

      • getLanguageCodes

        Map<String,​String> getLanguageCodes()
        Get the Oracle Applications language codes for setting the correct NLS.
        Returns:
        Return the list of valid language codes.

      • getDatabaseConnectString

        String getDatabaseConnectString()
        Get the connection string for connecting to the Oracle Applications system. This connection string is persisted to the Database object associated with the Oracle Applications system.
        Returns:
        The connection string for connecting to the Oracle Applications system.

      • getDatabaseUserName

        String getDatabaseUserName()
        Get the username for connecting to the Oracle Applications system. This username is persisted to the Database object associated with the Oracle Applications system.
        Returns:
        The username for connecting to the Oracle Applications system.

      • init

        void init()
        Perform initialization tasks for the Oracle Applications 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.

      • getDatabase

        Database getDatabase()
        Get the Database.
        Returns:
        Database
        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 Oracle Applications 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 Oracle Applications 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.

      • setDatabase

        void setDatabase​(Database newDatabase)
        Set the value for Database. This value is optional.
        Parameters:
        newDatabase - is the object to set Database to. Link the Oracle Applications system to its corresponding database object.

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