Package com.redwood.scheduler.api.model

Interface TimeZone

All Superinterfaces:

BusinessKeyObject, NamedRootObject, NamedRootObjectComp, Root, SchedulerEntity, SchedulerEntityComp

public interface TimeZone
extends NamedRootObject, BusinessKeyObject

A Time Zone.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "TimeZone" objects.
static String	SEC_PRIV_EDIT	This privilege can be granted at a group level.
static String	SEC_RANK_ALL	This rank is made of the following privileges: edit
static String	SEC_RANK_EDIT	This rank is made of the following privileges: edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static QueryObjectType<TimeZone>	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
RequiredPermission	checkEditPrivilege()	Check whether or not the edit action can be performed on this object.
TimeZone	getJavaTimeZone()	Get the Java TimeZone object for this database object.
String	getOlsonName()	Get the value for OlsonName.
boolean	isShowInList()	Get the value for ShowInList.
void	setShowInList(boolean newShowInList)	Set the value for ShowInList.

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<TimeZone> TYPE

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

SEC_PRIV_EDIT

static final String SEC_PRIV_EDIT

This privilege can be granted at a group level.

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_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: edit

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges: edit

See Also:

Constant Field Values

Method Detail

getOlsonName

String getOlsonName()

Get the value for OlsonName. (The name of the timezone in the Olson database) 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.

isShowInList

boolean isShowInList()

Get the value for ShowInList. (Should this timezone be used in the timezone list)

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.

setShowInList

void setShowInList(boolean newShowInList)

Set the value for ShowInList. (Should this timezone be used in the timezone list)

Parameters:

newShowInList - the new value for ShowInList.

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.

getJavaTimeZone

TimeZone getJavaTimeZone()

Get the Java TimeZone object for this database object.

Returns:

The Java TimeZone

checkEditPrivilege

RequiredPermission checkEditPrivilege()

Check whether or not the edit action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.