Package com.redwood.scheduler.api.model

Interface SAPOutputDevice

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SAPOutputDeviceComp, SchedulerEntity, SchedulerEntityComp

public interface SAPOutputDevice
extends SAPOutputDeviceComp, NamedDetailObject, BusinessKeyObject, Readable

Output Device.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPOutputDevice" 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<SAPOutputDevice>	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
SAPOutputFormat	createSAPOutputFormat()	Create a new SAPOutputFormat linked to this object.
String	getAccessMethod()	Get the value for AccessMethod.
String	getDeviceType()	Get the value for DeviceType.
String	getHostPrinter()	Get the value for HostPrinter.
SAPOutputFormat	getSAPOutputFormatByName(String name)	Get the SAPOutputFormat by NameSAPOutputDevice.
RWIterable<SAPOutputFormat>	getSAPOutputFormats()	Get an RWIterable over an ordered collection of SAPOutputFormats.
SAPSystem	getSAPSystem()	Get the SAPSystem.
String	getStatusMessage()	Get the value for StatusMessage.
boolean	isLocked()	Get the value for Locked.
void	setAccessMethod(String newAccessMethod)	Set the value for AccessMethod.
void	setDeviceType(String newDeviceType)	Set the value for DeviceType.
void	setHostPrinter(String newHostPrinter)	Set the value for HostPrinter.
void	setLocked(boolean newLocked)	Set the value for Locked.
void	setStatusMessage(String newStatusMessage)	Set the value for StatusMessage.

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

See Also:

Constant Field Values

TYPE

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

getDeviceType

String getDeviceType()

Get the value for DeviceType. (Device type name)

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.

getStatusMessage

String getStatusMessage()

Get the value for StatusMessage. (Status message (or copy of location))

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.

getAccessMethod

String getAccessMethod()

Get the value for AccessMethod. (Host spool system access method)

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.

getHostPrinter

String getHostPrinter()

Get the value for HostPrinter. (Long name of printers for host spooler)

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.

isLocked

boolean isLocked()

Get the value for Locked. (Output device not released)

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.

setDeviceType

void setDeviceType(String newDeviceType)

Set the value for DeviceType. (Device type name) This value is optional.

Parameters:

newDeviceType - the new value for DeviceType.

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.

setStatusMessage

void setStatusMessage(String newStatusMessage)

Set the value for StatusMessage. (Status message (or copy of location)) This value is optional.

Parameters:

newStatusMessage - the new value for StatusMessage.

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.

setAccessMethod

void setAccessMethod(String newAccessMethod)

Set the value for AccessMethod. (Host spool system access method) This value is optional.

Parameters:

newAccessMethod - the new value for AccessMethod.

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.

setHostPrinter

void setHostPrinter(String newHostPrinter)

Set the value for HostPrinter. (Long name of printers for host spooler) This value is optional.

Parameters:

newHostPrinter - the new value for HostPrinter.

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.

setLocked

void setLocked(boolean newLocked)

Set the value for Locked. (Output device not released)

Parameters:

newLocked - the new value for Locked.

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.

getSAPOutputFormats

RWIterable<SAPOutputFormat> getSAPOutputFormats()

Get an RWIterable over an ordered collection of SAPOutputFormats. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Format of a SAP output device.

Specified by:

getSAPOutputFormats in interface SAPOutputDeviceComp

Returns:

An RWIterable over an ordered collection of SAPOutputFormat objects .

createSAPOutputFormat

SAPOutputFormat createSAPOutputFormat()

Create a new SAPOutputFormat linked to this object.

Returns:

a new SAPOutputFormat.

getSAPOutputFormatByName

SAPOutputFormat getSAPOutputFormatByName(String name)

Get the SAPOutputFormat by NameSAPOutputDevice.

Parameters:

name -

Returns:

the SAPOutputFormat, or null if it could not be found