Package com.redwood.scheduler.api.model
Interface BusinessKeyResolver
-
public interface BusinessKeyResolver
Interface for resolving all concreteBusinessKeyObject
objects based on their business key.
-
-
Field Summary
Fields Modifier and Type Field Description static com.redwood.scheduler.infrastructure.logging.Versions
VERSION_BUSINESSKEYRESOLVER
-
Method Summary
-
-
-
Method Detail
-
getSchedulerEntityByKey
BusinessKeyObject getSchedulerEntityByKey(BusinessKey key)
Query an object based on a business key.- Parameters:
key
- the business key of the object being sought.- Returns:
- the object that corresponds to the business key, or
null
if the object does not exist.
-
getAdHocAlertSourceByKey
AdHocAlertSource getAdHocAlertSourceByKey(BusinessKey key)
Query an instance ofAdHocAlertSource
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getAlertEscalationByKey
AlertEscalation getAlertEscalationByKey(BusinessKey key)
Query an instance ofAlertEscalation
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getAlertEscalationActionByKey
AlertEscalationAction getAlertEscalationActionByKey(BusinessKey key)
Query an instance ofAlertEscalationAction
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 AlertEscalationAction.
-
getApplicationByKey
Application getApplicationByKey(BusinessKey key)
Query an instance ofApplication
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getAuditRuleByKey
AuditRule getAuditRuleByKey(BusinessKey key)
Query an instance ofAuditRule
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getConstraintDefinitionByKey
ConstraintDefinition getConstraintDefinitionByKey(BusinessKey key)
Query an instance ofConstraintDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 ConstraintDefinition.
-
getCredentialByKey
Credential getCredentialByKey(BusinessKey key)
Query an instance ofCredential
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getCredentialProtocolByKey
CredentialProtocol getCredentialProtocolByKey(BusinessKey key)
Query an instance ofCredentialProtocol
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getDashboardByKey
Dashboard getDashboardByKey(BusinessKey key)
Query an instance ofDashboard
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getDatabaseByKey
Database getDatabaseByKey(BusinessKey key)
Query an instance ofDatabase
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getDatumDefinitionByKey
DatumDefinition getDatumDefinitionByKey(BusinessKey key)
Query an instance ofDatumDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getDocumentByKey
Document getDocumentByKey(BusinessKey key)
Query an instance ofDocument
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getEmailAlertGatewayByKey
EmailAlertGateway getEmailAlertGatewayByKey(BusinessKey key)
Query an instance ofEmailAlertGateway
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getEmailAlertGatewayActionByKey
EmailAlertGatewayAction getEmailAlertGatewayActionByKey(BusinessKey key)
Query an instance ofEmailAlertGatewayAction
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 EmailAlertGatewayAction.
-
getEventByKey
Event getEventByKey(BusinessKey key)
Query an instance ofEvent
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getEventDefinitionByKey
EventDefinition getEventDefinitionByKey(BusinessKey key)
Query an instance ofEventDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getExportRuleByKey
ExportRule getExportRuleByKey(BusinessKey key)
Query an instance ofExportRule
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getExportRuleSetByKey
ExportRuleSet getExportRuleSetByKey(BusinessKey key)
Query an instance ofExportRuleSet
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getExtensionPointByKey
ExtensionPoint getExtensionPointByKey(BusinessKey key)
Query an instance ofExtensionPoint
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getForecastJobByKey
ForecastJob getForecastJobByKey(BusinessKey key)
Query an instance ofForecastJob
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getFormatByKey
Format getFormatByKey(BusinessKey key)
Query an instance ofFormat
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getGlobalPrivilegeByKey
GlobalPrivilege getGlobalPrivilegeByKey(BusinessKey key)
Query an instance ofGlobalPrivilege
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getImportActionByKey
ImportAction getImportActionByKey(BusinessKey key)
Query an instance ofImportAction
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getImportRuleByKey
ImportRule getImportRuleByKey(BusinessKey key)
Query an instance ofImportRule
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getImportRuleDefinitionByKey
ImportRuleDefinition getImportRuleDefinitionByKey(BusinessKey key)
Query an instance ofImportRuleDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 ImportRuleDefinition.
-
getImportRuleSetByKey
ImportRuleSet getImportRuleSetByKey(BusinessKey key)
Query an instance ofImportRuleSet
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getImportSourceByKey
ImportSource getImportSourceByKey(BusinessKey key)
Query an instance ofImportSource
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getIsolationGroupByKey
IsolationGroup getIsolationGroupByKey(BusinessKey key)
Query an instance ofIsolationGroup
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJARFileByKey
JARFile getJARFileByKey(BusinessKey key)
Query an instance ofJARFile
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobByKey
Job getJobByKey(BusinessKey key)
Query an instance ofJob
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobChainByKey
JobChain getJobChainByKey(BusinessKey key)
Query an instance ofJobChain
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobChainCallByKey
JobChainCall getJobChainCallByKey(BusinessKey key)
Query an instance ofJobChainCall
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobChainCallJobLockByKey
JobChainCallJobLock getJobChainCallJobLockByKey(BusinessKey key)
Query an instance ofJobChainCallJobLock
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 JobChainCallJobLock.
-
getJobChainCallSchedulingParameterByKey
JobChainCallSchedulingParameter getJobChainCallSchedulingParameterByKey(BusinessKey key)
Query an instance ofJobChainCallSchedulingParameter
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 JobChainCallSchedulingParameter.
-
getJobChainStepByKey
JobChainStep getJobChainStepByKey(BusinessKey key)
Query an instance ofJobChainStep
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobDefinitionByKey
JobDefinition getJobDefinitionByKey(BusinessKey key)
Query an instance ofJobDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobDefinitionActionByKey
JobDefinitionAction getJobDefinitionActionByKey(BusinessKey key)
Query an instance ofJobDefinitionAction
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 JobDefinitionAction.
-
getJobDefinitionAlertSourceByKey
JobDefinitionAlertSource getJobDefinitionAlertSourceByKey(BusinessKey key)
Query an instance ofJobDefinitionAlertSource
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 JobDefinitionAlertSource.
-
getJobDefinitionConstraintByKey
JobDefinitionConstraint getJobDefinitionConstraintByKey(BusinessKey key)
Query an instance ofJobDefinitionConstraint
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 JobDefinitionConstraint.
-
getJobDefinitionConstraintParameterMappingByKey
JobDefinitionConstraintParameterMapping getJobDefinitionConstraintParameterMappingByKey(BusinessKey key)
Query an instance ofJobDefinitionConstraintParameterMapping
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 JobDefinitionConstraintParameterMapping.
-
getJobDefinitionFormByKey
JobDefinitionForm getJobDefinitionFormByKey(BusinessKey key)
Query an instance ofJobDefinitionForm
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobDefinitionJobLockByKey
JobDefinitionJobLock getJobDefinitionJobLockByKey(BusinessKey key)
Query an instance ofJobDefinitionJobLock
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 JobDefinitionJobLock.
-
getJobDefinitionParameterByKey
JobDefinitionParameter getJobDefinitionParameterByKey(BusinessKey key)
Query an instance ofJobDefinitionParameter
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 JobDefinitionParameter.
-
getJobDefinitionParameterSubTypeByKey
JobDefinitionParameterSubType getJobDefinitionParameterSubTypeByKey(BusinessKey key)
Query an instance ofJobDefinitionParameterSubType
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 JobDefinitionParameterSubType.
-
getJobDefinitionRuntimeLimitByKey
JobDefinitionRuntimeLimit getJobDefinitionRuntimeLimitByKey(BusinessKey key)
Query an instance ofJobDefinitionRuntimeLimit
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 JobDefinitionRuntimeLimit.
-
getJobDefinitionTypeByKey
JobDefinitionType getJobDefinitionTypeByKey(BusinessKey key)
Query an instance ofJobDefinitionType
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobDefinitionTypeActionByKey
JobDefinitionTypeAction getJobDefinitionTypeActionByKey(BusinessKey key)
Query an instance ofJobDefinitionTypeAction
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 JobDefinitionTypeAction.
-
getJobFileSearchByKey
JobFileSearch getJobFileSearchByKey(BusinessKey key)
Query an instance ofJobFileSearch
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobGroupByKey
JobGroup getJobGroupByKey(BusinessKey key)
Query an instance ofJobGroup
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobLockByKey
JobLock getJobLockByKey(BusinessKey key)
Query an instance ofJobLock
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobRaiseEventByKey
JobRaiseEvent getJobRaiseEventByKey(BusinessKey key)
Query an instance ofJobRaiseEvent
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobRuntimeLimitByKey
JobRuntimeLimit getJobRuntimeLimitByKey(BusinessKey key)
Query an instance ofJobRuntimeLimit
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getJobWaitEventByKey
JobWaitEvent getJobWaitEventByKey(BusinessKey key)
Query an instance ofJobWaitEvent
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getLibraryByKey
Library getLibraryByKey(BusinessKey key)
Query an instance ofLibrary
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getLibrarySourceByKey
LibrarySource getLibrarySourceByKey(BusinessKey key)
Query an instance ofLibrarySource
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getLicenseKeyByKey
LicenseKey getLicenseKeyByKey(BusinessKey key)
Query an instance ofLicenseKey
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getMailConnectorByKey
MailConnector getMailConnectorByKey(BusinessKey key)
Query an instance ofMailConnector
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getMonitorAlertSourceByKey
MonitorAlertSource getMonitorAlertSourceByKey(BusinessKey key)
Query an instance ofMonitorAlertSource
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getMonitorCheckByKey
MonitorCheck getMonitorCheckByKey(BusinessKey key)
Query an instance ofMonitorCheck
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getMonitorEventByKey
MonitorEvent getMonitorEventByKey(BusinessKey key)
Query an instance ofMonitorEvent
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getMonitorLinkByKey
MonitorLink getMonitorLinkByKey(BusinessKey key)
Query an instance ofMonitorLink
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getMonitorNodeByKey
MonitorNode getMonitorNodeByKey(BusinessKey key)
Query an instance ofMonitorNode
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getMonitorValueByKey
MonitorValue getMonitorValueByKey(BusinessKey key)
Query an instance ofMonitorValue
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getNavigationBarByKey
NavigationBar getNavigationBarByKey(BusinessKey key)
Query an instance ofNavigationBar
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getNavigationBarItemByKey
NavigationBarItem getNavigationBarItemByKey(BusinessKey key)
Query an instance ofNavigationBarItem
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getObjectDefinitionByKey
ObjectDefinition getObjectDefinitionByKey(BusinessKey key)
Query an instance ofObjectDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getObjectFieldDefinitionByKey
ObjectFieldDefinition getObjectFieldDefinitionByKey(BusinessKey key)
Query an instance ofObjectFieldDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 ObjectFieldDefinition.
-
getObjectIndexByKey
ObjectIndex getObjectIndexByKey(BusinessKey key)
Query an instance ofObjectIndex
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getObjectReferenceByKey
ObjectReference getObjectReferenceByKey(BusinessKey key)
Query an instance ofObjectReference
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getObjectSearchByKey
ObjectSearch getObjectSearchByKey(BusinessKey key)
Query an instance ofObjectSearch
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getObjectTagByKey
ObjectTag getObjectTagByKey(BusinessKey key)
Query an instance ofObjectTag
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getObjectTagDefinitionByKey
ObjectTagDefinition getObjectTagDefinitionByKey(BusinessKey key)
Query an instance ofObjectTagDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 ObjectTagDefinition.
-
getOraAppsSystemByKey
OraAppsSystem getOraAppsSystemByKey(BusinessKey key)
Query an instance ofOraAppsSystem
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getOraOhiSystemByKey
OraOhiSystem getOraOhiSystemByKey(BusinessKey key)
Query an instance ofOraOhiSystem
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getPartitionByKey
Partition getPartitionByKey(BusinessKey key)
Query an instance ofPartition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getPeopleSoftSystemByKey
PeopleSoftSystem getPeopleSoftSystemByKey(BusinessKey key)
Query an instance ofPeopleSoftSystem
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getPeriodFunctionByKey
PeriodFunction getPeriodFunctionByKey(BusinessKey key)
Query an instance ofPeriodFunction
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getProcessMonitorByKey
ProcessMonitor getProcessMonitorByKey(BusinessKey key)
Query an instance ofProcessMonitor
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getProcessMonitorDefinitionByKey
ProcessMonitorDefinition getProcessMonitorDefinitionByKey(BusinessKey key)
Query an instance ofProcessMonitorDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 ProcessMonitorDefinition.
-
getProcessMonitorItemDefinitionByKey
ProcessMonitorItemDefinition getProcessMonitorItemDefinitionByKey(BusinessKey key)
Query an instance ofProcessMonitorItemDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 ProcessMonitorItemDefinition.
-
getProcessServerByKey
ProcessServer getProcessServerByKey(BusinessKey key)
Query an instance ofProcessServer
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getProcessServerAlertSourceByKey
ProcessServerAlertSource getProcessServerAlertSourceByKey(BusinessKey key)
Query an instance ofProcessServerAlertSource
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 ProcessServerAlertSource.
-
getProcessServerJobDefinitionTypeByKey
ProcessServerJobDefinitionType getProcessServerJobDefinitionTypeByKey(BusinessKey key)
Query an instance ofProcessServerJobDefinitionType
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 ProcessServerJobDefinitionType.
-
getProcessServerResourceByKey
ProcessServerResource getProcessServerResourceByKey(BusinessKey key)
Query an instance ofProcessServerResource
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 ProcessServerResource.
-
getProcessServerServiceByKey
ProcessServerService getProcessServerServiceByKey(BusinessKey key)
Query an instance ofProcessServerService
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 ProcessServerService.
-
getPublishItemByKey
PublishItem getPublishItemByKey(BusinessKey key)
Query an instance ofPublishItem
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getQueryConditionByKey
QueryCondition getQueryConditionByKey(BusinessKey key)
Query an instance ofQueryCondition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getQueryFilterByKey
QueryFilter getQueryFilterByKey(BusinessKey key)
Query an instance ofQueryFilter
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getQueueByKey
Queue getQueueByKey(BusinessKey key)
Query an instance ofQueue
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getQueueAlertSourceByKey
QueueAlertSource getQueueAlertSourceByKey(BusinessKey key)
Query an instance ofQueueAlertSource
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getQueueProviderByKey
QueueProvider getQueueProviderByKey(BusinessKey key)
Query an instance ofQueueProvider
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getR2WCatalogByKey
R2WCatalog getR2WCatalogByKey(BusinessKey key)
Query an instance ofR2WCatalog
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getR2WCatalogAliasByKey
R2WCatalogAlias getR2WCatalogAliasByKey(BusinessKey key)
Query an instance ofR2WCatalogAlias
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getRegistryEntryByKey
RegistryEntry getRegistryEntryByKey(BusinessKey key)
Query an instance ofRegistryEntry
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getRELEntryPointByKey
RELEntryPoint getRELEntryPointByKey(BusinessKey key)
Query an instance ofRELEntryPoint
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getRemoteSystemByKey
RemoteSystem getRemoteSystemByKey(BusinessKey key)
Query an instance ofRemoteSystem
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getReportByKey
Report getReportByKey(BusinessKey key)
Query an instance ofReport
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getReportColumnByKey
ReportColumn getReportColumnByKey(BusinessKey key)
Query an instance ofReportColumn
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getReportSortByKey
ReportSort getReportSortByKey(BusinessKey key)
Query an instance ofReportSort
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getResourceByKey
Resource getResourceByKey(BusinessKey key)
Query an instance ofResource
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPAbapProgramByKey
SAPAbapProgram getSAPAbapProgramByKey(BusinessKey key)
Query an instance ofSAPAbapProgram
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPAbapVariantByKey
SAPAbapVariant getSAPAbapVariantByKey(BusinessKey key)
Query an instance ofSAPAbapVariant
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPAbapVariantParameterValueByKey
SAPAbapVariantParameterValue getSAPAbapVariantParameterValueByKey(BusinessKey key)
Query an instance ofSAPAbapVariantParameterValue
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPAbapVariantParameterValue.
-
getSAPAbapVariantSeloptByKey
SAPAbapVariantSelopt getSAPAbapVariantSeloptByKey(BusinessKey key)
Query an instance ofSAPAbapVariantSelopt
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPAbapVariantSelopt.
-
getSAPApplicationServerByKey
SAPApplicationServer getSAPApplicationServerByKey(BusinessKey key)
Query an instance ofSAPApplicationServer
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPApplicationServer.
-
getSAPApplicationServerGroupByKey
SAPApplicationServerGroup getSAPApplicationServerGroupByKey(BusinessKey key)
Query an instance ofSAPApplicationServerGroup
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPApplicationServerGroup.
-
getSAPApplicationServerProviderByKey
SAPApplicationServerProvider getSAPApplicationServerProviderByKey(BusinessKey key)
Query an instance ofSAPApplicationServerProvider
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPApplicationServerProvider.
-
getSAPArchiveDocumentTypeByKey
SAPArchiveDocumentType getSAPArchiveDocumentTypeByKey(BusinessKey key)
Query an instance ofSAPArchiveDocumentType
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPArchiveDocumentType.
-
getSAPArchiveObjectByKey
SAPArchiveObject getSAPArchiveObjectByKey(BusinessKey key)
Query an instance ofSAPArchiveObject
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPBAEConnectorByKey
SAPBAEConnector getSAPBAEConnectorByKey(BusinessKey key)
Query an instance ofSAPBAEConnector
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPBatchEventByKey
SAPBatchEvent getSAPBatchEventByKey(BusinessKey key)
Query an instance ofSAPBatchEvent
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPCalendarByKey
SAPCalendar getSAPCalendarByKey(BusinessKey key)
Query an instance ofSAPCalendar
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPExternalCommandByKey
SAPExternalCommand getSAPExternalCommandByKey(BusinessKey key)
Query an instance ofSAPExternalCommand
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPInfoPackageByKey
SAPInfoPackage getSAPInfoPackageByKey(BusinessKey key)
Query an instance ofSAPInfoPackage
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPInfoPackageGroupByKey
SAPInfoPackageGroup getSAPInfoPackageGroupByKey(BusinessKey key)
Query an instance ofSAPInfoPackageGroup
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPInfoPackageGroup.
-
getSAPInfoPackageGroupStepByKey
SAPInfoPackageGroupStep getSAPInfoPackageGroupStepByKey(BusinessKey key)
Query an instance ofSAPInfoPackageGroupStep
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPInfoPackageGroupStep.
-
getSAPLanguageByKey
SAPLanguage getSAPLanguageByKey(BusinessKey key)
Query an instance ofSAPLanguage
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPMassActivityByKey
SAPMassActivity getSAPMassActivityByKey(BusinessKey key)
Query an instance ofSAPMassActivity
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPMassActivityFieldParameterByKey
SAPMassActivityFieldParameter getSAPMassActivityFieldParameterByKey(BusinessKey key)
Query an instance ofSAPMassActivityFieldParameter
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPMassActivityFieldParameter.
-
getSAPMassActivityFieldTableByKey
SAPMassActivityFieldTable getSAPMassActivityFieldTableByKey(BusinessKey key)
Query an instance ofSAPMassActivityFieldTable
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPMassActivityFieldTable.
-
getSAPMassActivityFieldTableRowByKey
SAPMassActivityFieldTableRow getSAPMassActivityFieldTableRowByKey(BusinessKey key)
Query an instance ofSAPMassActivityFieldTableRow
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPMassActivityFieldTableRow.
-
getSAPMassActivityFieldTableRowValueByKey
SAPMassActivityFieldTableRowValue getSAPMassActivityFieldTableRowValueByKey(BusinessKey key)
Query an instance ofSAPMassActivityFieldTableRowValue
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPMassActivityFieldTableRowValue.
-
getSAPMassActivityLayoutFieldByKey
SAPMassActivityLayoutField getSAPMassActivityLayoutFieldByKey(BusinessKey key)
Query an instance ofSAPMassActivityLayoutField
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPMassActivityLayoutField.
-
getSAPMassActivityObjectByKey
SAPMassActivityObject getSAPMassActivityObjectByKey(BusinessKey key)
Query an instance ofSAPMassActivityObject
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPMassActivityObject.
-
getSAPMassActivityParameterByKey
SAPMassActivityParameter getSAPMassActivityParameterByKey(BusinessKey key)
Query an instance ofSAPMassActivityParameter
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPMassActivityParameter.
-
getSAPMassActivityParameterSetByKey
SAPMassActivityParameterSet getSAPMassActivityParameterSetByKey(BusinessKey key)
Query an instance ofSAPMassActivityParameterSet
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPMassActivityParameterSet.
-
getSAPMassActivityStructureByKey
SAPMassActivityStructure getSAPMassActivityStructureByKey(BusinessKey key)
Query an instance ofSAPMassActivityStructure
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPMassActivityStructure.
-
getSAPNWCallbackVariantByKey
SAPNWCallbackVariant getSAPNWCallbackVariantByKey(BusinessKey key)
Query an instance ofSAPNWCallbackVariant
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPNWCallbackVariant.
-
getSAPOutputDeviceByKey
SAPOutputDevice getSAPOutputDeviceByKey(BusinessKey key)
Query an instance ofSAPOutputDevice
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPOutputFormatByKey
SAPOutputFormat getSAPOutputFormatByKey(BusinessKey key)
Query an instance ofSAPOutputFormat
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPPIChannelByKey
SAPPIChannel getSAPPIChannelByKey(BusinessKey key)
Query an instance ofSAPPIChannel
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPProcessChainByKey
SAPProcessChain getSAPProcessChainByKey(BusinessKey key)
Query an instance ofSAPProcessChain
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPProcessDefinitionByKey
SAPProcessDefinition getSAPProcessDefinitionByKey(BusinessKey key)
Query an instance ofSAPProcessDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SAPProcessDefinition.
-
getSAPRecipientByKey
SAPRecipient getSAPRecipientByKey(BusinessKey key)
Query an instance ofSAPRecipient
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPScriptByKey
SAPScript getSAPScriptByKey(BusinessKey key)
Query an instance ofSAPScript
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSAPSystemByKey
SAPSystem getSAPSystemByKey(BusinessKey key)
Query an instance ofSAPSystem
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getScriptByKey
Script getScriptByKey(BusinessKey key)
Query an instance ofScript
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getServiceByKey
Service getServiceByKey(BusinessKey key)
Query an instance ofService
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSoftwareGroupByKey
SoftwareGroup getSoftwareGroupByKey(BusinessKey key)
Query an instance ofSoftwareGroup
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSoftwareItemByKey
SoftwareItem getSoftwareItemByKey(BusinessKey key)
Query an instance ofSoftwareItem
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSubjectByKey
Subject getSubjectByKey(BusinessKey key)
Query an instance ofSubject
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSubjectGlobalPrivilegeGrantByKey
SubjectGlobalPrivilegeGrant getSubjectGlobalPrivilegeGrantByKey(BusinessKey key)
Query an instance ofSubjectGlobalPrivilegeGrant
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SubjectGlobalPrivilegeGrant.
-
getSubjectIsolationGroupByKey
SubjectIsolationGroup getSubjectIsolationGroupByKey(BusinessKey key)
Query an instance ofSubjectIsolationGroup
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SubjectIsolationGroup.
-
getSubjectObjectPrivilegeGrantByKey
SubjectObjectPrivilegeGrant getSubjectObjectPrivilegeGrantByKey(BusinessKey key)
Query an instance ofSubjectObjectPrivilegeGrant
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SubjectObjectPrivilegeGrant.
-
getSubjectObjectTypePrivilegeGrantByKey
SubjectObjectTypePrivilegeGrant getSubjectObjectTypePrivilegeGrantByKey(BusinessKey key)
Query an instance ofSubjectObjectTypePrivilegeGrant
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 SubjectObjectTypePrivilegeGrant.
-
getSubjectRoleGrantByKey
SubjectRoleGrant getSubjectRoleGrantByKey(BusinessKey key)
Query an instance ofSubjectRoleGrant
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getSubmitFrameByKey
SubmitFrame getSubmitFrameByKey(BusinessKey key)
Query an instance ofSubmitFrame
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getTableByKey
Table getTableByKey(BusinessKey key)
Query an instance ofTable
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getTableDefinitionByKey
TableDefinition getTableDefinitionByKey(BusinessKey key)
Query an instance ofTableDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getTableDefinitionConstraintByKey
TableDefinitionConstraint getTableDefinitionConstraintByKey(BusinessKey key)
Query an instance ofTableDefinitionConstraint
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 TableDefinitionConstraint.
-
getTableDefinitionConstraintParameterMappingByKey
TableDefinitionConstraintParameterMapping getTableDefinitionConstraintParameterMappingByKey(BusinessKey key)
Query an instance ofTableDefinitionConstraintParameterMapping
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 TableDefinitionConstraintParameterMapping.
-
getTimeWindowByKey
TimeWindow getTimeWindowByKey(BusinessKey key)
Query an instance ofTimeWindow
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getTimeZoneByKey
TimeZone getTimeZoneByKey(BusinessKey key)
Query an instance ofTimeZone
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getTriggerByKey
Trigger getTriggerByKey(BusinessKey key)
Query an instance ofTrigger
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getUserMessageDefinitionByKey
UserMessageDefinition getUserMessageDefinitionByKey(BusinessKey key)
Query an instance ofUserMessageDefinition
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 UserMessageDefinition.
-
getVisualizationAlertByKey
VisualizationAlert getVisualizationAlertByKey(BusinessKey key)
Query an instance ofVisualizationAlert
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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.
-
getVisualizationProcessServerQueueByKey
VisualizationProcessServerQueue getVisualizationProcessServerQueueByKey(BusinessKey key)
Query an instance ofVisualizationProcessServerQueue
, based on its business key.- Parameters:
key
- the business key of the object to locate.- 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 VisualizationProcessServerQueue.
-
-