Package com.redwood.scheduler.api.model

Interface Service

All Superinterfaces:

ApplicationObject, BusinessKeyObject, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, Root, SchedulerEntity, SchedulerEntityComp, ServiceComp, UniqueNamedApplicationObject

public interface Service
extends ServiceComp, UniqueNamedApplicationObject

A Service is responsible processing JobDefinitions of a specific JobDefinitionType. A Service is responsible for doing one thing, e.g., running a SAP job via XBP, monitoring a SAP system via XBP, controlling Job chains, etc.

Field Summary

Fields

Modifier and Type	Field	Description
static String	AS400	The name of the service that deals with all of the AS400 types.
static String	HTTP	The name of the service that deals with all of the HTTP types.
static String	JDBC	The name of the service that deals with all of the JDBC types.
static String	JOBCHAIN	The name of the service that deals with job chains.
static String	JXBP	The name of the service that deals with all of the JXBP types.
static String	MAIL	The name of the service that deals with all of the Mail types.
static String	OBJECT_SEARCH	The name of the service that deals with the ObjectSearch jobs.
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "Service" objects.
static String	ORAAPPS	The name of the service that deals with Oracle Applications.
static String	ORACLE_JOB	The name of the service that deals with all of the Oracle job types.
static String	ORAOHI	The name of the service that deals with Oracle Helth Insurance.
static String	PEOPLESOFT	The name of the service that deals with PeopleSoft.
static String	PLATFORM_AGENT_SCRIPT	The name of the service that deals with all of the Platform Agent Script types.
static String	PUBLISH	The name of the service that deals with the publishing jobs.
static String	REPORT	The name of the service that deals with reports.
static String	RW_SCRIPT	The name of the service that deals with Redwood Script.
static String	SAPBOBJ	The name of the service that deals with SAP Business Objects.
static String	SAPPI	The name of the service that deals with SAP XI/PI.
static String	SAPR3	The name of the service that deals with all of the SAPR3.
static String	SEC_RANK_ALL	This rank is made of the following privileges:
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static QueryObjectType<Service>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).
static String	USERMESSAGE	The name of the service that deals with all of the User Messages.

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
ProcessServerService	createProcessServerService(ProcessServer newProcessServer)	Create a new ProcessServerService linked to this object.
RWIterable<JobDefinitionType>	getJobDefinitionTypes()	Get an RWIterable over an ordered collection of JobDefinitionTypes.
ProcessServerService	getProcessServerServiceByProcessServer(ProcessServer processServer)	Get the ProcessServerService by Association.
RWIterable<ProcessServerService>	getProcessServerServices()	Get an RWIterable over an ordered collection of ProcessServerServices.
boolean	isExplainJobStatusPossible(Job job)	Is explainJobStatus possible? Returns true if explainJobStatus() is possible, false otherwise.

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 from SchedulerEntity.getObjectType() for "Service" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<Service> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

AS400

static final String AS400

The name of the service that deals with all of the AS400 types.

See Also:

Constant Field Values

MAIL

static final String MAIL

The name of the service that deals with all of the Mail types.

See Also:

Constant Field Values

JXBP

static final String JXBP

The name of the service that deals with all of the JXBP types.

See Also:

Constant Field Values

JOBCHAIN

static final String JOBCHAIN

The name of the service that deals with job chains.

See Also:

Constant Field Values

PLATFORM_AGENT_SCRIPT

static final String PLATFORM_AGENT_SCRIPT

The name of the service that deals with all of the Platform Agent Script types.

See Also:

Constant Field Values

RW_SCRIPT

static final String RW_SCRIPT

The name of the service that deals with Redwood Script.

See Also:

Constant Field Values

SAPR3

static final String SAPR3

The name of the service that deals with all of the SAPR3.

See Also:

Constant Field Values

SAPPI

static final String SAPPI

The name of the service that deals with SAP XI/PI.

See Also:

Constant Field Values

SAPBOBJ

static final String SAPBOBJ

The name of the service that deals with SAP Business Objects.

See Also:

Constant Field Values

HTTP

static final String HTTP

The name of the service that deals with all of the HTTP types.

See Also:

Constant Field Values

JDBC

static final String JDBC

The name of the service that deals with all of the JDBC types.

See Also:

Constant Field Values

ORACLE_JOB

static final String ORACLE_JOB

The name of the service that deals with all of the Oracle job types.

See Also:

Constant Field Values

REPORT

static final String REPORT

The name of the service that deals with reports.

See Also:

Constant Field Values

ORAAPPS

static final String ORAAPPS

The name of the service that deals with Oracle Applications.

See Also:

Constant Field Values

ORAOHI

static final String ORAOHI

The name of the service that deals with Oracle Helth Insurance.

See Also:

Constant Field Values

PEOPLESOFT

static final String PEOPLESOFT

The name of the service that deals with PeopleSoft.

See Also:

Constant Field Values

USERMESSAGE

static final String USERMESSAGE

The name of the service that deals with all of the User Messages.

See Also:

Constant Field Values

PUBLISH

static final String PUBLISH

The name of the service that deals with the publishing jobs.

See Also:

Constant Field Values

OBJECT_SEARCH

static final String OBJECT_SEARCH

The name of the service that deals with the ObjectSearch jobs.

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_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges:

See Also:

Constant Field Values

Method Detail

isExplainJobStatusPossible

boolean isExplainJobStatusPossible(Job job)

Is explainJobStatus possible? Returns true if explainJobStatus() is possible, false otherwise.

Parameters:

job - Job about which the inquiry is being made.

Returns:

Returns true if explainJobStatus() is possible, false otherwise.

getJobDefinitionTypes

RWIterable<JobDefinitionType> getJobDefinitionTypes()

Get an RWIterable over an ordered collection of JobDefinitionTypes. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The job definition types provided by this service.

Specified by:

getJobDefinitionTypes in interface ServiceComp

Returns:

An RWIterable over an ordered collection of JobDefinitionType objects .

getProcessServerServices

RWIterable<ProcessServerService> getProcessServerServices()

Get an RWIterable over an ordered collection of ProcessServerServices. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The services contained in a process server.

Specified by:

getProcessServerServices in interface ServiceComp

Returns:

An RWIterable over an ordered collection of ProcessServerService objects .

createProcessServerService

ProcessServerService createProcessServerService(ProcessServer newProcessServer)

Create a new ProcessServerService linked to this object.

Parameters:

newProcessServer - The other parent of the ProcessServerServiceProcessServer association.

Returns:

a new ProcessServerService.

getProcessServerServiceByProcessServer

ProcessServerService getProcessServerServiceByProcessServer(ProcessServer processServer)

Get the ProcessServerService by Association.

Parameters:

processServer -

Returns:

the ProcessServerService, or null if it could not be found