public interface IIterationType extends IIterationTypeHandle, IProcessItem
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ID_PROPERTY_ID
Id of the id property.
|
static IItemType |
ITEM_TYPE
The iteration type item type.
|
static java.lang.String |
PROJECT_AREA_PROPERTY_ID
Id of the project area property.
|
DESCRIPTION_DETAILS_PROPERTY_ID, DESCRIPTION_SUMMARY_PROPERTY_ID, DEVELOPMENT_LINE, ITERATION, ITERATION_TYPE, NAME_PROPERTY_ID, PROCESS_ATTACHMENT, PROCESS_DEFINITION, PROCESS_DOMAIN_DEFINITION, PROJECT_AREA, PROJECT_LINK, READ_ACCESS_LIST, TEAM_AREA
MERGE_PREDECESSOR_STATE_PROPERTY, PREDECESSOR_STATE_PROPERTY
CONTEXT_ID_PROPERTY, ITEM_ID_PROPERTY, MAX_LARGE_STRING_BYTES, MAX_MEDIUM_STRING_BYTES, MAX_SMALL_STRING_BYTES, MODIFIED_BY_PROPERTY, MODIFIED_PROPERTY, STATE_ID_PROPERTY
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getId()
Returns the id of this iteration type or
null if no id has
been set. |
java.lang.String |
getLabel()
This convenience method returns the name of this iteration type if the
name is not
null and is not a whitespace string. |
IProjectAreaHandle |
getProjectArea()
Returns the project area which contains this iteration type or
null if no project area has been set. |
boolean |
isArchived()
Returns whether or not this iteration type is archived.
|
void |
setId(java.lang.String id)
Sets the id of this iteration type.
|
void |
setProjectArea(IProjectAreaHandle projectArea)
Sets this iteration type's project area.
|
getProcessItemType, getPropertyName
getDescription, getName, setName
getMergePredecessorState, getPredecessorState
isNewItem
getContextId, getItemHandle, getModifiedBy, getRedactedCopy, getRequestedModified, getRequestedStateId, getStateHandle, getWorkingCopy, hasHistory, isComplete, isPropertySet, isRedactedCopy, isWorkingCopy, modified, setContextId, setRequestedModified, setRequestedStateId
equals, getAdapter, getFullState, getItemId, getItemType, getOrigin, getStateId, hasFullState, hasStateId, isAuditable, isConfigurationAware, isImmutable, isSimple, isUnmanaged, makeImmutable, protect, sameItemId, sameStateId, size
static final IItemType ITEM_TYPE
static final java.lang.String ID_PROPERTY_ID
static final java.lang.String PROJECT_AREA_PROPERTY_ID
java.lang.String getId()
null
if no id has
been set.
In order for this item to be saved to the repository this field must have
a non-null value, so it is safe to assume that this method will not
return null if it is an immutable copy fetched from the repository. It is
possible for an incomplete/invalid working copy, however, to return
null
.
null
void setId(java.lang.String id)
null
.identifier
- the new identifier, may not be null
java.lang.String getLabel()
null
and is not a whitespace string. Otherwise
it returns this iteration type's id, which may be null
if
this item is a working copy (@see getId()
.null
boolean isArchived()
In order to archive an iteration type, use the process client library or process server service.
IProjectAreaHandle getProjectArea()
null
if no project area has been set.
In order for this item to be saved to the repository this field must have
a non-null value, so it is safe to assume that this method will not
return null if it is an immutable copy fetched from the repository. It is
possible for an incomplete/invalid working copy, however, to return
null
.
NOTE: If this iteration type is used for remote process sharing (it is
owned by a ProcessProviderCacheItem
) this method will return an
invalid handle, DO NOT use it to fetch a project area.
void setProjectArea(IProjectAreaHandle projectArea)
projectArea
- the handle of the project area