oracle.alm.connector.data

Class WorkItemDef

java.lang.Object

oracle.alm.connector.data.RowDef

oracle.alm.connector.data.WorkItemDef

Direct Known Subclasses:

WorkItemQueryDef

public class WorkItemDef
extends RowDef

The WorkItemDef class holds meta data of a work item. This is the runtime structure for the Work item tag used in the connector model or XML definition file.

Since:

11.1.1.1.0

See Also:

RowDef, WorkItemFieldDef, WorkItem

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_TYPE_NAME default type of a work item definition
protected java.util.Map<java.lang.String,java.lang.String>	webReference

Fields inherited from class oracle.alm.connector.data.RowDef

DEFAULT_FETCH_SIZE

Constructor Summary

Constructors

Constructor and Description
WorkItemDef()

Method Summary

Methods

Modifier and Type	Method and Description
void	addWebReferenceEntry(java.lang.String name, java.lang.String anchor) Adds a web reference entry for a work item field.
WorkItemDef	createNew() Constructs a new instance of WorkItemDef from the current instance.
CommentDef	getCommentDef() Retrieves the work item comment definition.
java.util.Map<java.lang.String,DataSourceDef>	getDataSourceDefs() Retrieves data sources used by the work item.
java.lang.String	getFeatureHandlerClass()
java.lang.String	getIdDef() Retrieves the Id field used to uniquely identify the work item.
java.lang.String	getIDLabel() Deprecated. Obsoleted, use getLabelDef() instead
java.lang.String	getLabelDef() Retrieves the workitem field name.
java.lang.String	getName() Retrieves the name of work item.
RepositoryDef	getRepositoryDef() Retrieves definition of a parent repository.
java.lang.String	getSubjectDef() Retrieves the field used as subject of the work item.
java.lang.String	getType() Retrieves the work item type.
java.lang.String	getTypeLabel() Retrieve the display label for the workitem type attribute.
java.lang.String	getUrlHandlerClass() Retrieves the class name used to handle the URL construction for the fields that are configured as web reference.
java.util.Map<java.lang.String,java.lang.String>	getWebReferences() Retrieves the web references used by the work item.
boolean	isSupportSearchById() Retrieves a flag to determine if the work item supports "Search by ID" feature.
boolean	isSupportWorkItemCreation() Retrieves a flag to determine if work item creation is supported.
void	setCommentDef(CommentDef cDef) Set the work item comment definition
void	setFeatureHandlerClass(java.lang.String featureHandler)
void	setIdDef(java.lang.String idDef) Sets the Id field used to uniquely identify the work item.
void	setIDLabel(java.lang.String sLabel) Deprecated. Obsoleted, use setLabelDef() instead
void	setLabelDef(java.lang.String fieldName) Sets the workitem field name.
void	setName(java.lang.String name) Sets the name of the work item
void	setRepositoryDef(RepositoryDef reposDef) Sets definition of a parent repository.
void	setSubjectDef(java.lang.String subjectDef) Sets the field used as subject of the work item.
void	setSupportSearchById(boolean supportSearchByID) Sets a flag indicating if the work item supports "Search by ID" feature.
void	setSupportWorkItemCreation(boolean supportWorkItemCreation) Sets a flag indicating if a work item creation is supported.
void	setType(java.lang.String type) Sets the work item type.
void	setTypeLabel(java.lang.String typeLabel) Set the display label for the workitem type attribute.
void	setUrlHandlerClass(java.lang.String urlhandler) Sets the class name used to handle the URL construction for the fields that are configured as web reference.

Methods inherited from class oracle.alm.connector.data.RowDef

getDataSource, getFieldDefs, getLovDefs, setDataSource

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_TYPE_NAME

public static final java.lang.String DEFAULT_TYPE_NAME

default type of a work item definition

See Also:

Constant Field Values

webReference

protected java.util.Map<java.lang.String,java.lang.String> webReference

Constructor Detail

WorkItemDef

public WorkItemDef()

Method Detail

setName

public void setName(java.lang.String name)

Sets the name of the work item

Parameters:

name - work item name

getName

public java.lang.String getName()

Retrieves the name of work item.

Returns:

the work item name

setIdDef

public void setIdDef(java.lang.String idDef)

Sets the Id field used to uniquely identify the work item.

Parameters:

idDef - the Id to set

getIdDef

public java.lang.String getIdDef()

Retrieves the Id field used to uniquely identify the work item.

Returns:

the Id to uniquely identify the work item

setLabelDef

public void setLabelDef(java.lang.String fieldName)

Sets the workitem field name. The workitem's value will be fetched to server as the short description of the workitem editor tab.

Parameters:

labelDef - the display label to use

