Package com.redwood.scheduler.api.model

Interface ProcessServerCheckLog

All Superinterfaces:

Detail, ProcessServerCheckLogComp, SchedulerEntity, SchedulerEntityComp

public interface ProcessServerCheckLog
extends ProcessServerCheckLogComp, Detail

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. Up and down time can be inferred from time stamp differences.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "ProcessServerCheckLog" 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<ProcessServerCheckLog>	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
ProcessServerCheckLogParameter	createProcessServerCheckLogParameter()	Create a new ProcessServerCheckLogParameter linked to this object.
DateTimeZone	getCreationTime()	Get the value for CreationTime.
ProcessServerCheck	getProcessServerCheck()	Get the ProcessServerCheck.
ProcessServerCheckLogParameter	getProcessServerCheckLogParameterByName(String name)	Get the ProcessServerCheckLogParameter by NameProcessServerCheckLog.
RWIterable<ProcessServerCheckLogParameter>	getProcessServerCheckLogParameters()	Get an RWIterable over an ordered collection of ProcessServerCheckLogParameters.
boolean	isSuccess()	Get the value for Success.
void	setSuccess(boolean newSuccess)	Set the value for Success.

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

See Also:

Constant Field Values

TYPE

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

getCreationTime

DateTimeZone getCreationTime()

Get the value for CreationTime. (Timestamp that notes when the Process Server Check Status was logged.) 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.

isSuccess

boolean isSuccess()

Get the value for Success. (Success or failure result of the check)

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.

setSuccess

void setSuccess(boolean newSuccess)

Set the value for Success. (Success or failure result of the check)

Parameters:

newSuccess - the new value for Success.

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.

getProcessServerCheck

ProcessServerCheck getProcessServerCheck()

Get the ProcessServerCheck.

Returns:

ProcessServerCheck

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.

getProcessServerCheckLogParameters

RWIterable<ProcessServerCheckLogParameter> getProcessServerCheckLogParameters()

Get an RWIterable over an ordered collection of ProcessServerCheckLogParameters. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The parameters for a ProcessServerCheck at the time its success log was recorded.

Specified by:

getProcessServerCheckLogParameters in interface ProcessServerCheckLogComp

Returns:

An RWIterable over an ordered collection of ProcessServerCheckLogParameter objects .

createProcessServerCheckLogParameter

ProcessServerCheckLogParameter createProcessServerCheckLogParameter()

Create a new ProcessServerCheckLogParameter linked to this object.

Returns:

a new ProcessServerCheckLogParameter.

getProcessServerCheckLogParameterByName

ProcessServerCheckLogParameter getProcessServerCheckLogParameterByName(String name)

Get the ProcessServerCheckLogParameter by NameProcessServerCheckLog.

Parameters:

name -

Returns:

the ProcessServerCheckLogParameter, or null if it could not be found