Package com.redwood.scheduler.api.model

Scheduler API - Model

Related Documentation

Since 8.0 (M28.0)

Interface Summary

Interface	Description
AbstractSource	The abstract source for scripts.
AdHocAlertSource	An alert source for ad-hoc alerts
Alert	An alert.
AlertEscalation	Alert escalation channel
AlertEscalationAction	Action to execute when an AlertEscalation Alert is executed.
AlertGateway	An alert gateway
AlertSource	An alert source
AlertSourceAction	Action to execute when an AlertSource Alert is created.
AlertSourceEmail	Body of an alert source email.
APIErrorResultSetCallback
APIResultSetCallback	This interface is used to access the ResultSet of data model queries and is implemented in a number of classes listed above.
APIResultSetPostExecuteCallback
AppImportContext	Data available at pre and post
Application	A nested grouping of objects forming an application.
ApplicationObject	ApplicationObjects are all those objects which can belong to an Application.
AppPostImportContext	Data available at Post import only
AppPreImportContext	Data available at Pre import only
AppUpgradeInfo
AppUpgrader.UpgradeStep
Association	An association describes the relationship between two types of object.
AuditObject	The audit record object for logging changes and performing restoration of changed objects.
AuditRule	The rule for how objects should be audited.
AuditSubjectLogin
Branchable
BranchedUniqueNamedApplicationObject	Objects which can be branched, must have a unique name, and can belong to an Application.
BuiltInWebService	An object used to visualize built in web services.
BusinessKeyObject	Interface that objects with business keys must implement.
BusinessKeyResolver	Interface for resolving all concrete BusinessKeyObject objects based on their business key.
ChangeOwner	Objects that implement this interface have an owner associated with them.
CommonImportRule	Common base-class for import rules.
CommonLog
CommonLogLine
ConcreteObjectCallback	Generated interface with a call-back for every externally visible concrete type.
ConstraintDefinition	The definition of a Constraint.
Credential	A Credential for a given protocol, endpoint and user to enable access to an external system.
CredentialProtocol	A protocol used to access an external system.
CustomEntity
Dashboard	Defines the layout for a dashboard page A dashboard defines the layout and content for a dashboard page.
DashboardItem	An item that is visible on the DashBoard A DashboardWidget is an item that is visible on the Dashboard.
Database	Stores the configuration for a Database object, these are used to provide settings for the Redwood JDBC pool.
DatumDefinition	MetaMetaData describes the metadata that is associated with another object.
Detail	A detail is used to model multiple sub-objects that are part of a single super-object.
Document	An object for storing arbitrary documentation (as a byte stream).
DurationEstimate	Interface for information about an estimated duration.
EmailAlertGateway	An email alert gateway
EmailAlertGatewayAction	Action to execute when an EmailAlertGateway Alert is executed.
EmailAlertGatewayEmail	Body of an email alert gateway email.
EmailAlertGatewayHeader	An email alert gateway header.
EmailAlertGatewayJobFileAttachment	An email alert gateway attachment.
EntityDefinitionConstraint	The (abstract) superclass for constraints on certain definitions.
EntityDefinitionConstraintParameterMapping	The (abstract) superclass for the parameters of an EntityDefinitionConstraint.
EnumResolver	Interface for resolving all Enumerations BaseSchedulerEnumeration based on their name.
Event	An event is a particular instance of an EventDefinition.
EventDefinition	Events are signals for jobs to start execution.
EventSource	Abstract class that links to which EventSourceDefinition caused the parent Event.
EventSourceDefinition	Abstract class for definitions of event sources.
ExecutableSchedulerEntity	Interface which executable scheduler entities must implement.
Export	An export of a set of objects.
Exporter	Interface for exporting objects to a (job) file.
ExportRule	A rule that defines a set of objects to include in an object.
ExportRuleItem	The export item which is manually selected by the users and is part of a fixed list of exported objects.
ExportRuleSet	Set of rules that define what should be included in an export.
ExtensionPoint	An extension point is used to provide a custom entry point to generate results.
ExtensionPointSource	The source code for an Extension Point
FileEvent	Information about the file that triggered the parent Event.
FileEventDefinition	Definition for a file event.
FinalStatusHandler	Describes what to do when a Job reaches a final state
ForecastJob	Data for the forecast of a job.
Format	Type of output that is generated by the job.
GlobalPrivilege	Global security privileges.
HasOwner	Objects that implement this interface have an owner associated with them.
Import	An import of a set of objects.
ImportAction	Action to execute when an Import is ready to persist.
ImportActionParameter	Parameters defined for an import action Parameters enable you to parameterize the action to execute for an import rule set.
ImportMatchRule	A criteria for choosing objects that an ImportRule applies to.
ImportOverrideRule	A transformation to apply to an object.
ImportRule	Transformation to apply to objects after import.
ImportRuleDefinition	Implementation for an import match or override.
ImportRuleSet	A set of rules that can be applied during an import.
ImportRuleSetPartitionRename	Rename definition of partitions for Import Rule Set
ImportSource	Source from which objects to import can be retrieved.
IsolationGroup	Isolation groups are used to isolate the view a subject has of the system.
JARFile	The JAR file
Job	A job represents an instantiated job definition or job chain.
JobChain	Chain definition.
JobChainCall	Defines a job submit in a particular job chain step A reference to a job definition.
JobChainCallInExpressionParameter	Maps the value of an expression to an IN parameter for the JobDefinition.
JobChainCallInParameter	A definition of how to fill an IN parameter for the JobDefinition pointed to by the JobChainCall.
JobChainCallInReferenceParameter	Maps an output value from a job in a previous step, or an input value from the job chain to an IN parameter for the JobDefinition.
JobChainCallJobLock	The association between JobChainCall and JobLock.
JobChainCallOutParameter	A definition of how to map an OUT parameter for the JobDefinition pointed to by the JobChainCall to an OUT parameter for the JobChain.
JobChainCallOutReferenceParameter	Maps an output value from the JobDefinition to an output value for the chain.
JobChainCallParameter	A definition of what to do for a parameter for the JobDefinition pointed to by the JobChainCall.
JobChainCallPrecondition	A job chain call precondition.
JobChainCallProcessMonitorUpdater	The association between JobChainCall and ProcessMonitorDefinitions
JobChainCallRaiseEvent	The Event to be raised when the Call reaches a certain state.
JobChainCallSchedulingParameter	Scheduling parameter; used to store a value that should be set on a job before it is submitted.
JobChainCallWaitEvent	The Event that a job chain call will wait for before starting.
JobChainStatusHandler	Job chain status handlers are used to react to the status of the job chain.
JobChainStep	Job chain step definitions hold a number of job chain calls to be executed in parallel.
JobChainStepPrecondition	A pre-condition on step level checks whether the step should be executed or skipped See the Precondition class for more information.
JobChainStepStatusHandler	Status handler on step level within a job chain reacts on the status of a job in the job chain step.
JobDatum	The Metadata associated with a Job.
JobDefinition	A job definition defines what a job does.
JobDefinitionAction	Action to execute for jobs based on this job definition.
JobDefinitionAlertSource	An alert raised by a job definition
JobDefinitionAlertSourceParameterMatch	An email alert gateway attachment.
JobDefinitionAlertSourceRule	Alert escalation rules
JobDefinitionAlertSourceStatus	The specific job status to match.
JobDefinitionConstraint	A constraint on a job definition.
JobDefinitionConstraintParameterMapping	The parameters of a JobDefinitionConstraint.
JobDefinitionForm	A form defined for a job definition Forms enable you to define custom windows to submit job definitions or edit jobs.
JobDefinitionJobLock	A job definition can require job locks.
JobDefinitionParameter	Parameters defined for a job definition Parameters enable you to define generic job definitions that behave differently according to the values of the parameters.
JobDefinitionParameterSubType	The sub type of the job definition parameter.
JobDefinitionProcessMonitorUpdater	The association between JobDefinitions and ProcessMonitorDefinitions
JobDefinitionRaiseEvent	The Event to be raised when the Job reaches a certain state.
JobDefinitionRelatedObject	All objects which are directly related to a JobDefinition must inherit from this class.
JobDefinitionRuntimeLimit	Runtime limits defined for a job definition Runtime limits enable you to define generic job definitions that have different min and max runtimes according to the values in the RuntimeLimits.
JobDefinitionType	The type of a job definition.
JobDefinitionTypeAction	Action to execute for jobs using this JobDefinitionType.
JobDefinitionWaitEvent	The events that a job definition will wait for before starting.
JobDefinitionWithSource	This is used for JobDefinitionTypes that have source.
JobEstimates
JobFile	Output file of a job.
JobFileSearch	Search the output file of a job for a given text string Provides job file search functionality equivalent to the jcs.searchfile procedure.
JobGroup	Common data for a set of similar jobs.
JobGroupParameter	Parameter for a job group.
JobJobLock	Job locks required by or held by a job.
JobLock	Locks define which jobs can and cannot run together To prevent jobs running concurrently - for example, when two or more jobs need access to the same system resource, such as a tape unit, you can define job locks.
JobNote	Ad-hoc job notes written by end-users attached to this job
JobParameter	Parameter for a job.
JobRaiseEvent	Events that will be raised when the job reaches a certain state.
JobRuntimeLimit	Runtime limits defined for a job Runtime limits enable you to define min and max runtimes according to the values in the RuntimeLimits.
JobWaitEvent	Events that need to be raised before the job runs At the moment job would go to the QUEUED status the job definition EventExpression is calculated.
Language	Languages known to the system.
LDAPProfile	A set of LDAP configuration properties for managing user authentication and authorisation.
Library	A library dependency for a script.
LibrarySource	The source code for a Library
LicenseKey	License Keys
LinkableMonitor	Superclass for monitors that can be linked to.
LoadFactor	A factor for calculating the load.
MailConnectionSetting	Connection settings.
MailConnector	E-Mail connection settings.
MetaData	This class is the base class for all classes that are meta data for the model
ModuleState	This class is used by modules to record the state of their data in the model
Monitor	Alert monitors show a hierarchical user-defined view of the status of the system The alert system shows a hierarchical view of the wellness of the system.
MonitorAlertSource	An alert raised by a Monitor Node
MonitorAlertSourceRule	Alert escalation rules
MonitorCheck	Shows which monitor conditions use which monitor values If the monitor check refers to a local object, it must define a business key.
MonitorCondition	A monitor condition defines when an alert is raised.
MonitorEvent	Event to be raised when a monitor reaches a particular severity When an alert is raised for a monitor node that has an associated event and the severity is appropriate, the event is raised.
MonitorLink	Monitor that links to a linkedmonitor A monitorlink is used to reuse a part of the monitor tree in several locations by linking to them.
MonitorNode	Monitor that can contain sub-nodes
MonitorValue	A monitor value is a numeric, string or timestamp value The monitor value is either derived from the scheduler data model or set by an external system.
NamedDetailObject	An object which has a Name, comment and description.
NamedRootObject	An object which has a Name, comment and description.
NavigationBar	Defines a custom navigation bar A navigation bar defines the layout and content for a custom navigation bar.
NavigationBarItem	An item that is part of the navigation bar A NavigationBarItem is shown in the navigation bar.
ObjectDefinition	Provides a reference for every object in the database.
ObjectFieldDefinition	Provides a reference for every attribute of every object in the database.
ObjectGetter
ObjectIndex	Contains custom defined indexes
ObjectIndexColumn	Contains the columns for custom defined indexes
ObjectReference	Object Reference A link from the source object to the linked object.
ObjectSearch	Object Search definition.
ObjectSearchCondition	The parameters for a Object Search condition.
ObjectTag	The ObjectTag associated with an PartitionableObject.
ObjectTagDefinition	An ObjectTagDefinition has a name and can be used as meta data for PartitionableObjects.
OperatorMessage	A message created by the application or the system to inform the operator A message can be informational or it can require an answer.
OperatorMessageDatum	An object which has a Name, comment and description.
OraAppsJobControlRule	Oracle Applications job synchronization settings.
OraAppsSystem	Settings relating to a Oracle Applications System.
OracleConnection	Show all Oracle connections that are present.
OraOhiSystem	Settings relating to a Oracle Health Insurance System.
Partition	Partitions separate their contained objects according to security and visibility characteristics.
PartitionableObject	All partitionable objects Base class for objects that have a partition.
PartitionableRootObject	All unnamed partitionable objects Base class for objects that have a partition but not a name.
PeopleSoftJobControlRule	PeopleSoft job synchronization settings.
PeopleSoftJobOutputLocation	PeopleSoft job output file location settings.
PeopleSoftSystem	Settings relating to a Oracle PeopleSoft System.
PeriodFunction	A period function is used to define which days in the month a time window interval is open.
PermaLinkConstants
Precondition	A precondition checks whether the step should be executed or skipped The execution of steps and script calls may be dependent upon specific circumstances, such as specific days of the week or the outcome of another job.
ProcessMonitor	The Process Monitor for high-level process automation.
ProcessMonitorDefinition	The definition for a Process Monitor for high-level process automation.
ProcessMonitorItem	An item in the Process Monitor.
ProcessMonitorItemDefinition	The definition for an item in the Process Monitor.
ProcessMonitorLog	The log of the ProcessMonitor changes.
ProcessMonitorUpdater	The association between a SchedulerEntity and a ProcessMonitorDefinitions
ProcessMonitorUpdaterBase
ProcessServer	A process server contains services that run jobs.
ProcessServerAlertSource	An alert raised by a process server
ProcessServerAlertSourceStatus	The specific process server status to match.
ProcessServerCheck	A check on the status of a particular part of the server that the ProcessServer runs on.
ProcessServerCheckLog	A message recording the success state of a process server check The message should be created only at edge conditions ie when going from success to failure or failure to success.
ProcessServerCheckLogParameter	A parameter configuring a process server check log.
ProcessServerJobDefinitionType	The types of job definition that a process server supports If a process server is being said to support a particular type of job definition, it should be running on a system with the appropriate language interpreter or compiler.
ProcessServerLoadFactor	A factor for calculating the load of a process server.
ProcessServerParameter	Configuration parameters for the ProcessServer During the configure phase of the system, these parameters get set to the appropriate values for the ProcessServer.
ProcessServerResource	The resources that a process server provides
ProcessServerService	An instance of a Service on a ProcessServer.
ProcessServerStatusLog	Records the ProcessServerStatus of a process server at a point in time Should be created only when the process server status changes.
PublishApproval	Approvals related to Publish jobs
PublishedWebService	An object used to flag which JobDefinitions are published as web services.
PublishItem	An item to be published to the reporting server
QueryCondition	Condition that can be used to to filter objects.
QueryConditionValue	Values provided by the user for the given QueryFilter / QueryCondition combination.
QueryFilter	The queryFilter is used to create a filter for the ObjectType it refers to.
Queue	Queue to which jobs are assigned A queue is a logical grouping of jobs.
QueueAlertSource	An alert raised by a queue
QueueAlertSourceStatus	The specific queue status to match.
QueueProvider	Process Servers that serve a queue.
R2WCatalog	The details of the remote R2W catalog.
R2WCatalogAlias	The aliases for a R2W catalog.
RaiseEvent	This holds all of the fields common to JobRaiseEvent, JobDefinitionRaiseEvent and JobChainCallRaiseEvent.
Readable	Marker interface that indicates an object that can be read using the ModelEvent API.
RegistryEntry	Registry entry storing product-specific configuration settings.
RELEntryPoint	A published point of entry to a library that can be used by REL.
RemoteSystem	Remote System describes another scheduler instance that this system cann connect to or receive connections from.
Report	The definition of a Report
ReportColumn	A column for the definition of the Report
ReportSelection	The selection criteria for the results of a Report
ReportSort	The sort order definition for a Report
Resource	Resource needed by scripts and provided by process servers Static resources are used for the assignment of jobs to process servers.
RestrictedSchedulerSessionSpecification	The specifications for a restricted scheduler session
Root	An internal abstraction for a standalone object.
RuntimeParameter	A runtime parameter
SAPAbapProgram	ABAP Program details.
SAPAbapProgramParameter	ABAP program parameter.
SAPAbapVariant	ABAP variant details.
SAPAbapVariantParameter	This class has been deprecated, and should not be used.
SAPAbapVariantParameterValue	ABAP variant parameter.
SAPAbapVariantSelopt	ABAP variant select option.
SAPAbapVariantSeloptValue	ABAP variant select option value.
SAPApplicationServer	Settings relating to a SAP Application Server.
SAPApplicationServerGroup	SAP Application Server Group.
SAPApplicationServerLoadFactor	A factor for calculating the load of a SAP Application server.
SAPApplicationServerProvider	SAP application servers of a group.
SAPArchiveDocumentType	Archive document type.
SAPArchiveObject	Archive object.
SAPBAEConfiguration	SAP Business Application Enabler configuration.
SAPBAEConnector	SAP Business Application Enabler connection settings.
SAPBatchEvent	SAP batch event.
SAPCalendar	SAP calendars.
SAPCommonSettings	Common settings for various SAP interfaces.
SAPExternalCommand	External Command details.
SAPInfoPackage	InfoPackage details.
SAPInfoPackageGroup	InfoPackageGroup.
SAPInfoPackageGroupStep	Step of an InfoPackageGroup.
SAPJ2EEClient	J2EE connection settings.
SAPLanguage	SAP language.
SAPLogError	Log errors.
SAPMassActivity	Mass Activity
SAPMassActivityFieldParameter	Mass Activity field parameter
SAPMassActivityFieldTable	Mass Activity field table
SAPMassActivityFieldTableRow	Mass Activity field table row.
SAPMassActivityFieldTableRowValue	Mass Activity field table row value.
SAPMassActivityLayoutField	Mass Activity field
SAPMassActivityObject	Mass Activity object
SAPMassActivityParameter	Mass Activity parameter
SAPMassActivityParameterSet	Mass Activity parameter set
SAPMassActivityStructure	Mass Activity structure.
SAPNWCallbackParameterMapping	SAP NW callback parameter mapping.
SAPNWCallbackVariant	SAP NW callback variant.
SAPNWCallbackVariantDetail	SAP NW callback variant detail.
SAPOutputDevice	Output Device.
SAPOutputFormat	Output format.
SAPPIChannel	SAP XI/PI channel.
SAPProcessChain	Process Chain details.
SAPProcessDefinition	Process definition.
SAPProcessRestart	BW Process restart.
SAPRecipient	SAP spool list recipient.
SAPScript	SAP Script
SAPScriptAttribute	These are the attributes that are needed by an SAP script.
SAPSystem	Settings relating to a SAP System.
SAPUsernamePassword	SAP username and password.
SAPXAL	XAL connection settings.
SAPXBP	XBP connection settings.
SAPXBPEventRule	XBP event synchronization settings.
SAPXBPJobControlRule	XBP job synchronization settings.
SAPXMW	XMW connection settings.
SchedulerEntity	Base class that all other objects are derived from.
SchedulerEntityAction	An action that can be run at certain points of the job lifecycle.
SchedulerSession	Central interface for retrieving and creating all of the Scheduler objects.
SchedulerStatus
Script	This covers all of the JobDefinitionTypes that run "natively" on a system.
SecurityPrivilege
SecurityRank
Service	A Service is responsible processing JobDefinitions of a specific JobDefinitionType.
SoftwareGroup	Files are grouped, making this a placeholder object.
SoftwareItem	Represents a file.
Statistics	Statistics object for process-related entities.
StatisticsSample	Deprecated Class, do not use.
StatusHandler	A status handler defines the behavior of the job chain after each step is completed.
Subject	The list of subjects of security decisions.
SubjectGlobalPrivilegeGrant	A mapping of which global privileges a subject has been granted.
SubjectGrant	Common base-class for the privileges and roles that are assigned to a subject.
SubjectIsolationGroup	A mapping of which subjects belong to which isolation groups.
SubjectObjectPrivilegeGrant	A mapping of which privileges on an object have been granted to which subject.
SubjectObjectTypePrivilegeGrant	A mapping of which privileges a subject has been granted to all objects of a given type.
SubjectPrivilegeGrant	Common interface for grants of privileges.
SubjectRoleGrant	A mapping of which User Subject has granted which Role Subject to which Subject.
SubmitFrame	A submit frame controls how often a job is resubmitted.
SubmitFrameElement	An element of a submit frame.
Table	A user defined table.
TableDefinition	A table definition for a user or system defined table.
TableDefinitionColumn	A column definition for a user- or system-defined table.
TableDefinitionConstraint	A constraint on a table definition.
TableDefinitionConstraintParameterMapping	The parameters of a TableDefinitionConstraint.
TableValue	A value in a user defined table.
TimeEstimate	Interface for information about an estimated point in time.
TimeWindow	Represents a period in time [start-moment, end-moment) defined as a union of TimeWindowIntervals.
TimeWindowElement	Represents a period in time [start-moment, end-moment).
TimeZone	A Time Zone.
Translation	Translations for user-visible terms.
TranslationKey	Key for translation lookups.
Trigger	A library dependency for a script.
TriggerSource	The source code for a Library
UniqueNamedApplicationObject	Objects which must have a unique name and can belong to an Application.
UserMessage	The UserMessage object for information pertaining to the User Message in the Process Monitor.
UserMessageAttachment	The links to file for this message
UserMessageDefinition	A user message job definition for cooperation
UserMessageDefinitionAttachment	The files to attach to a UserMessageDefinition
UserMessageDefinitionParticipant	The user/roles allowed to respond to a user message.
UserMessageDefinitionResponse	The reply actions for a user message.
UserMessageHistory	The history of the forward and delegation of a user message.
UserMessageParticipant	The user/roles allowed to response to a user message.
Visualization	Abstract base class for visualizations using applets A Visualization defines user settings and content for an applet visualization.
VisualizationAlert	The visualization of alert sources, escalations and addresses
VisualizationAlertSource	An alert source in an alert visualization
VisualizationProcessServerQueue	The visualization of process servers and queues
VisualizationPSQProcessServer	A process server in a process server and queue visualization
VisualizationPSQQueue	A queue in a process server and queue visualization
VisualizationPSQText	A text box in a process server and queue visualization
WaitEvent	This holds all of the fields common to JobWaitEvent, JobDefinitionWaitEvent and JobChainCallWaitEvent.
WrappedJob	Abstract base-class for objects that wrap a job internally.

