CodeBeamer 5.4.0.1-RC API

com.intland.codebeamer.persistence.dto
Class LinkedEscalationRuleDto

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
              extended by com.intland.codebeamer.persistence.dto.LinkedEscalationRuleDto
All Implemented Interfaces:
BaseDto, ReadOnlyDto, java.io.Serializable, java.lang.Cloneable, java.lang.Comparable

public class LinkedEscalationRuleDto
extends ReadOnlyEscalationRuleDto

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
LinkedEscalationRuleDto(TrackerItemEscalationRuleDto rule, TrackerItemEscalationRuleDto template)
          Create a read-only version of the specified TrackerItemEscalationRuleDto that is linked to the specified template rule
 
Method Summary
 TrackerItemEscalationRuleDto.Anchor getAnchor()
          Get the TrackerItemEscalationRuleDto.Anchor relation between the specified offset and the tracker item anchor field
 java.lang.Integer getAudience()
          Get the target audience for notification mails emitted by this notification rule.
 TrackerItemCompiledExpression<java.lang.Number> getCompiledOffset()
          Get the compiled script/formula to calculate the time offset
 java.lang.Integer getFieldId()
          Get the ID of the escalation anchor field.
 java.lang.Integer getId()
          Get the ID of the tracker, this escalation rule was declared at
 java.util.List<? extends NamedDto> getListeners()
          Get the list of additional listeners (other than issue submitter/assignees/supervisors) for notifications emitted by this rule
 java.lang.String getOffset()
          Get the formula to compute the time offset measured in unit, relative to the field according to anchor
 java.lang.Boolean getOnlyMembers()
          Check if only direct project members in the specified role should be notified (true), or also indirect members (false)
 NamedDto getPredicate()
          Get the tracker item filter/predicate, to determine which tracker items are subject of escalation
 java.lang.Integer getStatusId()
          Get the ID of the escalation target status (if any).
 TrackerItemEscalationRuleDto getTemplate()
           
 java.lang.Integer getUnit()
          Get the time unit of the specified offset
protected  java.lang.Object writeReplace()
           
 
Methods inherited from class com.intland.codebeamer.persistence.dto.ReadOnlyEscalationRuleDto
clone, setAnchor, setAudience, setCompiledOffset, setFieldId, setId, setLevel, setListeners, setOffset, setOnlyMembers, setPredicate, setStatusId, setUnit
 
Methods inherited from class com.intland.codebeamer.persistence.dto.TrackerItemEscalationRuleDto
compareTo, equals, getLevel, getOffset, getOffset, getOffset, 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

LinkedEscalationRuleDto

public LinkedEscalationRuleDto(TrackerItemEscalationRuleDto rule,
                               TrackerItemEscalationRuleDto template)
Create a read-only version of the specified TrackerItemEscalationRuleDto that is linked to the specified template rule

Parameters:
rule - contains override definitions of the rule
template - to get missing definitions from
Method Detail

getTemplate

public TrackerItemEscalationRuleDto getTemplate()

writeReplace

protected java.lang.Object writeReplace()

getId

public java.lang.Integer getId()
Description copied from class: TrackerItemEscalationRuleDto
Get the ID of the tracker, this escalation rule was declared at

Overrides:
getId in class TrackerItemEscalationRuleDto
Returns:
the ID of the declaring tracker for this escalation rule

getPredicate

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

Overrides:
getPredicate in class TrackerItemEscalationRuleDto
Returns:
the tracker item filter/predicate, to determine which tracker items are subject of escalation

getOffset

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

Overrides:
getOffset in class TrackerItemEscalationRuleDto
Returns:
the formula to compute the time offset in the specified unit, relative to the specified field according to anchor

getCompiledOffset

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

Overrides:
getCompiledOffset in class TrackerItemEscalationRuleDto
Returns:
the compiled script/formula to calculate the time offset, or null

getUnit

public java.lang.Integer getUnit()
Description copied from class: TrackerItemEscalationRuleDto
Get the time unit of the specified offset

Overrides:
getUnit in class TrackerItemEscalationRuleDto
Returns:
the time unit of the specified offset

getAnchor

public TrackerItemEscalationRuleDto.Anchor getAnchor()
Description copied from class: TrackerItemEscalationRuleDto
Get the TrackerItemEscalationRuleDto.Anchor relation between the specified offset and the tracker item anchor field

Overrides:
getAnchor in class TrackerItemEscalationRuleDto
Returns:
the TrackerItemEscalationRuleDto.Anchor relation between the specified offset and the tracker item anchor field

getFieldId

public java.lang.Integer getFieldId()
Description copied from class: TrackerItemEscalationRuleDto
Get the ID of the escalation anchor field. The escalation firing date and time is relative to the value/last modification date of this field

Overrides:
getFieldId in class TrackerItemEscalationRuleDto
Returns:
the ID of the escalation anchor field

getStatusId

public java.lang.Integer getStatusId()
Description copied from class: TrackerItemEscalationRuleDto
Get the ID of the escalation target status (if any). The tracker item where the escalation occured will be set to this target

Overrides:
getStatusId in class TrackerItemEscalationRuleDto
Returns:
the ID of the escalation target status, or null (do not change item status upon escalation)

getAudience

public java.lang.Integer getAudience()
Description copied from class: TrackerItemEscalationRuleDto
Get the target audience for notification mails emitted by this notification rule. This is 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:
getAudience in class TrackerItemEscalationRuleDto
Returns:
the audience for notification mails emitted by this notification rule

getListeners

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

Overrides:
getListeners in class TrackerItemEscalationRuleDto
Returns:
the list of additional listeners (users and/or roles) for notifications emitted by this rule

getOnlyMembers

public java.lang.Boolean getOnlyMembers()
Description copied from class: TrackerItemEscalationRuleDto
Check if only direct project members in the specified role should be notified (true), or also indirect members (false)

Overrides:
getOnlyMembers in class TrackerItemEscalationRuleDto
Returns:
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.