Package com.redwood.scheduler.api.model

Interface SAPExternalCommand

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface SAPExternalCommand
extends NamedDetailObject, BusinessKeyObject, Readable

External Command details.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPExternalCommand" objects.
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<SAPExternalCommand>	TYPE	Type that can be used in SchedulerSession.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

Modifier and Type	Method	Description
String	getAdditionalParameters()	Get the value for AdditionalParameters.
String	getCheckAll()	Get the value for CheckAll.
String	getIsSapCommand()	Get the value for IsSapCommand.
String	getOsType()	Get the value for OsType.
String	getParameters()	Get the value for Parameters.
String	getProgram()	Get the value for Program.
String	getSAPLanguage()	Get the value for SAPLanguage.
String	getSapPermition()	Get the value for SapPermition.
SAPSystem	getSAPSystem()	Get the SAPSystem.
String	getTraceOn()	Get the value for TraceOn.
void	setAdditionalParameters(String newAdditionalParameters)	Set the value for AdditionalParameters.
void	setCheckAll(String newCheckAll)	Set the value for CheckAll.
void	setIsSapCommand(String newIsSapCommand)	Set the value for IsSapCommand.
void	setOsType(String newOsType)	Set the value for OsType.
void	setParameters(String newParameters)	Set the value for Parameters.
void	setProgram(String newProgram)	Set the value for Program.
void	setSAPLanguage(String newSAPLanguage)	Set the value for SAPLanguage.
void	setSapPermition(String newSapPermition)	Set the value for SapPermition.
void	setTraceOn(String newTraceOn)	Set the value for TraceOn.

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.NamedDetailObject

getComment, getDescription, getName, getSearchName, setComment, setDescription, setName

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 "SAPExternalCommand" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<SAPExternalCommand> TYPE

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

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

getSAPLanguage

String getSAPLanguage()

Get the value for SAPLanguage. (SAP language.) This value is mandatory, and therefore will not be null if 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.

getOsType

String getOsType()

Get the value for OsType. (OS type.) This value is mandatory, and therefore will not be null if 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.

getProgram

String getProgram()

Get the value for Program. (Name of external program (possibly with access path)) This value is mandatory, and therefore will not be null if 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.

getParameters

String getParameters()

Get the value for Parameters. (Parameters of the command.)

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.

getAdditionalParameters

String getAdditionalParameters()

Get the value for AdditionalParameters. (Additional parameters allowed in logical command.)

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.

getIsSapCommand

String getIsSapCommand()

Get the value for IsSapCommand. (Type of a logical command ('X' means provided by SAP).)

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.

getSapPermition

String getSapPermition()

Get the value for SapPermition. (Execute permission for logical commands.)

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.

getTraceOn

String getTraceOn()

Get the value for TraceOn. (Automatic trace for logical commands.)

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.

getCheckAll

String getCheckAll()

Get the value for CheckAll. (Function module to check a logical command.)

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.

setSAPLanguage

void setSAPLanguage(String newSAPLanguage)

Set the value for SAPLanguage. (SAP language.) This value is mandatory.

Parameters:

newSAPLanguage - the new value for SAPLanguage. If this is null, 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.

setOsType

void setOsType(String newOsType)

Set the value for OsType. (OS type.) This value is mandatory.

Parameters:

newOsType - the new value for OsType. If this is null, 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.

setProgram

void setProgram(String newProgram)

Set the value for Program. (Name of external program (possibly with access path)) This value is mandatory.

Parameters:

newProgram - the new value for Program. If this is null, 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.

setParameters

void setParameters(String newParameters)

Set the value for Parameters. (Parameters of the command.) This value is optional.

Parameters:

newParameters - the new value for Parameters.

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.

setAdditionalParameters

void setAdditionalParameters(String newAdditionalParameters)

Set the value for AdditionalParameters. (Additional parameters allowed in logical command.) This value is optional.

Parameters:

newAdditionalParameters - the new value for AdditionalParameters.

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.

setIsSapCommand

void setIsSapCommand(String newIsSapCommand)

Set the value for IsSapCommand. (Type of a logical command ('X' means provided by SAP).) This value is optional.

Parameters:

newIsSapCommand - the new value for IsSapCommand.

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.

setSapPermition

void setSapPermition(String newSapPermition)

Set the value for SapPermition. (Execute permission for logical commands.) This value is optional.

Parameters:

newSapPermition - the new value for SapPermition.

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.

setTraceOn

void setTraceOn(String newTraceOn)

Set the value for TraceOn. (Automatic trace for logical commands.) This value is optional.

Parameters:

newTraceOn - the new value for TraceOn.

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.

setCheckAll

void setCheckAll(String newCheckAll)

Set the value for CheckAll. (Function module to check a logical command.) This value is optional.

Parameters:

newCheckAll - the new value for CheckAll.

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.

getSAPSystem

SAPSystem getSAPSystem()

Get the SAPSystem.

Returns:

SAPSystem

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.