Class BusinessKeyLookup


  • public class BusinessKeyLookup
    extends Object
    Interface for resolving all concrete BusinessKeyObject objects based on their business key.
    • Constructor Detail

      • BusinessKeyLookup

        public BusinessKeyLookup()
    • Method Detail

      • getAdHocAlertSourceByBusinessKey

        public static AdHocAlertSource getAdHocAlertSourceByBusinessKey​(SchedulerSession session,
                                                                        String key)
        Query an instance of AdHocAlertSource, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type AdHocAlertSource.
      • getAlertEscalationByBusinessKey

        public static AlertEscalation getAlertEscalationByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of AlertEscalation, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type AlertEscalation.
      • getApplicationByBusinessKey

        public static Application getApplicationByBusinessKey​(SchedulerSession session,
                                                              String key)
        Query an instance of Application, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Application.
      • getAuditRuleByBusinessKey

        public static AuditRule getAuditRuleByBusinessKey​(SchedulerSession session,
                                                          String key)
        Query an instance of AuditRule, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type AuditRule.
      • getCredentialByBusinessKey

        public static Credential getCredentialByBusinessKey​(SchedulerSession session,
                                                            String key)
        Query an instance of Credential, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Credential.
      • getCredentialProtocolByBusinessKey

        public static CredentialProtocol getCredentialProtocolByBusinessKey​(SchedulerSession session,
                                                                            String key)
        Query an instance of CredentialProtocol, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type CredentialProtocol.
      • getDashboardByBusinessKey

        public static Dashboard getDashboardByBusinessKey​(SchedulerSession session,
                                                          String key)
        Query an instance of Dashboard, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Dashboard.
      • getDatabaseByBusinessKey

        public static Database getDatabaseByBusinessKey​(SchedulerSession session,
                                                        String key)
        Query an instance of Database, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Database.
      • getDatumDefinitionByBusinessKey

        public static DatumDefinition getDatumDefinitionByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of DatumDefinition, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type DatumDefinition.
      • getDocumentByBusinessKey

        public static Document getDocumentByBusinessKey​(SchedulerSession session,
                                                        String key)
        Query an instance of Document, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Document.
      • getEmailAlertGatewayByBusinessKey

        public static EmailAlertGateway getEmailAlertGatewayByBusinessKey​(SchedulerSession session,
                                                                          String key)
        Query an instance of EmailAlertGateway, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type EmailAlertGateway.
      • getEventByBusinessKey

        public static Event getEventByBusinessKey​(SchedulerSession session,
                                                  String key)
        Query an instance of Event, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Event.
      • getEventDefinitionByBusinessKey

        public static EventDefinition getEventDefinitionByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of EventDefinition, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type EventDefinition.
      • getExportRuleByBusinessKey

        public static ExportRule getExportRuleByBusinessKey​(SchedulerSession session,
                                                            String key)
        Query an instance of ExportRule, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ExportRule.
      • getExportRuleSetByBusinessKey

        public static ExportRuleSet getExportRuleSetByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of ExportRuleSet, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ExportRuleSet.
      • getExtensionPointByBusinessKey

        public static ExtensionPoint getExtensionPointByBusinessKey​(SchedulerSession session,
                                                                    String key)
        Query an instance of ExtensionPoint, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ExtensionPoint.
      • getForecastJobByBusinessKey

        public static ForecastJob getForecastJobByBusinessKey​(SchedulerSession session,
                                                              String key)
        Query an instance of ForecastJob, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ForecastJob.
      • getFormatByBusinessKey

        public static Format getFormatByBusinessKey​(SchedulerSession session,
                                                    String key)
        Query an instance of Format, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Format.
      • getGlobalPrivilegeByBusinessKey

        public static GlobalPrivilege getGlobalPrivilegeByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of GlobalPrivilege, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type GlobalPrivilege.
      • getImportActionByBusinessKey

        public static ImportAction getImportActionByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of ImportAction, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ImportAction.
      • getImportRuleByBusinessKey

        public static ImportRule getImportRuleByBusinessKey​(SchedulerSession session,
                                                            String key)
        Query an instance of ImportRule, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ImportRule.
      • getImportRuleSetByBusinessKey

        public static ImportRuleSet getImportRuleSetByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of ImportRuleSet, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ImportRuleSet.
      • getImportSourceByBusinessKey

        public static ImportSource getImportSourceByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of ImportSource, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ImportSource.
      • getIsolationGroupByBusinessKey

        public static IsolationGroup getIsolationGroupByBusinessKey​(SchedulerSession session,
                                                                    String key)
        Query an instance of IsolationGroup, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type IsolationGroup.
      • getJARFileByBusinessKey

        public static JARFile getJARFileByBusinessKey​(SchedulerSession session,
                                                      String key)
        Query an instance of JARFile, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JARFile.
      • getJobByBusinessKey

        public static Job getJobByBusinessKey​(SchedulerSession session,
                                              String key)
        Query an instance of Job, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Job.
      • getJobChainByBusinessKey

        public static JobChain getJobChainByBusinessKey​(SchedulerSession session,
                                                        String key)
        Query an instance of JobChain, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobChain.
      • getJobChainCallByBusinessKey

        public static JobChainCall getJobChainCallByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of JobChainCall, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobChainCall.
      • getJobChainStepByBusinessKey

        public static JobChainStep getJobChainStepByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of JobChainStep, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobChainStep.
      • getJobDefinitionByBusinessKey

        public static JobDefinition getJobDefinitionByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of JobDefinition, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobDefinition.
      • getJobDefinitionFormByBusinessKey

        public static JobDefinitionForm getJobDefinitionFormByBusinessKey​(SchedulerSession session,
                                                                          String key)
        Query an instance of JobDefinitionForm, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobDefinitionForm.
      • getJobDefinitionTypeByBusinessKey

        public static JobDefinitionType getJobDefinitionTypeByBusinessKey​(SchedulerSession session,
                                                                          String key)
        Query an instance of JobDefinitionType, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobDefinitionType.
      • getJobFileSearchByBusinessKey

        public static JobFileSearch getJobFileSearchByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of JobFileSearch, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobFileSearch.
      • getJobGroupByBusinessKey

        public static JobGroup getJobGroupByBusinessKey​(SchedulerSession session,
                                                        String key)
        Query an instance of JobGroup, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobGroup.
      • getJobLockByBusinessKey

        public static JobLock getJobLockByBusinessKey​(SchedulerSession session,
                                                      String key)
        Query an instance of JobLock, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobLock.
      • getJobRaiseEventByBusinessKey

        public static JobRaiseEvent getJobRaiseEventByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of JobRaiseEvent, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobRaiseEvent.
      • getJobRuntimeLimitByBusinessKey

        public static JobRuntimeLimit getJobRuntimeLimitByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of JobRuntimeLimit, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobRuntimeLimit.
      • getJobWaitEventByBusinessKey

        public static JobWaitEvent getJobWaitEventByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of JobWaitEvent, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type JobWaitEvent.
      • getLibraryByBusinessKey

        public static Library getLibraryByBusinessKey​(SchedulerSession session,
                                                      String key)
        Query an instance of Library, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Library.
      • getLibrarySourceByBusinessKey

        public static LibrarySource getLibrarySourceByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of LibrarySource, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type LibrarySource.
      • getLicenseKeyByBusinessKey

        public static LicenseKey getLicenseKeyByBusinessKey​(SchedulerSession session,
                                                            String key)
        Query an instance of LicenseKey, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type LicenseKey.
      • getMailConnectorByBusinessKey

        public static MailConnector getMailConnectorByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of MailConnector, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type MailConnector.
      • getMonitorAlertSourceByBusinessKey

        public static MonitorAlertSource getMonitorAlertSourceByBusinessKey​(SchedulerSession session,
                                                                            String key)
        Query an instance of MonitorAlertSource, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type MonitorAlertSource.
      • getMonitorCheckByBusinessKey

        public static MonitorCheck getMonitorCheckByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of MonitorCheck, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type MonitorCheck.
      • getMonitorEventByBusinessKey

        public static MonitorEvent getMonitorEventByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of MonitorEvent, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type MonitorEvent.
      • getMonitorLinkByBusinessKey

        public static MonitorLink getMonitorLinkByBusinessKey​(SchedulerSession session,
                                                              String key)
        Query an instance of MonitorLink, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type MonitorLink.
      • getMonitorNodeByBusinessKey

        public static MonitorNode getMonitorNodeByBusinessKey​(SchedulerSession session,
                                                              String key)
        Query an instance of MonitorNode, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type MonitorNode.
      • getMonitorValueByBusinessKey

        public static MonitorValue getMonitorValueByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of MonitorValue, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type MonitorValue.
      • getNavigationBarByBusinessKey

        public static NavigationBar getNavigationBarByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of NavigationBar, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type NavigationBar.
      • getNavigationBarItemByBusinessKey

        public static NavigationBarItem getNavigationBarItemByBusinessKey​(SchedulerSession session,
                                                                          String key)
        Query an instance of NavigationBarItem, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type NavigationBarItem.
      • getObjectDefinitionByBusinessKey

        public static ObjectDefinition getObjectDefinitionByBusinessKey​(SchedulerSession session,
                                                                        String key)
        Query an instance of ObjectDefinition, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ObjectDefinition.
      • getObjectIndexByBusinessKey

        public static ObjectIndex getObjectIndexByBusinessKey​(SchedulerSession session,
                                                              String key)
        Query an instance of ObjectIndex, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ObjectIndex.
      • getObjectReferenceByBusinessKey

        public static ObjectReference getObjectReferenceByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of ObjectReference, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ObjectReference.
      • getObjectSearchByBusinessKey

        public static ObjectSearch getObjectSearchByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of ObjectSearch, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ObjectSearch.
      • getObjectTagByBusinessKey

        public static ObjectTag getObjectTagByBusinessKey​(SchedulerSession session,
                                                          String key)
        Query an instance of ObjectTag, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ObjectTag.
      • getOraAppsSystemByBusinessKey

        public static OraAppsSystem getOraAppsSystemByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of OraAppsSystem, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type OraAppsSystem.
      • getOraOhiSystemByBusinessKey

        public static OraOhiSystem getOraOhiSystemByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of OraOhiSystem, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type OraOhiSystem.
      • getPartitionByBusinessKey

        public static Partition getPartitionByBusinessKey​(SchedulerSession session,
                                                          String key)
        Query an instance of Partition, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Partition.
      • getPeopleSoftSystemByBusinessKey

        public static PeopleSoftSystem getPeopleSoftSystemByBusinessKey​(SchedulerSession session,
                                                                        String key)
        Query an instance of PeopleSoftSystem, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type PeopleSoftSystem.
      • getPeriodFunctionByBusinessKey

        public static PeriodFunction getPeriodFunctionByBusinessKey​(SchedulerSession session,
                                                                    String key)
        Query an instance of PeriodFunction, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type PeriodFunction.
      • getProcessMonitorByBusinessKey

        public static ProcessMonitor getProcessMonitorByBusinessKey​(SchedulerSession session,
                                                                    String key)
        Query an instance of ProcessMonitor, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ProcessMonitor.
      • getProcessServerByBusinessKey

        public static ProcessServer getProcessServerByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of ProcessServer, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ProcessServer.
      • getPublishItemByBusinessKey

        public static PublishItem getPublishItemByBusinessKey​(SchedulerSession session,
                                                              String key)
        Query an instance of PublishItem, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type PublishItem.
      • getQueryConditionByBusinessKey

        public static QueryCondition getQueryConditionByBusinessKey​(SchedulerSession session,
                                                                    String key)
        Query an instance of QueryCondition, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type QueryCondition.
      • getQueryFilterByBusinessKey

        public static QueryFilter getQueryFilterByBusinessKey​(SchedulerSession session,
                                                              String key)
        Query an instance of QueryFilter, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type QueryFilter.
      • getQueueByBusinessKey

        public static Queue getQueueByBusinessKey​(SchedulerSession session,
                                                  String key)
        Query an instance of Queue, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Queue.
      • getQueueAlertSourceByBusinessKey

        public static QueueAlertSource getQueueAlertSourceByBusinessKey​(SchedulerSession session,
                                                                        String key)
        Query an instance of QueueAlertSource, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type QueueAlertSource.
      • getQueueProviderByBusinessKey

        public static QueueProvider getQueueProviderByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of QueueProvider, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type QueueProvider.
      • getR2WCatalogByBusinessKey

        public static R2WCatalog getR2WCatalogByBusinessKey​(SchedulerSession session,
                                                            String key)
        Query an instance of R2WCatalog, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type R2WCatalog.
      • getR2WCatalogAliasByBusinessKey

        public static R2WCatalogAlias getR2WCatalogAliasByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of R2WCatalogAlias, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type R2WCatalogAlias.
      • getRegistryEntryByBusinessKey

        public static RegistryEntry getRegistryEntryByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of RegistryEntry, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type RegistryEntry.
      • getRELEntryPointByBusinessKey

        public static RELEntryPoint getRELEntryPointByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of RELEntryPoint, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type RELEntryPoint.
      • getRemoteSystemByBusinessKey

        public static RemoteSystem getRemoteSystemByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of RemoteSystem, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type RemoteSystem.
      • getReportByBusinessKey

        public static Report getReportByBusinessKey​(SchedulerSession session,
                                                    String key)
        Query an instance of Report, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Report.
      • getReportColumnByBusinessKey

        public static ReportColumn getReportColumnByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of ReportColumn, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ReportColumn.
      • getReportSortByBusinessKey

        public static ReportSort getReportSortByBusinessKey​(SchedulerSession session,
                                                            String key)
        Query an instance of ReportSort, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type ReportSort.
      • getResourceByBusinessKey

        public static Resource getResourceByBusinessKey​(SchedulerSession session,
                                                        String key)
        Query an instance of Resource, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Resource.
      • getSAPAbapProgramByBusinessKey

        public static SAPAbapProgram getSAPAbapProgramByBusinessKey​(SchedulerSession session,
                                                                    String key)
        Query an instance of SAPAbapProgram, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPAbapProgram.
      • getSAPAbapVariantByBusinessKey

        public static SAPAbapVariant getSAPAbapVariantByBusinessKey​(SchedulerSession session,
                                                                    String key)
        Query an instance of SAPAbapVariant, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPAbapVariant.
      • getSAPArchiveObjectByBusinessKey

        public static SAPArchiveObject getSAPArchiveObjectByBusinessKey​(SchedulerSession session,
                                                                        String key)
        Query an instance of SAPArchiveObject, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPArchiveObject.
      • getSAPBAEConnectorByBusinessKey

        public static SAPBAEConnector getSAPBAEConnectorByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of SAPBAEConnector, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPBAEConnector.
      • getSAPBatchEventByBusinessKey

        public static SAPBatchEvent getSAPBatchEventByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of SAPBatchEvent, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPBatchEvent.
      • getSAPCalendarByBusinessKey

        public static SAPCalendar getSAPCalendarByBusinessKey​(SchedulerSession session,
                                                              String key)
        Query an instance of SAPCalendar, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPCalendar.
      • getSAPExternalCommandByBusinessKey

        public static SAPExternalCommand getSAPExternalCommandByBusinessKey​(SchedulerSession session,
                                                                            String key)
        Query an instance of SAPExternalCommand, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPExternalCommand.
      • getSAPInfoPackageByBusinessKey

        public static SAPInfoPackage getSAPInfoPackageByBusinessKey​(SchedulerSession session,
                                                                    String key)
        Query an instance of SAPInfoPackage, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPInfoPackage.
      • getSAPLanguageByBusinessKey

        public static SAPLanguage getSAPLanguageByBusinessKey​(SchedulerSession session,
                                                              String key)
        Query an instance of SAPLanguage, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPLanguage.
      • getSAPMassActivityByBusinessKey

        public static SAPMassActivity getSAPMassActivityByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of SAPMassActivity, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPMassActivity.
      • getSAPOutputDeviceByBusinessKey

        public static SAPOutputDevice getSAPOutputDeviceByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of SAPOutputDevice, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPOutputDevice.
      • getSAPOutputFormatByBusinessKey

        public static SAPOutputFormat getSAPOutputFormatByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of SAPOutputFormat, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPOutputFormat.
      • getSAPPIChannelByBusinessKey

        public static SAPPIChannel getSAPPIChannelByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of SAPPIChannel, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPPIChannel.
      • getSAPProcessChainByBusinessKey

        public static SAPProcessChain getSAPProcessChainByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of SAPProcessChain, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPProcessChain.
      • getSAPRecipientByBusinessKey

        public static SAPRecipient getSAPRecipientByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of SAPRecipient, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPRecipient.
      • getSAPScriptByBusinessKey

        public static SAPScript getSAPScriptByBusinessKey​(SchedulerSession session,
                                                          String key)
        Query an instance of SAPScript, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPScript.
      • getSAPSystemByBusinessKey

        public static SAPSystem getSAPSystemByBusinessKey​(SchedulerSession session,
                                                          String key)
        Query an instance of SAPSystem, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SAPSystem.
      • getScriptByBusinessKey

        public static Script getScriptByBusinessKey​(SchedulerSession session,
                                                    String key)
        Query an instance of Script, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Script.
      • getServiceByBusinessKey

        public static Service getServiceByBusinessKey​(SchedulerSession session,
                                                      String key)
        Query an instance of Service, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Service.
      • getSoftwareGroupByBusinessKey

        public static SoftwareGroup getSoftwareGroupByBusinessKey​(SchedulerSession session,
                                                                  String key)
        Query an instance of SoftwareGroup, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SoftwareGroup.
      • getSoftwareItemByBusinessKey

        public static SoftwareItem getSoftwareItemByBusinessKey​(SchedulerSession session,
                                                                String key)
        Query an instance of SoftwareItem, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SoftwareItem.
      • getSubjectByBusinessKey

        public static Subject getSubjectByBusinessKey​(SchedulerSession session,
                                                      String key)
        Query an instance of Subject, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Subject.
      • getSubjectRoleGrantByBusinessKey

        public static SubjectRoleGrant getSubjectRoleGrantByBusinessKey​(SchedulerSession session,
                                                                        String key)
        Query an instance of SubjectRoleGrant, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SubjectRoleGrant.
      • getSubmitFrameByBusinessKey

        public static SubmitFrame getSubmitFrameByBusinessKey​(SchedulerSession session,
                                                              String key)
        Query an instance of SubmitFrame, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type SubmitFrame.
      • getTableByBusinessKey

        public static Table getTableByBusinessKey​(SchedulerSession session,
                                                  String key)
        Query an instance of Table, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Table.
      • getTableDefinitionByBusinessKey

        public static TableDefinition getTableDefinitionByBusinessKey​(SchedulerSession session,
                                                                      String key)
        Query an instance of TableDefinition, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type TableDefinition.
      • getTimeWindowByBusinessKey

        public static TimeWindow getTimeWindowByBusinessKey​(SchedulerSession session,
                                                            String key)
        Query an instance of TimeWindow, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type TimeWindow.
      • getTimeZoneByBusinessKey

        public static TimeZone getTimeZoneByBusinessKey​(SchedulerSession session,
                                                        String key)
        Query an instance of TimeZone, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type TimeZone.
      • getTriggerByBusinessKey

        public static Trigger getTriggerByBusinessKey​(SchedulerSession session,
                                                      String key)
        Query an instance of Trigger, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type Trigger.
      • getVisualizationAlertByBusinessKey

        public static VisualizationAlert getVisualizationAlertByBusinessKey​(SchedulerSession session,
                                                                            String key)
        Query an instance of VisualizationAlert, based on its business key.
        Parameters:
        key - the business key of the object to locate.
        session - the session to use.
        Returns:
        the object that matches the given business key.
        Throws:
        IllegalArgumentException - This exception is thrown if the business key does not represent an object of type VisualizationAlert.