CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class ReadOnlyEscalationRuleDto

java.lang.Object
  extended by com.intland.codebeamer.persistence.dto.base.IdentifiableDto
      extended by com.intland.codebeamer.persistence.dto.TrackerItemEscalationRuleDto
          extended by com.intland.codebeamer.persistence.dto.ReadOnlyEscalationRuleDto
All Implemented Interfaces:
BaseDto, ReadOnlyDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable
Direct Known Subclasses:
LinkedEscalationRuleDto

public class ReadOnlyEscalationRuleDto
extends TrackerItemEscalationRuleDto
implements ReadOnlyDto

A special TrackerItemEscalationRuleDto that doesn't allow to change it's attributes All attempts to invoke a property setter method will throw an UnsupportedOperationException

See Also:
Serialized Form

Nested Class Summary
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.TrackerItemEscalationRuleDto
TrackerItemEscalationRuleDto.Anchor
 
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
IdentifiableDto.IdComparator
 
Field Summary
 
Fields inherited from class com.intland.codebeamer.persistence.dto.TrackerItemEscalationRuleDto
DAYS, HOURS, MINUTES, NOTIFY_ADDITIONAL_LISTENERS, NOTIFY_ISSUE_ASSIGNEES, NOTIFY_ISSUE_SUBMITTER, NOTIFY_ISSUE_SUPERVISORS, SECONDS
 
Constructor Summary
ReadOnlyEscalationRuleDto(TrackerItemEscalationRuleDto rule)
          Create a read-only copy of the specified TrackerItemEscalationRuleDto
 
Method Summary
 java.lang.Object clone()
          Create a writable copy of this ReadOnlyDto Caution: The semantics are different than the standard Object.clone() method, because the returned object's class is typically different from the ReadOnlyDtos's class
 void setAnchor(TrackerItemEscalationRuleDto.Anchor anchor)
          Set how to compute the escalation firing date and time based on the specified offset and tracker item anchor field
 void setAudience(java.lang.Integer audience)
          Set the target audience for notification mails emitted by this notification rule.
 void setCompiledOffset(TrackerItemCompiledExpression<java.lang.Number> compiledOffset)
          Set the compiled script/formula to calculate the time offset
 void setFieldId(java.lang.Integer fieldId)
          Set the ID of the anchor field for this escalation level.
 void setId(java.lang.Integer id)
          Sets its unique identifier.
 void setLevel(int level)
          Set the escalation level
 void setListeners(java.util.List<? extends NamedDto> listeners)
          Set the list of additional listeners (other than issue submitter/assignees/supervisors) for notifications emitted by this rule
 void setOffset(java.lang.String offset)
          Set the formula to compute the time offset measured in unit, relative to the field according to anchor
 void setOnlyMembers(java.lang.Boolean onlyMembers)
          Set whether only direct project members in the specified role should be notified (true), or also indirect members (false)
 void setPredicate(NamedDto predicate)
          Set the tracker item filter/predicate, to determine which tracker items are subject of escalation
 void setStatusId(java.lang.Integer statusId)
          Set the ID of the escalation target status (if any).
 void setUnit(java.lang.Integer unit)
          Set the time unit of the specified offset, defaults to HOURS if null
 
Methods inherited from class com.intland.codebeamer.persistence.dto.TrackerItemEscalationRuleDto
compareTo, equals, getAnchor, getAudience, getCompiledOffset, getFieldId, getId, getLevel, getListeners, getOffset, getOffset, getOffset, getOffset, getOnlyMembers, getPredicate, getStatusId, getUnit, isAudience, toString
 
Methods inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto
compare, compareInteger, equals, hashCode, hashCode
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ReadOnlyEscalationRuleDto

public ReadOnlyEscalationRuleDto(TrackerItemEscalationRuleDto rule)
Create a read-only copy of the specified TrackerItemEscalationRuleDto

Parameters:
rule - to copy
Method Detail

clone

public java.lang.Object clone()
Description copied from interface: ReadOnlyDto
Create a writable copy of this ReadOnlyDto Caution: The semantics are different than the standard Object.clone() method, because the returned object's class is typically different from the ReadOnlyDtos's class

Specified by:
clone in interface ReadOnlyDto
Overrides:
clone in class IdentifiableDto
Returns:
a mutable copy of this ReadOnlyEscalationRuleDto

setId

public void setId(java.lang.Integer id)
Description copied from class: IdentifiableDto
Sets its unique identifier.

Overrides:
setId in class IdentifiableDto

setLevel

