|
CodeBeamer 5.4.0.1-RC API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.intland.codebeamer.persistence.dto.base.IdentifiableDto
com.intland.codebeamer.persistence.dto.base.NamedDto
com.intland.codebeamer.persistence.dto.base.DescribeableDto
com.intland.codebeamer.persistence.dto.ArtifactDto
com.intland.codebeamer.persistence.dto.CalendarEntryDto
public class CalendarEntryDto
A special ArtifactDto that represents an entry in a WorkTimeCalendar, which is a special type of Directory Artifact
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.ArtifactDto |
---|
ArtifactDto.PathComparator |
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.DescribeableDto |
---|
DescribeableDto.DescriptionComparator |
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.NamedDto |
---|
NamedDto.NameComparator |
Nested classes/interfaces inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto |
---|
IdentifiableDto.IdComparator |
Nested classes/interfaces inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto |
---|
ReferableDto.DescriptionComparator |
Field Summary | |
---|---|
static java.lang.String |
HOURS_SEP
The separator for the hours in the definition " |
static java.lang.String |
RANGE_SEP
The separator for year ranges "[fromYear ... |
static java.lang.Integer |
TYPE
The ArtifactType for calendar entries |
Fields inherited from class com.intland.codebeamer.persistence.dto.ArtifactDto |
---|
INTERWIKI_LINK_TYPE_DIR, INTERWIKI_LINK_TYPE_DOC, INTERWIKI_LINK_TYPE_NOTE, INTERWIKI_LINK_TYPE_NOTES, INTERWIKI_LINK_TYPE_REPORT |
Fields inherited from interface com.intland.codebeamer.persistence.util.WorkTimeCalendar.Day |
---|
DEFAULT, LEISURE, STATE_NAMES, WORKDAY |
Fields inherited from interface com.intland.codebeamer.persistence.dto.base.ReferableDto |
---|
HEAD_VERSION, SECTION_DELIMITER, VERSION_DELIMITER |
Constructor Summary | |
---|---|
CalendarEntryDto()
Default constructor |
|
CalendarEntryDto(int date,
int state,
java.util.List<com.intland.codebeamer.persistence.util.WorkTimeCalendar.Hours> hours,
java.lang.String description)
|
Method Summary | |
---|---|
protected java.lang.String |
buildName()
The name of a CalendarEntryDto consists of the anchor date plus the optional valid from to valid until range in the form " |
int |
getDate()
|
java.lang.String |
getDefinition()
Get the entry definition string, that contains the description plus business hours in the form " |
java.util.List<com.intland.codebeamer.persistence.util.WorkTimeCalendar.Hours> |
getHours()
Get the business/working hours at this day |
int |
getState()
|
java.lang.Integer |
getValidFrom()
|
java.lang.Integer |
getValidUntil()
|
protected void |
rebuildName()
Rebuild and set the name of this calendar entry after name components have been modified |
void |
setDate(int theDate)
Set the anchor [[year]month]day of this element as an Integer of the form "[[yyyy]mm]dd". |
void |
setDefinition(java.lang.String definition)
This method can be used to set entry description plus hours via a single definition string of the form " |
void |
setHours(java.util.List<com.intland.codebeamer.persistence.util.WorkTimeCalendar.Hours> hours)
Set the business/working hours at this day |
void |
setName(java.lang.String name)
The name of a CalendarEntryDto consists of the anchor date plus the optional valid from to valid until range in the form " |
void |
setState(int state)
Set the state (DEFAULT, WORKDAY or LEISURE) of this calendar day |
void |
setValidFrom(java.lang.Integer theDate)
Set the date this element is valid from (inclusive) encoded as an Integer of the form "yyyymmdd". |
void |
setValidUntil(java.lang.Integer theDate)
Set the date this element is valid until (inclusive) encoded as an Integer of the form "yyyymmdd". |
java.lang.String |
toString()
Get a String description of this Calendar entry in the default TimeZone and Locale |
java.lang.String |
toString(java.util.TimeZone tz,
java.util.Locale loc)
Get a localized String description of this Calendar entry for the specified TimeZone and Locale |
Methods inherited from class com.intland.codebeamer.persistence.dto.ArtifactDto |
---|
clone, compareArtifacts, compareScope, compareTo, compareType, equals, getAdditionalInfo, getAge, getCanDelete, getCompareType, getCreatedAt, getGenericReferenceId, getIconUrl, getInterwikiLink, getInterwikiLinkVersioned, getLastModifiedAt, getLastModifiedBy, getNotification, getOwner, getParent, getPath, getProject, getScopeName, getShortDescription, getTypeId, getUrlLink, getUrlLinkVersioned, getVersion, hashCode, isA, isApprovalSupported, isDeleted, isDirectory, isExists, isFile, isIndexed, isReadable, isSubscribed, isWikiNotes, isWikiPage, isWritable, setAdditionalInfo, setCreatedAt, setDeleted, setGenericReferenceId, setIndexed, setLastModifiedAt, setLastModifiedBy, setNotification, setOwner, setParent, setProject, setReadable, setScopeName, setTypeId, setWritable |
Methods inherited from class com.intland.codebeamer.persistence.dto.base.DescribeableDto |
---|
compareByDescription, getDescription, getDescriptionFormat, setDescription, setDescriptionFormat |
Methods inherited from class com.intland.codebeamer.persistence.dto.base.NamedDto |
---|
compareNames, compareString, compareStringIgnoreCase, createLookupMap, getName |
Methods inherited from class com.intland.codebeamer.persistence.dto.base.IdentifiableDto |
---|
compare, compareInteger, equals, getId, hashCode, setId |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.intland.codebeamer.persistence.util.WorkTimeCalendar.Day |
---|
getDescription |
Field Detail |
---|
public static final java.lang.Integer TYPE
public static final java.lang.String RANGE_SEP
public static final java.lang.String HOURS_SEP
Constructor Detail |
---|
public CalendarEntryDto()
public CalendarEntryDto(int date, int state, java.util.List<com.intland.codebeamer.persistence.util.WorkTimeCalendar.Hours> hours, java.lang.String description)
Method Detail |
---|
protected java.lang.String buildName()
protected final void rebuildName()
public void setName(java.lang.String name)
setName
in class ArtifactDto
public void setDate(int theDate)
1225
represents 'Dec. 25' in every year, 19631128
is 'Nov. 28, 1963'
theDate
- anchor of this calendar elementpublic int getDate()
getDate
in interface com.intland.codebeamer.persistence.util.WorkTimeCalendar.Day
public void setState(int state)
state
- is the working state of this calendar daypublic int getState()
getState
in interface com.intland.codebeamer.persistence.util.WorkTimeCalendar.Day
public void setHours(java.util.List<com.intland.codebeamer.persistence.util.WorkTimeCalendar.Hours> hours)
hours
- is a List of the business/working hours at this day, or nullpublic java.util.List<com.intland.codebeamer.persistence.util.WorkTimeCalendar.Hours> getHours()
getHours
in interface com.intland.codebeamer.persistence.util.WorkTimeCalendar.Day
public void setDefinition(java.lang.String definition)
definition
- to setpublic java.lang.String getDefinition()
public void setValidFrom(java.lang.Integer theDate)
WorkTimeCalendar.encode(Calendar)
For example: Valid from March 1, 2002 is: 20020301
theDate
- this element is valid from (infinite if null)public java.lang.Integer getValidFrom()
getValidFrom
in interface com.intland.codebeamer.persistence.util.WorkTimeCalendar.Day
public void setValidUntil(java.lang.Integer theDate)
WorkTimeCalendar.encode(Calendar)
For example: Valid from March 1, 2002 is: 20020301
theDate
- this element is valid from (infinite if null)public java.lang.Integer getValidUntil()
getValidUntil
in interface com.intland.codebeamer.persistence.util.WorkTimeCalendar.Day
public java.lang.String toString(java.util.TimeZone tz, java.util.Locale loc)
tz
- is the TimeZone for hours localizationloc
- is the Locale for names localization
public java.lang.String toString()
toString
in class ArtifactDto
|
CodeBeamer 5.4.0.1-RC API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |