Package com.redwood.scheduler.api.model

Interface Partition

  • All Superinterfaces:
    BusinessKeyObject, NamedRootObject, NamedRootObjectComp, PartitionComp, Readable, Root, SchedulerEntity, SchedulerEntityComp
    public interface Partition
extends PartitionComp, NamedRootObject, BusinessKeyObject, Readable
    Partitions separate their contained objects according to security and visibility characteristics. Most objects defined in the repository are part of exactly one partition. There are two forms of partitions: private and public. There can be an unlimited number of private partitions. There must be at least one public partition that stores common data. Users implicitly have the privilege to access all public partitions. Whether they have access to the objects within these partitions may be subject to object level security, though. Users can be assigned to zero or more private partitions, meaning that they have the privilege to access these partitions. Upon login, users choose to work within one or more of the assigned private partitions. Users who have logged in to a private partition get to see objects from the set of all public partitions and the private partition(s). Objects can only refer to objects in the same partition or in other referencable partitions.

    • Method Detail

      • isExportable

        boolean isExportable()
        Get the value for Exportable. (Is the partition exportable)
        Returns:
        the field
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • setExportable

        void setExportable​(boolean newExportable)
        Set the value for Exportable. (Is the partition exportable)
        Parameters:
        newExportable - the new value for Exportable.
        Throws:
        ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

      • getObjects

        Iterator getObjects()
        Get all objects in this partition
        Returns:
        All objects in this partition.

      • getObjectSelectSQL

        String[] getObjectSelectSQL()
        Get an array of select statements for all objects in this partition
        Returns:
        An array of select statements for all objects in this partition.

      • setIsolationGroup

        void setIsolationGroup​(IsolationGroup newIsolationGroup)
        Set the value for IsolationGroup. This value is mandatory.
        Parameters:
        newIsolationGroup - is the object to set IsolationGroup to. The isolation group that this partition belongs to. If this is null, then the object cannot be persisted.

      • getProcessMonitorByNameInstance

        ProcessMonitor getProcessMonitorByNameInstance​(String name,
                                               String instance)
        Get the ProcessMonitor by ProcessMonitorInstance.
        Parameters:
        name -
        instance -
        Returns:
        the ProcessMonitor, or null if it could not be found

      • getApplicationByParentApplicationName

        Application getApplicationByParentApplicationName​(Application parentApplication,
                                                  String name)
        Get the Application by Name.
        Parameters:
        parentApplication -
        name -
        Returns:
        the Application, or null if it could not be found

      • getDocumentByParentApplicationSearchName

        Document getDocumentByParentApplicationSearchName​(Application parentApplication,
                                                  String searchName)
        Get the Document by Path.
        Parameters:
        parentApplication -
        searchName -
        Returns:
        the Document, or null if it could not be found

      • getJobDefinitionByNameBranchedLLPVersion

        JobDefinition getJobDefinitionByNameBranchedLLPVersion​(String name,
                                                       Long branchedLLPVersion)
        Get the JobDefinition by Name.
        Parameters:
        name -
        branchedLLPVersion -
        Returns:
        the JobDefinition, or null if it could not be found

      • getAlertEscalationByName

        AlertEscalation getAlertEscalationByName​(String name)
        Get the AlertEscalation by Name.
        Parameters:
        name -
        Returns:
        the AlertEscalation, or null if it could not be found

      • getConstraintDefinitionByName

        ConstraintDefinition getConstraintDefinitionByName​(String name)
        Get the ConstraintDefinition by Name.
        Parameters:
        name -
        Returns:
        the ConstraintDefinition, or null if it could not be found

      • getCredentialProtocolByName

        CredentialProtocol getCredentialProtocolByName​(String name)
        Get the CredentialProtocol by Name.
        Parameters:
        name -
        Returns:
        the CredentialProtocol, or null if it could not be found

      • getDatabaseByName

        Database getDatabaseByName​(String name)
        Get the Database by Name.
        Parameters:
        name -
        Returns:
        the Database, or null if it could not be found

      • getDatumDefinitionByName

        DatumDefinition getDatumDefinitionByName​(String name)
        Get the DatumDefinition by Name.
        Parameters:
        name -
        Returns:
        the DatumDefinition, or null if it could not be found

      • getExportRuleSetByName

        ExportRuleSet getExportRuleSetByName​(String name)
        Get the ExportRuleSet by Name.
        Parameters:
        name -
        Returns:
        the ExportRuleSet, or null if it could not be found

      • getExtensionPointByName

        ExtensionPoint getExtensionPointByName​(String name)
        Get the ExtensionPoint by Name.
        Parameters:
        name -
        Returns:
        the ExtensionPoint, or null if it could not be found

      • getEventDefinitionByName

        EventDefinition getEventDefinitionByName​(String name)
        Get the EventDefinition by Name.
        Parameters:
        name -
        Returns:
        the EventDefinition, or null if it could not be found

      • getFormats

        RWIterable<Format> getFormats()
        Get an RWIterable over an ordered collection of Formats. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The objects in this partition.
        Specified by:
        getFormats in interface PartitionComp
        Returns:
        An RWIterable over an ordered collection of Format objects .

      • getFormatByName

        Format getFormatByName​(String name)
        Get the Format by Name.
        Parameters:
        name -
        Returns:
        the Format, or null if it could not be found

      • getImportRuleDefinitionByName

        ImportRuleDefinition getImportRuleDefinitionByName​(String name)
        Get the ImportRuleDefinition by Name.
        Parameters:
        name -
        Returns:
        the ImportRuleDefinition, or null if it could not be found

      • getImportRuleSetByName

        ImportRuleSet getImportRuleSetByName​(String name)
        Get the ImportRuleSet by Name.
        Parameters:
        name -
        Returns:
        the ImportRuleSet, or null if it could not be found

      • getImportSourceByName

        ImportSource getImportSourceByName​(String name)
        Get the ImportSource by Name.
        Parameters:
        name -
        Returns:
        the ImportSource, or null if it could not be found

      • getJobDefinitionTypeByName

        JobDefinitionType getJobDefinitionTypeByName​(String name)
        Get the JobDefinitionType by Name.
        Parameters:
        name -
        Returns:
        the JobDefinitionType, or null if it could not be found

      • getJobLockByName

        JobLock getJobLockByName​(String name)
        Get the JobLock by Name.
        Parameters:
        name -
        Returns:
        the JobLock, or null if it could not be found

      • getLibraryByName

        Library getLibraryByName​(String name)
        Get the Library by Name.
        Parameters:
        name -
        Returns:
        the Library, or null if it could not be found

      • getMailConnectorByName

        MailConnector getMailConnectorByName​(String name)
        Get the MailConnector by Name.
        Parameters:
        name -
        Returns:
        the MailConnector, or null if it could not be found

      • getNavigationBarByOwnerSubjectName

        NavigationBar getNavigationBarByOwnerSubjectName​(Subject ownerSubject,
                                                 String name)
        Get the NavigationBar by OwnerSubjectName.
        Parameters:
        ownerSubject -
        name -
        Returns:
        the NavigationBar, or null if it could not be found

      • getNavigationBarByName

        NavigationBar getNavigationBarByName​(String name)
        Get the NavigationBar by Name.
        Parameters:
        name -
        Returns:
        the NavigationBar, or null if it could not be found

      • getObjectTagDefinitionByName

        ObjectTagDefinition getObjectTagDefinitionByName​(String name)
        Get the ObjectTagDefinition by Name.
        Parameters:
        name -
        Returns:
        the ObjectTagDefinition, or null if it could not be found

      • getOraAppsSystemByName

        OraAppsSystem getOraAppsSystemByName​(String name)
        Get the OraAppsSystem by Name.
        Parameters:
        name -
        Returns:
        the OraAppsSystem, or null if it could not be found

      • getOraOhiSystemByName

        OraOhiSystem getOraOhiSystemByName​(String name)
        Get the OraOhiSystem by Name.
        Parameters:
        name -
        Returns:
        the OraOhiSystem, or null if it could not be found

      • getPeopleSoftSystemByName

        PeopleSoftSystem getPeopleSoftSystemByName​(String name)
        Get the PeopleSoftSystem by Name.
        Parameters:
        name -
        Returns:
        the PeopleSoftSystem, or null if it could not be found

      • getPeriodFunctionByName

        PeriodFunction getPeriodFunctionByName​(String name)
        Get the PeriodFunction by Name.
        Parameters:
        name -
        Returns:
        the PeriodFunction, or null if it could not be found

      • getProcessMonitorDefinitionByName

        ProcessMonitorDefinition getProcessMonitorDefinitionByName​(String name)
        Get the ProcessMonitorDefinition by Name.
        Parameters:
        name -
        Returns:
        the ProcessMonitorDefinition, or null if it could not be found

      • getProcessServerByName

        ProcessServer getProcessServerByName​(String name)
        Get the ProcessServer by Name.
        Parameters:
        name -
        Returns:
        the ProcessServer, or null if it could not be found

      • getQueues

        RWIterable<Queue> getQueues()
        Get an RWIterable over an ordered collection of Queues. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The objects in this partition.
        Specified by:
        getQueues in interface PartitionComp
        Returns:
        An RWIterable over an ordered collection of Queue objects .

      • getQueueByName

        Queue getQueueByName​(String name)
        Get the Queue by Name.
        Parameters:
        name -
        Returns:
        the Queue, or null if it could not be found

      • getR2WCatalogByName

        R2WCatalog getR2WCatalogByName​(String name)
        Get the R2WCatalog by Name.
        Parameters:
        name -
        Returns:
        the R2WCatalog, or null if it could not be found

      • getRemoteSystemByName

        RemoteSystem getRemoteSystemByName​(String name)
        Get the RemoteSystem by Name.
        Parameters:
        name -
        Returns:
        the RemoteSystem, or null if it could not be found

      • getResourceByName

        Resource getResourceByName​(String name)
        Get the Resource by Name.
        Parameters:
        name -
        Returns:
        the Resource, or null if it could not be found

      • getSAPSystemByName

        SAPSystem getSAPSystemByName​(String name)
        Get the SAPSystem by Name.
        Parameters:
        name -
        Returns:
        the SAPSystem, or null if it could not be found

      • getSAPBAEConnectorByName

        SAPBAEConnector getSAPBAEConnectorByName​(String name)
        Get the SAPBAEConnector by Name.
        Parameters:
        name -
        Returns:
        the SAPBAEConnector, or null if it could not be found

      • getServiceByName

        Service getServiceByName​(String name)
        Get the Service by Name.
        Parameters:
        name -
        Returns:
        the Service, or null if it could not be found

      • getSubmitFrameByName

        SubmitFrame getSubmitFrameByName​(String name)
        Get the SubmitFrame by Name.
        Parameters:
        name -
        Returns:
        the SubmitFrame, or null if it could not be found

      • getTables

        RWIterable<Table> getTables()
        Get an RWIterable over an ordered collection of Tables. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The objects in this partition.
        Specified by:
        getTables in interface PartitionComp
        Returns:
        An RWIterable over an ordered collection of Table objects .

      • getTableByName

        Table getTableByName​(String name)
        Get the Table by Name.
        Parameters:
        name -
        Returns:
        the Table, or null if it could not be found

      • getTableDefinitionByName

        TableDefinition getTableDefinitionByName​(String name)
        Get the TableDefinition by Name.
        Parameters:
        name -
        Returns:
        the TableDefinition, or null if it could not be found

      • getTimeWindowByName

        TimeWindow getTimeWindowByName​(String name)
        Get the TimeWindow by Name.
        Parameters:
        name -
        Returns:
        the TimeWindow, or null if it could not be found

      • getTriggerByName

        Trigger getTriggerByName​(String name)
        Get the Trigger by Name.
        Parameters:
        name -
        Returns:
        the Trigger, or null if it could not be found

      • getEmailAlertGatewayByName

        EmailAlertGateway getEmailAlertGatewayByName​(String name)
        Get the EmailAlertGateway by Name.
        Parameters:
        name -
        Returns:
        the EmailAlertGateway, or null if it could not be found

      • getAdHocAlertSourceByName

        AdHocAlertSource getAdHocAlertSourceByName​(String name)
        Get the AdHocAlertSource by Name.
        Parameters:
        name -
        Returns:
        the AdHocAlertSource, or null if it could not be found

      • getJobDefinitionAlertSourceByName

        JobDefinitionAlertSource getJobDefinitionAlertSourceByName​(String name)
        Get the JobDefinitionAlertSource by Name.
        Parameters:
        name -
        Returns:
        the JobDefinitionAlertSource, or null if it could not be found

      • getMonitorAlertSourceByName

        MonitorAlertSource getMonitorAlertSourceByName​(String name)
        Get the MonitorAlertSource by Name.
        Parameters:
        name -
        Returns:
        the MonitorAlertSource, or null if it could not be found

      • getProcessServerAlertSourceByName

        ProcessServerAlertSource getProcessServerAlertSourceByName​(String name)
        Get the ProcessServerAlertSource by Name.
        Parameters:
        name -
        Returns:
        the ProcessServerAlertSource, or null if it could not be found

      • getQueueAlertSourceByName

        QueueAlertSource getQueueAlertSourceByName​(String name)
        Get the QueueAlertSource by Name.
        Parameters:
        name -
        Returns:
        the QueueAlertSource, or null if it could not be found

      • getCredentialByCredentialProtocolEndpointRealUser

        Credential getCredentialByCredentialProtocolEndpointRealUser​(CredentialProtocol credentialProtocol,
                                                             String endpoint,
                                                             String realUser)
        Get the Credential by CredentialProtocolEndpointRealUser.
        Parameters:
        credentialProtocol -
        endpoint -
        realUser -
        Returns:
        the Credential, or null if it could not be found

      • getCredentialByCredentialProtocolEndpointVirtualUser

        Credential getCredentialByCredentialProtocolEndpointVirtualUser​(CredentialProtocol credentialProtocol,
                                                                String endpoint,
                                                                String virtualUser)
        Get the Credential by CredentialProtocolEndpointVirtualUser.
        Parameters:
        credentialProtocol -
        endpoint -
        virtualUser -
        Returns:
        the Credential, or null if it could not be found

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