public void setLevel(int level)
Description copied from class: TrackerItemEscalationRuleDto
Set the escalation level

Overrides:
setLevel in class TrackerItemEscalationRuleDto
Parameters:
level - is the escalation level, that must be unique within a tracker and predicate/group

setPredicate

public void setPredicate(NamedDto predicate)
Description copied from class: TrackerItemEscalationRuleDto
Set the tracker item filter/predicate, to determine which tracker items are subject of escalation

Overrides:
setPredicate in class TrackerItemEscalationRuleDto
Parameters:
predicate - is the tracker item filter/predicate, to determine which tracker items are subject of escalation

setOffset

public void setOffset(java.lang.String offset)
Description copied from class: TrackerItemEscalationRuleDto
Set the formula to compute the time offset measured in unit, relative to the field according to anchor

Overrides:
setOffset in class TrackerItemEscalationRuleDto
Parameters:
offset - is the formula to compute the time offset in the specified unit, relative to the specified field according to anchor

setCompiledOffset

public void setCompiledOffset(TrackerItemCompiledExpression<java.lang.Number> compiledOffset)
Description copied from class: TrackerItemEscalationRuleDto
Set the compiled script/formula to calculate the time offset

Overrides:
setCompiledOffset in class TrackerItemEscalationRuleDto
Parameters:
compiledOffset - is the compiled script/formula to calculate the time offset, or null

setUnit

public void setUnit(java.lang.Integer unit)
Description copied from class: TrackerItemEscalationRuleDto
Set the time unit of the specified offset, defaults to HOURS if null

Overrides:
setUnit in class TrackerItemEscalationRuleDto

setAnchor

public void setAnchor(TrackerItemEscalationRuleDto.Anchor anchor)
Description copied from class: TrackerItemEscalationRuleDto
Set how to compute the escalation firing date and time based on the specified offset and tracker item anchor field

Overrides:
setAnchor in class TrackerItemEscalationRuleDto
Parameters:
anchor - is the TrackerItemEscalationRuleDto.Anchor that determines the relation between the specified offset and tracker item field

setFieldId

public void setFieldId(java.lang.Integer fieldId)
Description copied from class: TrackerItemEscalationRuleDto
Set the ID of the anchor field for this escalation level. The escalation firing date and time is calculated relative to this field's value or last modification time, based on offset, unit and anchor

Overrides:
setFieldId in class TrackerItemEscalationRuleDto
Parameters:
fieldId - is the ID of the anchor field for this escalation level

setStatusId

public void setStatusId(java.lang.Integer statusId)
Description copied from class: TrackerItemEscalationRuleDto
Set the ID of the escalation target status (if any).

Overrides:
setStatusId in class TrackerItemEscalationRuleDto
Parameters:
statusId - is the ID of the new status for the target tracker item upon escalation, or null to not change the item status

setAudience

public void setAudience(java.lang.Integer audience)
Description copied from class: TrackerItemEscalationRuleDto
Set the target audience for notification mails emitted by this notification rule. This should be a bitmask (logical OR) of
- TrackerItemEscalationRuleDto.NOTIFY_ISSUE_SUBMITTER
- TrackerItemEscalationRuleDto.NOTIFY_ISSUE_ASSIGNEES
- TrackerItemEscalationRuleDto.NOTIFY_ISSUE_SUPERVISORS
- TrackerItemEscalationRuleDto.NOTIFY_ADDITIONAL_LISTENERS defined in TrackerItemEscalationRuleDto.getListeners()

Overrides:
setAudience in class TrackerItemEscalationRuleDto
Parameters:
audience - is the target audience for notification mails emitted by this notification rule.

setListeners

public void setListeners(java.util.List<? extends NamedDto> listeners)
Description copied from class: TrackerItemEscalationRuleDto
Set the list of additional listeners (other than issue submitter/assignees/supervisors) for notifications emitted by this rule

Overrides:
setListeners in class TrackerItemEscalationRuleDto
Parameters:
listeners - is a list of additional listeners (users and/or roles) for notifications emitted by this rule

setOnlyMembers

public void setOnlyMembers(java.lang.Boolean onlyMembers)
Description copied from class: TrackerItemEscalationRuleDto
Set whether only direct project members in the specified role should be notified (true), or also indirect members (false)

Overrides:
setOnlyMembers in class TrackerItemEscalationRuleDto
Parameters:
onlyMembers - true if only direct project members in the specified role should be notified, or false to also notify indirect members

CodeBeamer 5.4.0.1-RC API

Copyright © 2006-2009 Intland Software. All rights reserved.