Package com.redwood.scheduler.api.model
Interface SAPSystem
-
- All Superinterfaces:
ApplicationObject,BusinessKeyObject,NamedRootObject,NamedRootObjectComp,PartitionableObject,PartitionableObjectComp,Readable,Root,SAPSystemComp,SchedulerEntity,SchedulerEntityComp,UniqueNamedApplicationObject
public interface SAPSystem extends SAPSystemComp, UniqueNamedApplicationObject, Readable
Settings relating to a SAP System.
-
-
Field Summary
Fields Modifier and Type Field Description static StringDEFAULT_J2EE_CONNECT_STRINGDefault J2EE connect string.static StringDEFAULT_RFC_CONNECT_STRINGDefault RFC connect string.static StringOBJECT_TYPEString that will be returned fromSchedulerEntity.getObjectType()for "SAPSystem" objects.static StringSEC_PRIV_BUSINESSAUTOMATIONAPIThis privilege can be granted at an instance level.static StringSEC_PRIV_CREATEThis privilege can be granted at a group level.static StringSEC_PRIV_DELETEThis privilege can be granted at a group level.static StringSEC_PRIV_EDITThis privilege can be granted at a group level.static StringSEC_PRIV_VIEWThis privilege can be granted at a group level.static StringSEC_RANK_ALLThis rank is made of the following privileges: create , view , edit , businessAutomationAPI , deletestatic StringSEC_RANK_BUSINESSAUTOMATIONUSERThis rank is made of the following privileges: view , businessAutomationAPIstatic StringSEC_RANK_CREATEThis rank is made of the following privileges: createstatic StringSEC_RANK_DELETEThis rank is made of the following privileges: create , view , deletestatic StringSEC_RANK_EDITThis rank is made of the following privileges: create , view , editstatic StringSEC_RANK_NONEThis rank has no privileges assigned to it.static StringSEC_RANK_VIEWThis rank is made of the following privileges: viewstatic QueryObjectType<SAPSystem>TYPEType that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).-
Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity
ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description RequiredPermissioncheckBusinessAutomationAPIPrivilege()Check whether or not the businessAutomationAPI action can be performed on this object.String[]checkConnectString()Check the connection strings for validity.RequiredPermissioncheckCreatePrivilege()Check whether or not the create action can be performed on this object.RequiredPermissioncheckDeletePrivilege()Check whether or not the delete action can be performed on this object.RequiredPermissioncheckEditPrivilege()Check whether or not the edit action can be performed on this object.RequiredPermissioncheckViewPrivilege()Check whether or not the view action can be performed on this object.SAPAbapProgramcreateSAPAbapProgram()Create a newSAPAbapProgramlinked to this object.SAPApplicationServercreateSAPApplicationServer()Create a newSAPApplicationServerlinked to this object.SAPApplicationServerGroupcreateSAPApplicationServerGroup()Create a newSAPApplicationServerGrouplinked to this object.SAPArchiveObjectcreateSAPArchiveObject()Create a newSAPArchiveObjectlinked to this object.SAPBatchEventcreateSAPBatchEvent()Create a newSAPBatchEventlinked to this object.SAPCalendarcreateSAPCalendar()Create a newSAPCalendarlinked to this object.SAPExternalCommandcreateSAPExternalCommand()Create a newSAPExternalCommandlinked to this object.SAPInfoPackagecreateSAPInfoPackage()Create a newSAPInfoPackagelinked to this object.SAPInfoPackageGroupcreateSAPInfoPackageGroup()Create a newSAPInfoPackageGrouplinked to this object.SAPJ2EEClientcreateSAPJ2EEClient()Create a newSAPJ2EEClientlinked to this object.SAPLanguagecreateSAPLanguage()Create a newSAPLanguagelinked to this object.SAPLogErrorcreateSAPLogError()Create a newSAPLogErrorlinked to this object.SAPMassActivitycreateSAPMassActivity()Create a newSAPMassActivitylinked to this object.SAPOutputDevicecreateSAPOutputDevice()Create a newSAPOutputDevicelinked to this object.SAPPIChannelcreateSAPPIChannel()Create a newSAPPIChannellinked to this object.SAPProcessChaincreateSAPProcessChain()Create a newSAPProcessChainlinked to this object.SAPRecipientcreateSAPRecipient()Create a newSAPRecipientlinked to this object.SAPXALcreateSAPXAL()Create a newSAPXALlinked to this object.SAPXBPcreateSAPXBP()Create a newSAPXBPlinked to this object.SAPXBPEventRulecreateSAPXBPEventRule()Create a newSAPXBPEventRulelinked to this object.SAPXBPJobControlRulecreateSAPXBPJobControlRule()Create a newSAPXBPJobControlRulelinked to this object.SAPXMWcreateSAPXMW()Create a newSAPXMWlinked to this object.JobDefinitiongetCcmsJobDefinition()Get the CcmsJobDefinition.StringgetConnectString()Get the value for ConnectString.StringgetDefaultClientNumber()Get the value for DefaultClientNumber.TimeZonegetDefaultJobTimeZone()Get the DefaultJobTimeZone.ProcessServergetDefaultOutputRetrievalProcessServer()Get the default output retrieval Process Server.SAPXBPgetDefaultXBPClient()Get the default XBP client.ProcessServergetFailOverSpoolListRetrievalProcessServer()Get the FailOverSpoolListRetrievalProcessServer.StringgetJ2EEConnectString()Get the value for J2EEConnectString.JobHandlingTypegetJobHandlingEnabled()Get the value for JobHandlingEnabled.ProcessServergetProcessServer()Get the ProcessServer.QueuegetQueue()Get the Queue.SAPAbapProgramgetSAPAbapProgramByName(String name)Get the SAPAbapProgram by NameSAPSystem.RWIterable<SAPAbapProgram>getSAPAbapPrograms()Get anRWIterableover an ordered collection ofSAPAbapPrograms.SAPApplicationServergetSAPApplicationServerByName(String name)Get the SAPApplicationServer by NameSAPSystem.SAPApplicationServerGroupgetSAPApplicationServerGroupByName(String name)Get the SAPApplicationServerGroup by NameSAPSystem.RWIterable<SAPApplicationServerGroup>getSAPApplicationServerGroups()Get anRWIterableover an ordered collection ofSAPApplicationServerGroups.RWIterable<SAPApplicationServer>getSAPApplicationServers()Get anRWIterableover an ordered collection ofSAPApplicationServers.SAPArchiveObjectgetSAPArchiveObjectByName(String name)Get the SAPArchiveObject by NameSAPSystem.RWIterable<SAPArchiveObject>getSAPArchiveObjects()Get anRWIterableover an ordered collection ofSAPArchiveObjects.SAPBatchEventgetSAPBatchEventByName(String name)Get the SAPBatchEvent by NameSAPBatchEvent.RWIterable<SAPBatchEvent>getSAPBatchEvents()Get anRWIterableover an ordered collection ofSAPBatchEvents.SAPCalendargetSAPCalendarByTypeIdentYear(String type, String ident, Long year)Get the SAPCalendar by TypeIdentYearSAPSystem.RWIterable<SAPCalendar>getSAPCalendars()Get anRWIterableover an ordered collection ofSAPCalendars.SAPExternalCommandgetSAPExternalCommandByNameOsType(String name, String osType)Get the SAPExternalCommand by NameSAPSystem.RWIterable<SAPExternalCommand>getSAPExternalCommands()Get anRWIterableover an ordered collection ofSAPExternalCommands.SAPInfoPackagegetSAPInfoPackageByName(String name)Get the SAPInfoPackage by NameSAPSystem.SAPInfoPackageGroupgetSAPInfoPackageGroupByName(String name)Get the SAPInfoPackageGroup by NameSAPSystem.RWIterable<SAPInfoPackageGroup>getSAPInfoPackageGroups()Get anRWIterableover an ordered collection ofSAPInfoPackageGroups.RWIterable<SAPInfoPackage>getSAPInfoPackages()Get anRWIterableover an ordered collection ofSAPInfoPackages.RWIterable<SAPJ2EEClient>getSAPJ2EEClients()Get anRWIterableover an ordered collection ofSAPJ2EEClients.SAPLanguagegetSAPLanguageBySAPLanguage(String sAPLanguage)Get the SAPLanguage by SAPLanguageSAPSystem.RWIterable<SAPLanguage>getSAPLanguages()Get anRWIterableover a collection ofSAPLanguages, the collection will be ordered by Name.RWIterable<SAPLogError>getSAPLogErrors()Get anRWIterableover an ordered collection ofSAPLogErrors.RWIterable<SAPMassActivity>getSAPMassActivities()Get anRWIterableover an ordered collection ofSAPMassActivities.SAPMassActivitygetSAPMassActivityByName(String name)Get the SAPMassActivity by NameSAPSystem.SAPOutputDevicegetSAPOutputDeviceByName(String name)Get the SAPOutputDevice by NameSAPSystem.RWIterable<SAPOutputDevice>getSAPOutputDevices()Get anRWIterableover an ordered collection ofSAPOutputDevices.SAPPIChannelgetSAPPIChannelByChannelId(String channelId)Get the SAPPIChannel by ChannelIdSAPSystem.RWIterable<SAPPIChannel>getSAPPIChannels()Get anRWIterableover an ordered collection ofSAPPIChannels.SAPProcessChaingetSAPProcessChainByName(String name)Get the SAPProcessChain by NameSAPSystem.RWIterable<SAPProcessChain>getSAPProcessChains()Get anRWIterableover an ordered collection ofSAPProcessChains.SAPRecipientgetSAPRecipientByNameTypeClientNumber(String name, SAPRecipientType type, String clientNumber)Get the SAPRecipient by NameSAPSystem.SAPRecipientgetSAPRecipientBySearchNameTypeClientNumber(String searchName, SAPRecipientType type, String clientNumber)Get the SAPRecipient by SearchNameSAPSystem.RWIterable<SAPRecipient>getSAPRecipients()Get anRWIterableover an ordered collection ofSAPRecipients.SAPXALgetSAPXAL()Get the SAPXAL.RWIterable<SAPXBPEventRule>getSAPXBPEventRules()Get anRWIterableover an ordered collection ofSAPXBPEventRules.RWIterable<SAPXBPJobControlRule>getSAPXBPJobControlRules()Get anRWIterableover a collection ofSAPXBPJobControlRules, the collection will be ordered by ProcessingOrder.RWIterable<SAPXBP>getSAPXBPs()Get anRWIterableover an ordered collection ofSAPXBPs.SAPXMWgetSAPXMW()Get the SAPXMW.ProcessServergetSpoolListRetrievalProcessServer()Get the SpoolListRetrievalProcessServer.voidinit()Perform initialization tasks for the SAP System.booleanisCurrentlyIsolated()Get the value for CurrentlyIsolated.booleanisIsolated()Get the value for Isolated.booleanisLoadBalancingEnabled()Get the value for LoadBalancingEnabled.booleanisSNCConnection()Check if the connection is using SNC.voidsetCcmsJobDefinition(JobDefinition newCcmsJobDefinition)Set the value for CcmsJobDefinition.voidsetConnectString(String newConnectString)Set the value for ConnectString.voidsetDefaultJobTimeZone(TimeZone newDefaultJobTimeZone)Set the value for DefaultJobTimeZone.voidsetFailOverSpoolListRetrievalProcessServer(ProcessServer newFailOverSpoolListRetrievalProcessServer)Set the value for FailOverSpoolListRetrievalProcessServer.voidsetIsolated(boolean newIsolated)Set the value for Isolated.voidsetJ2EEConnectString(String newJ2EEConnectString)Set the value for J2EEConnectString.voidsetJobHandlingEnabled(JobHandlingType newJobHandlingEnabled)Set the value for JobHandlingEnabled.voidsetLoadBalancingEnabled(boolean newLoadBalancingEnabled)Set the value for LoadBalancingEnabled.voidsetProcessServer(ProcessServer newProcessServer)Set the value for ProcessServer.voidsetQueue(Queue newQueue)Set the value for Queue.voidsetSpoolListRetrievalProcessServer(ProcessServer newSpoolListRetrievalProcessServer)Set the value for SpoolListRetrievalProcessServer.-
Methods inherited from interface com.redwood.scheduler.api.model.ApplicationObject
getParentApplication, setParentApplication
-
Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject
getBusinessKey
-
Methods inherited from interface com.redwood.scheduler.api.model.NamedRootObject
createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName
-
Methods inherited from interface com.redwood.scheduler.api.model.PartitionableObject
createObjectTag, getEditablePartitions, getObjectTagByObjectTagDefinition, getObjectTags, getPartition, setPartition
-
Methods inherited from interface com.redwood.scheduler.api.model.Root
getCreationTime, getLastModificationTime, getLastModifierSubject
-
Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity
canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead
-
-
-
-
Field Detail
-
OBJECT_TYPE
static final String OBJECT_TYPE
String that will be returned fromSchedulerEntity.getObjectType()for "SAPSystem" objects.- See Also:
- Constant Field Values
-
TYPE
static final QueryObjectType<SAPSystem> TYPE
Type that can be used inSchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
-
DEFAULT_RFC_CONNECT_STRING
static final String DEFAULT_RFC_CONNECT_STRING
Default RFC connect string.- See Also:
- Constant Field Values
-
DEFAULT_J2EE_CONNECT_STRING
static final String DEFAULT_J2EE_CONNECT_STRING
Default J2EE connect string.- See Also:
- Constant Field Values
-
SEC_PRIV_CREATE
static final String SEC_PRIV_CREATE
This privilege can be granted at a group level.- See Also:
- Constant Field Values
-
SEC_PRIV_VIEW
static final String SEC_PRIV_VIEW
This privilege can be granted at a group level. This privilege can be granted at an instance level.- See Also:
- Constant Field Values
-
SEC_PRIV_EDIT
static final String SEC_PRIV_EDIT
This privilege can be granted at a group level. This privilege can be granted at an instance level.- See Also:
- Constant Field Values
-
SEC_PRIV_BUSINESSAUTOMATIONAPI
static final String SEC_PRIV_BUSINESSAUTOMATIONAPI
This privilege can be granted at an instance level.- See Also:
- Constant Field Values
-
SEC_PRIV_DELETE
static final String SEC_PRIV_DELETE
This privilege can be granted at a group level. This privilege can be granted at an instance level.- See Also:
- Constant Field Values
-
SEC_RANK_NONE
static final String SEC_RANK_NONE
This rank has no privileges assigned to it.- See Also:
- Constant Field Values
-
SEC_RANK_CREATE
static final String SEC_RANK_CREATE
This rank is made of the following privileges: create- See Also:
- Constant Field Values
-
SEC_RANK_VIEW
static final String SEC_RANK_VIEW
This rank is made of the following privileges: view- See Also:
- Constant Field Values
-
SEC_RANK_EDIT
static final String SEC_RANK_EDIT
This rank is made of the following privileges: create , view , edit- See Also:
- Constant Field Values
-
SEC_RANK_DELETE
static final String SEC_RANK_DELETE
This rank is made of the following privileges: create , view , delete- See Also:
- Constant Field Values
-
SEC_RANK_BUSINESSAUTOMATIONUSER
static final String SEC_RANK_BUSINESSAUTOMATIONUSER
This rank is made of the following privileges: view , businessAutomationAPI- See Also:
- Constant Field Values
-
SEC_RANK_ALL
static final String SEC_RANK_ALL
This rank is made of the following privileges: create , view , edit , businessAutomationAPI , delete- See Also:
- Constant Field Values
-
-
Method Detail
-
getConnectString
String getConnectString()
Get the value for ConnectString. (Connection string for reaching the ABAP stack of this SAP system) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
getJ2EEConnectString
String getJ2EEConnectString()
Get the value for J2EEConnectString. (Connection string for reaching the J2EE stack of this SAP system)- Returns:
- the field
- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
isCurrentlyIsolated
boolean isCurrentlyIsolated()
Get the value for CurrentlyIsolated. (Whether this SAP system is actually isolated or not at the moment.)- Returns:
- the field
- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
getDefaultClientNumber
String getDefaultClientNumber()
Get the value for DefaultClientNumber. (Default XBP client number to use for this system.)- Returns:
- the field
- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
isIsolated
boolean isIsolated()
Get the value for Isolated. (Whether this SAP system is considered isolated or not.)- Returns:
- the field
- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
isLoadBalancingEnabled
boolean isLoadBalancingEnabled()
Get the value for LoadBalancingEnabled. (Whether application server load balancing is enabled for this SAP system.)- Returns:
- the field
- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
getJobHandlingEnabled
JobHandlingType getJobHandlingEnabled()
Get the value for JobHandlingEnabled. (Should the XBP job interception and synchronization for this SAP System be enabled?) This value is mandatory, and therefore will not benullif this object has been retrieved from the database.- Returns:
- the field
- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
setConnectString
void setConnectString(String newConnectString)
Set the value for ConnectString. (Connection string for reaching the ABAP stack of this SAP system) This value is mandatory.- Parameters:
newConnectString- the new value for ConnectString. If this isnull, then the object cannot be persisted.- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
setJ2EEConnectString
void setJ2EEConnectString(String newJ2EEConnectString)
Set the value for J2EEConnectString. (Connection string for reaching the J2EE stack of this SAP system) This value is optional.- Parameters:
newJ2EEConnectString- the new value for J2EEConnectString.- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
setIsolated
void setIsolated(boolean newIsolated)
Set the value for Isolated. (Whether this SAP system is considered isolated or not.)- Parameters:
newIsolated- the new value for Isolated.- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
setLoadBalancingEnabled
void setLoadBalancingEnabled(boolean newLoadBalancingEnabled)
Set the value for LoadBalancingEnabled. (Whether application server load balancing is enabled for this SAP system.)- Parameters:
newLoadBalancingEnabled- the new value for LoadBalancingEnabled.- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
setJobHandlingEnabled
void setJobHandlingEnabled(JobHandlingType newJobHandlingEnabled)
Set the value for JobHandlingEnabled. (Should the XBP job interception and synchronization for this SAP System be enabled?) This value is mandatory.- Parameters:
newJobHandlingEnabled- the new value for JobHandlingEnabled. If this isnull, then the object cannot be persisted.- Throws:
com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- This will be thrown if this method is called while the object is not attached to a session.
-
checkConnectString
String[] checkConnectString()
Check the connection strings for validity.- Returns:
- Return an array with check results for all configured interfaces (RFC and J2EE). An error is indicated by non-null array element. All elements of the array need to be checked.
-
init
void init()
Perform initialization tasks for the SAP System.
-
isSNCConnection
boolean isSNCConnection()
Check if the connection is using SNC.- Returns:
trueif the connection is using SNC,falseotherwise
-
getDefaultXBPClient
SAPXBP getDefaultXBPClient()
Get the default XBP client.- Returns:
- Default XBP client if there is one.
-
getDefaultOutputRetrievalProcessServer
ProcessServer getDefaultOutputRetrievalProcessServer()
Get the default output retrieval Process Server.- Returns:
- Default output retrieval Process Server.
-
getProcessServer
ProcessServer getProcessServer()
Get the ProcessServer.- Returns:
- ProcessServer
- Throws:
com.redwood.scheduler.api.exception.ObjectDeletedException- If this method is called when the object has been marked for deletion.com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- If this method is called when the object has been removed from it's session.
-
getQueue
Queue getQueue()
Get the Queue.- Returns:
- Queue
- Throws:
com.redwood.scheduler.api.exception.ObjectDeletedException- If this method is called when the object has been marked for deletion.com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- If this method is called when the object has been removed from it's session.
-
getDefaultJobTimeZone
TimeZone getDefaultJobTimeZone()
Get the DefaultJobTimeZone.- Returns:
- DefaultJobTimeZone
- Throws:
com.redwood.scheduler.api.exception.ObjectDeletedException- If this method is called when the object has been marked for deletion.com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- If this method is called when the object has been removed from it's session.
-
getSpoolListRetrievalProcessServer
ProcessServer getSpoolListRetrievalProcessServer()
Get the SpoolListRetrievalProcessServer.- Returns:
- SpoolListRetrievalProcessServer
- Throws:
com.redwood.scheduler.api.exception.ObjectDeletedException- If this method is called when the object has been marked for deletion.com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- If this method is called when the object has been removed from it's session.
-
getFailOverSpoolListRetrievalProcessServer
ProcessServer getFailOverSpoolListRetrievalProcessServer()
Get the FailOverSpoolListRetrievalProcessServer.- Returns:
- FailOverSpoolListRetrievalProcessServer
- Throws:
com.redwood.scheduler.api.exception.ObjectDeletedException- If this method is called when the object has been marked for deletion.com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- If this method is called when the object has been removed from it's session.
-
getCcmsJobDefinition
JobDefinition getCcmsJobDefinition()
Get the CcmsJobDefinition.- Returns:
- CcmsJobDefinition
- Throws:
com.redwood.scheduler.api.exception.ObjectDeletedException- If this method is called when the object has been marked for deletion.com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- If this method is called when the object has been removed from it's session.
-
setProcessServer
void setProcessServer(ProcessServer newProcessServer)
Set the value for ProcessServer. This value is mandatory.- Parameters:
newProcessServer- is the object to set ProcessServer to. Link the SAP system to its corresponding process server. If this isnull, then the object cannot be persisted.
-
setQueue
void setQueue(Queue newQueue)
Set the value for Queue. This value is mandatory.- Parameters:
newQueue- is the object to set Queue to. Link the SAP system to its corresponding default queue. If this isnull, then the object cannot be persisted.
-
setDefaultJobTimeZone
void setDefaultJobTimeZone(TimeZone newDefaultJobTimeZone)
Set the value for DefaultJobTimeZone. This value is mandatory.- Parameters:
newDefaultJobTimeZone- is the object to set DefaultJobTimeZone to. Which TimeZone will be ascribed to the Jobs DateTimeZone fields by default. If this isnull, then the object cannot be persisted.
-
setSpoolListRetrievalProcessServer
void setSpoolListRetrievalProcessServer(ProcessServer newSpoolListRetrievalProcessServer)
Set the value for SpoolListRetrievalProcessServer. This value is optional.- Parameters:
newSpoolListRetrievalProcessServer- is the object to set SpoolListRetrievalProcessServer to. Assign a different Process Server to perform SAP job output retrieval
-
setFailOverSpoolListRetrievalProcessServer
void setFailOverSpoolListRetrievalProcessServer(ProcessServer newFailOverSpoolListRetrievalProcessServer)
Set the value for FailOverSpoolListRetrievalProcessServer. This value is optional.- Parameters:
newFailOverSpoolListRetrievalProcessServer- is the object to set FailOverSpoolListRetrievalProcessServer to. Assign a failover Process Server to perform SAP job output retrieval
-
setCcmsJobDefinition
void setCcmsJobDefinition(JobDefinition newCcmsJobDefinition)
Set the value for CcmsJobDefinition. This value is optional.- Parameters:
newCcmsJobDefinition- is the object to set CcmsJobDefinition to. Assign a different Ccms Job definition to SAP System
-
getSAPAbapPrograms
RWIterable<SAPAbapProgram> getSAPAbapPrograms()
Get anRWIterableover an ordered collection ofSAPAbapPrograms. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. ABAP Programs imported from the SAP system.- Specified by:
getSAPAbapProgramsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPAbapProgramobjects .
-
createSAPAbapProgram
SAPAbapProgram createSAPAbapProgram()
Create a newSAPAbapProgramlinked to this object.- Returns:
- a new
SAPAbapProgram.
-
getSAPAbapProgramByName
SAPAbapProgram getSAPAbapProgramByName(String name)
Get the SAPAbapProgram by NameSAPSystem.- Parameters:
name-- Returns:
- the SAPAbapProgram, or
nullif it could not be found
-
getSAPApplicationServers
RWIterable<SAPApplicationServer> getSAPApplicationServers()
Get anRWIterableover an ordered collection ofSAPApplicationServers. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. The SAP Application Servers of this SAPSystem.- Specified by:
getSAPApplicationServersin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPApplicationServerobjects .
-
createSAPApplicationServer
SAPApplicationServer createSAPApplicationServer()
Create a newSAPApplicationServerlinked to this object.- Returns:
- a new
SAPApplicationServer.
-
getSAPApplicationServerByName
SAPApplicationServer getSAPApplicationServerByName(String name)
Get the SAPApplicationServer by NameSAPSystem.- Parameters:
name-- Returns:
- the SAPApplicationServer, or
nullif it could not be found
-
getSAPApplicationServerGroups
RWIterable<SAPApplicationServerGroup> getSAPApplicationServerGroups()
Get anRWIterableover an ordered collection ofSAPApplicationServerGroups. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. The SAP Application Server Groups of this SAP System.- Specified by:
getSAPApplicationServerGroupsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPApplicationServerGroupobjects .
-
createSAPApplicationServerGroup
SAPApplicationServerGroup createSAPApplicationServerGroup()
Create a newSAPApplicationServerGrouplinked to this object.- Returns:
- a new
SAPApplicationServerGroup.
-
getSAPApplicationServerGroupByName
SAPApplicationServerGroup getSAPApplicationServerGroupByName(String name)
Get the SAPApplicationServerGroup by NameSAPSystem.- Parameters:
name-- Returns:
- the SAPApplicationServerGroup, or
nullif it could not be found
-
getSAPArchiveObjects
RWIterable<SAPArchiveObject> getSAPArchiveObjects()
Get anRWIterableover an ordered collection ofSAPArchiveObjects. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Archive objects imported from the SAP system.- Specified by:
getSAPArchiveObjectsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPArchiveObjectobjects .
-
createSAPArchiveObject
SAPArchiveObject createSAPArchiveObject()
Create a newSAPArchiveObjectlinked to this object.- Returns:
- a new
SAPArchiveObject.
-
getSAPArchiveObjectByName
SAPArchiveObject getSAPArchiveObjectByName(String name)
Get the SAPArchiveObject by NameSAPSystem.- Parameters:
name-- Returns:
- the SAPArchiveObject, or
nullif it could not be found
-
getSAPBatchEvents
RWIterable<SAPBatchEvent> getSAPBatchEvents()
Get anRWIterableover an ordered collection ofSAPBatchEvents. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. SAP Batch Events- Specified by:
getSAPBatchEventsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPBatchEventobjects .
-
createSAPBatchEvent
SAPBatchEvent createSAPBatchEvent()
Create a newSAPBatchEventlinked to this object.- Returns:
- a new
SAPBatchEvent.
-
getSAPBatchEventByName
SAPBatchEvent getSAPBatchEventByName(String name)
Get the SAPBatchEvent by NameSAPBatchEvent.- Parameters:
name-- Returns:
- the SAPBatchEvent, or
nullif it could not be found
-
getSAPCalendars
RWIterable<SAPCalendar> getSAPCalendars()
Get anRWIterableover an ordered collection ofSAPCalendars. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. SAP Calendars- Specified by:
getSAPCalendarsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPCalendarobjects .
-
createSAPCalendar
SAPCalendar createSAPCalendar()
Create a newSAPCalendarlinked to this object.- Returns:
- a new
SAPCalendar.
-
getSAPCalendarByTypeIdentYear
SAPCalendar getSAPCalendarByTypeIdentYear(String type, String ident, Long year)
Get the SAPCalendar by TypeIdentYearSAPSystem.- Parameters:
type-ident-year-- Returns:
- the SAPCalendar, or
nullif it could not be found
-
getSAPExternalCommands
RWIterable<SAPExternalCommand> getSAPExternalCommands()
Get anRWIterableover an ordered collection ofSAPExternalCommands. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. External Commands imported from the SAP system.- Specified by:
getSAPExternalCommandsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPExternalCommandobjects .
-
createSAPExternalCommand
SAPExternalCommand createSAPExternalCommand()
Create a newSAPExternalCommandlinked to this object.- Returns:
- a new
SAPExternalCommand.
-
getSAPExternalCommandByNameOsType
SAPExternalCommand getSAPExternalCommandByNameOsType(String name, String osType)
Get the SAPExternalCommand by NameSAPSystem.- Parameters:
name-osType-- Returns:
- the SAPExternalCommand, or
nullif it could not be found
-
getSAPInfoPackages
RWIterable<SAPInfoPackage> getSAPInfoPackages()
Get anRWIterableover an ordered collection ofSAPInfoPackages. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. InfoPackages imported from the SAP system.- Specified by:
getSAPInfoPackagesin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPInfoPackageobjects .
-
createSAPInfoPackage
SAPInfoPackage createSAPInfoPackage()
Create a newSAPInfoPackagelinked to this object.- Returns:
- a new
SAPInfoPackage.
-
getSAPInfoPackageByName
SAPInfoPackage getSAPInfoPackageByName(String name)
Get the SAPInfoPackage by NameSAPSystem.- Parameters:
name-- Returns:
- the SAPInfoPackage, or
nullif it could not be found
-
getSAPInfoPackageGroups
RWIterable<SAPInfoPackageGroup> getSAPInfoPackageGroups()
Get anRWIterableover an ordered collection ofSAPInfoPackageGroups. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. InfoPackageGroups imported from the SAP system.- Specified by:
getSAPInfoPackageGroupsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPInfoPackageGroupobjects .
-
createSAPInfoPackageGroup
SAPInfoPackageGroup createSAPInfoPackageGroup()
Create a newSAPInfoPackageGrouplinked to this object.- Returns:
- a new
SAPInfoPackageGroup.
-
getSAPInfoPackageGroupByName
SAPInfoPackageGroup getSAPInfoPackageGroupByName(String name)
Get the SAPInfoPackageGroup by NameSAPSystem.- Parameters:
name-- Returns:
- the SAPInfoPackageGroup, or
nullif it could not be found
-
getSAPJ2EEClients
RWIterable<SAPJ2EEClient> getSAPJ2EEClients()
Get anRWIterableover an ordered collection ofSAPJ2EEClients. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Collection of J2EE client settings for a SAP system.- Specified by:
getSAPJ2EEClientsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPJ2EEClientobjects .
-
createSAPJ2EEClient
SAPJ2EEClient createSAPJ2EEClient()
Create a newSAPJ2EEClientlinked to this object.- Returns:
- a new
SAPJ2EEClient.
-
getSAPPIChannels
RWIterable<SAPPIChannel> getSAPPIChannels()
Get anRWIterableover an ordered collection ofSAPPIChannels. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Collection of SAP PI channels for a SAP system.- Specified by:
getSAPPIChannelsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPPIChannelobjects .
-
createSAPPIChannel
SAPPIChannel createSAPPIChannel()
Create a newSAPPIChannellinked to this object.- Returns:
- a new
SAPPIChannel.
-
getSAPPIChannelByChannelId
SAPPIChannel getSAPPIChannelByChannelId(String channelId)
Get the SAPPIChannel by ChannelIdSAPSystem.- Parameters:
channelId-- Returns:
- the SAPPIChannel, or
nullif it could not be found
-
getSAPLogErrors
RWIterable<SAPLogError> getSAPLogErrors()
Get anRWIterableover an ordered collection ofSAPLogErrors. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. T100 messages- Specified by:
getSAPLogErrorsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPLogErrorobjects .
-
createSAPLogError
SAPLogError createSAPLogError()
Create a newSAPLogErrorlinked to this object.- Returns:
- a new
SAPLogError.
-
getSAPMassActivities
RWIterable<SAPMassActivity> getSAPMassActivities()
Get anRWIterableover an ordered collection ofSAPMassActivities. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Mass activities imported from the SAP system.- Specified by:
getSAPMassActivitiesin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPMassActivityobjects .
-
createSAPMassActivity
SAPMassActivity createSAPMassActivity()
Create a newSAPMassActivitylinked to this object.- Returns:
- a new
SAPMassActivity.
-
getSAPMassActivityByName
SAPMassActivity getSAPMassActivityByName(String name)
Get the SAPMassActivity by NameSAPSystem.- Parameters:
name-- Returns:
- the SAPMassActivity, or
nullif it could not be found
-
getSAPOutputDevices
RWIterable<SAPOutputDevice> getSAPOutputDevices()
Get anRWIterableover an ordered collection ofSAPOutputDevices. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Output devices imported from the SAP system.- Specified by:
getSAPOutputDevicesin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPOutputDeviceobjects .
-
createSAPOutputDevice
SAPOutputDevice createSAPOutputDevice()
Create a newSAPOutputDevicelinked to this object.- Returns:
- a new
SAPOutputDevice.
-
getSAPOutputDeviceByName
SAPOutputDevice getSAPOutputDeviceByName(String name)
Get the SAPOutputDevice by NameSAPSystem.- Parameters:
name-- Returns:
- the SAPOutputDevice, or
nullif it could not be found
-
getSAPProcessChains
RWIterable<SAPProcessChain> getSAPProcessChains()
Get anRWIterableover an ordered collection ofSAPProcessChains. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. ProcessChain imported from the SAP system.- Specified by:
getSAPProcessChainsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPProcessChainobjects .
-
createSAPProcessChain
SAPProcessChain createSAPProcessChain()
Create a newSAPProcessChainlinked to this object.- Returns:
- a new
SAPProcessChain.
-
getSAPProcessChainByName
SAPProcessChain getSAPProcessChainByName(String name)
Get the SAPProcessChain by NameSAPSystem.- Parameters:
name-- Returns:
- the SAPProcessChain, or
nullif it could not be found
-
getSAPRecipients
RWIterable<SAPRecipient> getSAPRecipients()
Get anRWIterableover an ordered collection ofSAPRecipients. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. SAP Recipients- Specified by:
getSAPRecipientsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPRecipientobjects .
-
createSAPRecipient
SAPRecipient createSAPRecipient()
Create a newSAPRecipientlinked to this object.- Returns:
- a new
SAPRecipient.
-
getSAPRecipientByNameTypeClientNumber
SAPRecipient getSAPRecipientByNameTypeClientNumber(String name, SAPRecipientType type, String clientNumber)
Get the SAPRecipient by NameSAPSystem.- Parameters:
name-type-clientNumber-- Returns:
- the SAPRecipient, or
nullif it could not be found
-
getSAPRecipientBySearchNameTypeClientNumber
SAPRecipient getSAPRecipientBySearchNameTypeClientNumber(String searchName, SAPRecipientType type, String clientNumber)
Get the SAPRecipient by SearchNameSAPSystem.- Parameters:
searchName-type-clientNumber-- Returns:
- the SAPRecipient, or
nullif it could not be found
-
getSAPXAL
SAPXAL getSAPXAL()
Get the SAPXAL. XAL settings for a SAP system.- Returns:
- nullSAPXAL
- Throws:
com.redwood.scheduler.api.exception.ObjectDeletedException- If this method is called when the object has been marked for deletion.com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- If this method is called when the object has been removed from it's session.
-
createSAPXAL
SAPXAL createSAPXAL()
Create a newSAPXALlinked to this object.- Returns:
- a new
SAPXAL.
-
getSAPXBPs
RWIterable<SAPXBP> getSAPXBPs()
Get anRWIterableover an ordered collection ofSAPXBPs. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Collection of XBP settings for a SAP system.- Specified by:
getSAPXBPsin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPXBPobjects .
-
createSAPXBP
SAPXBP createSAPXBP()
Create a newSAPXBPlinked to this object.- Returns:
- a new
SAPXBP.
-
getSAPXBPEventRules
RWIterable<SAPXBPEventRule> getSAPXBPEventRules()
Get anRWIterableover an ordered collection ofSAPXBPEventRules. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Collection of XBP settings for a SAP system.- Specified by:
getSAPXBPEventRulesin interfaceSAPSystemComp- Returns:
- An
RWIterableover an ordered collection ofSAPXBPEventRuleobjects .
-
createSAPXBPEventRule
SAPXBPEventRule createSAPXBPEventRule()
Create a newSAPXBPEventRulelinked to this object.- Returns:
- a new
SAPXBPEventRule.
-
getSAPXBPJobControlRules
RWIterable<SAPXBPJobControlRule> getSAPXBPJobControlRules()
Get anRWIterableover a collection ofSAPXBPJobControlRules, the collection will be ordered by ProcessingOrder. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Collection of XBP settings for a SAP system.- Specified by:
getSAPXBPJobControlRulesin interfaceSAPSystemComp- Returns:
- An
RWIterableover a collection ofSAPXBPJobControlRuleobjects , the collection will be ordered by ProcessingOrder.
-
createSAPXBPJobControlRule
SAPXBPJobControlRule createSAPXBPJobControlRule()
Create a newSAPXBPJobControlRulelinked to this object.- Returns:
- a new
SAPXBPJobControlRule.
-
getSAPXMW
SAPXMW getSAPXMW()
Get the SAPXMW. XMW settings for a SAP system.- Returns:
- nullSAPXMW
- Throws:
com.redwood.scheduler.api.exception.ObjectDeletedException- If this method is called when the object has been marked for deletion.com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException- If this method is called when the object has been removed from it's session.
-
createSAPXMW
SAPXMW createSAPXMW()
Create a newSAPXMWlinked to this object.- Returns:
- a new
SAPXMW.
-
getSAPLanguages
RWIterable<SAPLanguage> getSAPLanguages()
Get anRWIterableover a collection ofSAPLanguages, the collection will be ordered by Name. If the collection is empty, an empty iterator will be returned, that is, this method will never returnnull. Languages the SAP system.- Specified by:
getSAPLanguagesin interfaceSAPSystemComp- Returns:
- An
RWIterableover a collection ofSAPLanguageobjects , the collection will be ordered by Name.
-
createSAPLanguage
SAPLanguage createSAPLanguage()
Create a newSAPLanguagelinked to this object.- Returns:
- a new
SAPLanguage.
-
getSAPLanguageBySAPLanguage
SAPLanguage getSAPLanguageBySAPLanguage(String sAPLanguage)
Get the SAPLanguage by SAPLanguageSAPSystem.- Parameters:
sAPLanguage-- Returns:
- the SAPLanguage, or
nullif it could not be found
-
checkCreatePrivilege
RequiredPermission checkCreatePrivilege()
Check whether or not the create action can be performed on this object.- Returns:
- a
RequiredPermissioninstance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
-
checkViewPrivilege
RequiredPermission checkViewPrivilege()
Check whether or not the view action can be performed on this object.- Returns:
- a
RequiredPermissioninstance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
-
checkEditPrivilege
RequiredPermission checkEditPrivilege()
Check whether or not the edit action can be performed on this object.- Returns:
- a
RequiredPermissioninstance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
-
checkBusinessAutomationAPIPrivilege
RequiredPermission checkBusinessAutomationAPIPrivilege()
Check whether or not the businessAutomationAPI action can be performed on this object.- Returns:
- a
RequiredPermissioninstance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
-
checkDeletePrivilege
RequiredPermission checkDeletePrivilege()
Check whether or not the delete action can be performed on this object.- Returns:
- a
RequiredPermissioninstance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.
-
-