Class Summary

Class	Description
AbstractConcreteObjectCallback	Generated base implementation of the ConcreteObjectCallback implementation.
AppUpgrader
BigDecimalFormat	Formatting and parsing for BigDecimals with a flexible syntax specified entirely by the format string.
BranchedUniqueNamedApplicationObjectMasterIterator	Small helper class for filtering an iterator over branchable objects so that only the master objects are returned.
BusinessKey
BusinessKeyLookup	Interface for resolving all concrete BusinessKeyObject objects based on their business key.
BusinessKeySupport
ChildApplicationObjectIterator	Small helper class for retrieving all ApplicationObject instances that belong to a particular application.
CollectionCallback<T>	Add all objects to the specified collection.
FileFormatFinder	Centralized Format identifier utility class.
GetCountCallBack	Use for select count(*) from X queries, it stores the result of the count as int, which can be retrieved by calling getCount() after.
LastModificationTrackableObjectDefinitionSet	Offers a Set of all ObjectDefinitions whose objects support LastModificationTrackable
LimitedUniqueIdListAPIResultSetCallback
LongCallBack	APIResultSetCallback implementation for retrieving the Long value present in the first column of the result set.
LongListCallback	APIResultSetCallback implementation for retrieving the long value present in the first column of the result set.
ObjectRetriever	Generated class for retrieving/dispatching objects of a specific type.
PartitionObjectIterator	Small helper class for retrieving all PartitionObject instances that belong to a particular Partition.
ReportScript	Easy interface to reports from scripting.
RestartStepOptions	When a step is requested to be restarted in a JobChain, there are options that need to be set to proceed with the restart.
RestartStepOptions.Builder	The RestartStepOptions can just be instantiated using an instance of the class Builder.
SAPSystemNoJCO	This is just a dummy class required for the help generation.
StringCallback	Use this callback if you have a query which selects 1 String column and the query returns 1 row (result).
TableFinder
TextEscape	Methods for escaping text.
UniqueIdListAPIResultSetCallback
Variable
VariableHeader

Exception Summary

Exception	Description
TextEscape.UnsupportedEncodingRuntimeException