getLabelDef

public java.lang.String getLabelDef()

Retrieves the workitem field name. The workitem's value will be fetched to server as the short description of the workitem editor tab.

Returns:

the display label for the Id field

setSubjectDef

public void setSubjectDef(java.lang.String subjectDef)

Sets the field used as subject of the work item.

Parameters:

subjectDef - the field to use as the work item subject

getSubjectDef

public java.lang.String getSubjectDef()

Retrieves the field used as subject of the work item.

Returns:

field used as the work item subject

setType

public void setType(java.lang.String type)

Sets the work item type. Valid types can be specified using "type" tag in the <connector>def.xml file. For example: they can be "Bug", "Task", "Enhancement", or others.

Parameters:

type - the type of the work item.

getType

public java.lang.String getType()

Retrieves the work item type.

Returns:

the work item type

setCommentDef

public void setCommentDef(CommentDef cDef)

Set the work item comment definition

Parameters:

cDef - work item comment definition.

getCommentDef

public CommentDef getCommentDef()

Retrieves the work item comment definition.

Returns:

the comment definition for the work item

setUrlHandlerClass

public void setUrlHandlerClass(java.lang.String urlhandler)

Sets the class name used to handle the URL construction for the fields that are configured as web reference.

Parameters:

urlhandler - name of the class that handles the URL construction

getUrlHandlerClass

public java.lang.String getUrlHandlerClass()

Retrieves the class name used to handle the URL construction for the fields that are configured as web reference.

Returns:

class name for web URL handling

setFeatureHandlerClass

public void setFeatureHandlerClass(java.lang.String featureHandler)

getFeatureHandlerClass

public java.lang.String getFeatureHandlerClass()

addWebReferenceEntry

public void addWebReferenceEntry(java.lang.String name,
                        java.lang.String anchor)

Adds a web reference entry for a work item field.

Parameters:

name - name of the work item field

anchor - the anchor on which the web reference will act on. Valid values are "value", 'label", and "icon"

getWebReferences

public java.util.Map<java.lang.String,java.lang.String> getWebReferences()

Retrieves the web references used by the work item.

Returns:

the list of web references

getDataSourceDefs

public java.util.Map<java.lang.String,DataSourceDef> getDataSourceDefs()

Retrieves data sources used by the work item.

Returns:

list data sources defined in the work item model or meta data file.

getRepositoryDef

public RepositoryDef getRepositoryDef()

Retrieves definition of a parent repository.

Returns:

an instance of RepositoryDef

setRepositoryDef

public void setRepositoryDef(RepositoryDef reposDef)

Sets definition of a parent repository.

Parameters:

reposDef - RepositoryDef object which may contain other work items

setSupportSearchById

public void setSupportSearchById(boolean supportSearchByID)

Sets a flag indicating if the work item supports "Search by ID" feature.

Parameters:

supportSearchByID - set to true if the work item supports the feature.

isSupportSearchById

public boolean isSupportSearchById()

Retrieves a flag to determine if the work item supports "Search by ID" feature.

Returns:

true if the feature is supported, else false

setSupportWorkItemCreation

public void setSupportWorkItemCreation(boolean supportWorkItemCreation)

Sets a flag indicating if a work item creation is supported.

Parameters:

supportWorkItemCreation - set to true if the work item creation is supported.

isSupportWorkItemCreation

public boolean isSupportWorkItemCreation()

Retrieves a flag to determine if work item creation is supported.

Returns:

true if work item creation is supported, else false

setIDLabel

public void setIDLabel(java.lang.String sLabel)

Deprecated. Obsoleted, use setLabelDef() instead

Sets the display label for a tab on the work item detail editor window. This label corresponds to an attribute called "id-label" in the <connector>def.xml file.

Parameters:

sLabel - the text to display on the tab of the work item detail editor window

getIDLabel

public java.lang.String getIDLabel()

Deprecated. Obsoleted, use getLabelDef() instead

Retrieves the display label for a tab on the work item detail editor window as specified by an attribute called "id-label" in the the <connector>def.xml file.

Returns:

text used as display label for the tab on the work item detail editor window

setTypeLabel

public void setTypeLabel(java.lang.String typeLabel)

Set the display label for the workitem type attribute.

Parameters:

typeLabel - the String value serving as the label of the workitem type, in TPC UI, it will shown in the repository context menu.

getTypeLabel

public java.lang.String getTypeLabel()

Retrieve the display label for the workitem type attribute.

Returns:

the string value serving as the label of the workitem type, in TPC UI, it will shown in the repository context menu.

createNew

public WorkItemDef createNew()

Constructs a new instance of WorkItemDef from the current instance.

Returns:

a WorkItemDef object