Package com.redwood.scheduler.api.model

Interface SAPLogError

All Superinterfaces:

Detail, Readable, SchedulerEntity, SchedulerEntityComp

public interface SAPLogError
extends Detail, Readable

Log errors.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPLogError" 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<SAPLogError>	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	getClientNumberMask()	Get the value for ClientNumberMask.
String	getDescription()	Get the value for Description.
String	getJobnameMask()	Get the value for JobnameMask.
String	getMessageID()	Get the value for MessageID.
String	getMessageNumber()	Get the value for MessageNumber.
String	getMessageText()	Get the value for MessageText.
String	getMessageType()	Get the value for MessageType.
Long	getProcessingOrder()	Get the value for ProcessingOrder.
Long	getReturnCode()	Get the value for ReturnCode.
SAPSystem	getSAPSystem()	Get the SAPSystem.
String	getUsernameMask()	Get the value for UsernameMask.
boolean	isCreateJobNote()	Get the value for CreateJobNote.
void	setClientNumberMask(String newClientNumberMask)	Set the value for ClientNumberMask.
void	setCreateJobNote(boolean newCreateJobNote)	Set the value for CreateJobNote.
void	setDescription(String newDescription)	Set the value for Description.
void	setJobnameMask(String newJobnameMask)	Set the value for JobnameMask.
void	setMessageID(String newMessageID)	Set the value for MessageID.
void	setMessageNumber(String newMessageNumber)	Set the value for MessageNumber.
void	setMessageText(String newMessageText)	Set the value for MessageText.
void	setMessageType(String newMessageType)	Set the value for MessageType.
void	setProcessingOrder(Long newProcessingOrder)	Set the value for ProcessingOrder.
void	setReturnCode(Long newReturnCode)	Set the value for ReturnCode.
void	setUsernameMask(String newUsernameMask)	Set the value for UsernameMask.

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<SAPLogError> 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

getProcessingOrder

Long getProcessingOrder()

Get the value for ProcessingOrder. (Processing order) 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.

getDescription

String getDescription()

Get the value for Description. (The description of this mapping)

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.

getClientNumberMask

String getClientNumberMask()

Get the value for ClientNumberMask. (Client number mask.) 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.

getJobnameMask

String getJobnameMask()

Get the value for JobnameMask. (SAP job name mask.) 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.

getUsernameMask

String getUsernameMask()

Get the value for UsernameMask. (SAP username mask.) 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.

getMessageID

String getMessageID()

Get the value for MessageID. (T100 Message Class.) 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.

getMessageNumber

String getMessageNumber()

Get the value for MessageNumber. (T100 Message Number.) 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.

getMessageType

String getMessageType()

Get the value for MessageType. (T100 Message 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.

getReturnCode

Long getReturnCode()

Get the value for ReturnCode. (Job return code) 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.

getMessageText

String getMessageText()

Get the value for MessageText. (Message text.)

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.

isCreateJobNote

boolean isCreateJobNote()

Get the value for CreateJobNote. (If a job note should be created)

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.

setProcessingOrder

void setProcessingOrder(Long newProcessingOrder)

Set the value for ProcessingOrder. (Processing order) This value is mandatory.

Parameters:

newProcessingOrder - the new value for ProcessingOrder. 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.

setDescription

void setDescription(String newDescription)

Set the value for Description. (The description of this mapping) This value is optional.

Parameters:

newDescription - the new value for Description.

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.

setClientNumberMask

void setClientNumberMask(String newClientNumberMask)

Set the value for ClientNumberMask. (Client number mask.) This value is mandatory.

Parameters:

newClientNumberMask - the new value for ClientNumberMask. 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.

setJobnameMask

void setJobnameMask(String newJobnameMask)

Set the value for JobnameMask. (SAP job name mask.) This value is mandatory.

Parameters:

newJobnameMask - the new value for JobnameMask. 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.

setUsernameMask

void setUsernameMask(String newUsernameMask)

Set the value for UsernameMask. (SAP username mask.) This value is mandatory.

Parameters:

newUsernameMask - the new value for UsernameMask. 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.

setMessageID

void setMessageID(String newMessageID)

Set the value for MessageID. (T100 Message Class.) This value is mandatory.

Parameters:

newMessageID - the new value for MessageID. 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.

setMessageNumber

void setMessageNumber(String newMessageNumber)

Set the value for MessageNumber. (T100 Message Number.) This value is mandatory.

Parameters:

newMessageNumber - the new value for MessageNumber. 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.

setMessageType

void setMessageType(String newMessageType)

Set the value for MessageType. (T100 Message Type.) This value is mandatory.

Parameters:

newMessageType - the new value for MessageType. 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.

setReturnCode

void setReturnCode(Long newReturnCode)

Set the value for ReturnCode. (Job return code) This value is mandatory.

Parameters:

newReturnCode - the new value for ReturnCode. 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.

setMessageText

void setMessageText(String newMessageText)

Set the value for MessageText. (Message text.) This value is optional.

Parameters:

newMessageText - the new value for MessageText.

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.

setCreateJobNote

void setCreateJobNote(boolean newCreateJobNote)

Set the value for CreateJobNote. (If a job note should be created)

Parameters:

newCreateJobNote - the new value for CreateJobNote.

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.