com.ibm.team.workitem.common.model

Interface IAttribute

All Superinterfaces:

IAttributeHandle, IAuditable, IAuditableHandle, IItem, IItemHandle, IManagedItem, IManagedItemHandle, IProjectScoped

public interface IAttribute
extends IAttributeHandle, IAuditable, IProjectScoped

An attribute of a work item. Both built-in and custom attributes of work items are represented as IAttributes in the repository. An IAttribute is scoped to a project area, carries meta-data like the data-type and can be used to access the values of work items in the same project area.

Since:

0.5

See Also:

IWorkItem.getValue(IAttribute), IWorkItem.getCustomAttributes(), IWorkItemCommon.findAttributes(IProjectAreaHandle, IProgressMonitor), IWorkItemCommon.createNewAttribute(IProjectAreaHandle, String, String, String, IProgressMonitor)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	BUILT_IN_PROPERTY The built-in property, see isBuiltIn().
static ItemProfile<IAttribute>	DEFAULT_PROFILE
static java.lang.String	DEPENDENCIES_PROPERTY The dependencies property, see getDependencies().
static java.lang.String	DISPLAY_NAME_PROPERTY The name property, see getDisplayName().
static java.lang.String	EXTERNAL_URI_PROPERTY The name property, see getExternalURI().
static ItemProfile<IAttribute>	FULL_PROFILE The full item profile.
static java.lang.String	FULL_TEXT_KIND_CONTENT See ISearchableFields.CONTENT.
static java.lang.String	FULL_TEXT_KIND_DEFAULT Place-holder when creating an attribute for the type-dependent default full-text kind.
static java.lang.String	FULL_TEXT_KIND_ID See ISearchableFields.ID.
static java.lang.String	FULL_TEXT_KIND_META See ISearchableFields.META.
static java.lang.String	FULL_TEXT_KIND_NAME See ISearchableFields.NAME.
static java.lang.String	FULL_TEXT_KIND_NONE Full-text kind indicating that no full-text indexing of this attribute should be done.
static java.lang.String	FULL_TEXT_KIND_PROPERTY The full-text kind property, see getFullTextKind().
static java.lang.String	FULL_TEXT_KIND_TAGS See ISearchableFields.TAGS.
static java.lang.String	IDENTIFIER_PROPERTY The identifier property, see getIdentifier().
static java.lang.String	INTERNAL_PROPERTY The internal property, see isInternal().
static IItemType	ITEM_TYPE The attribute item type.
static ItemProfile<IAttribute>	LARGE_PROFILE
static ItemProfile<IAttribute>	MEDIUM_PROFILE
static java.lang.String	PROJECT_AREA_PROPERTY The project area property, see getProjectArea().
static java.lang.String	READ_ONLY_PROPERTY The read-only property, see isReadOnly().
static ItemProfile<IAttribute>	SMALL_PROFILE
static java.lang.String	TYPE_PROPERTY The type property, see getAttributeType().

Fields inherited from interface com.ibm.team.repository.common.IAuditable

MERGE_PREDECESSOR_STATE_PROPERTY, PREDECESSOR_STATE_PROPERTY

Fields inherited from interface com.ibm.team.repository.common.IItem

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAttributeType() Returns the type identifier.
java.lang.Object	getDefaultValue(IAuditableCommon auditableCommon, IWorkItem workItem, org.eclipse.core.runtime.IProgressMonitor monitor) Returns the default value of this attribute.
java.util.List<IAttributeHandle>	getDependencies() Returns a list of attributes this attribute depends on.
java.lang.String	getDisplayName() Returns the name suitable for presenting it as part of a label to the user.
java.lang.String	getExternalURI() Returns the external URI.
java.lang.String	getFullTextKind() The full-text kind determines if and how values of this attribute should be indexed in the full-text index.
java.lang.String	getIdentifier() Returns the identifier, unique within a project area.
java.lang.Object	getNullValue(IAuditableCommon auditableCommon) Deprecated. add IProgressMonitor as last parameter
java.lang.Object	getNullValue(IAuditableCommon auditableCommon, org.eclipse.core.runtime.IProgressMonitor monitor) Returns the null value of this attribute.
IProjectAreaHandle	getProjectArea() Returns the project area this attribute belongs to.
java.lang.Object	getValue(IAuditableCommon auditableCommon, IWorkItem workItem, org.eclipse.core.runtime.IProgressMonitor monitor) Returns the current -- calculated -- value of this attribute.
java.lang.Object[]	getValueSet(IAuditableCommon auditableCommon, IWorkItem workItem) Deprecated. add IProgressMonitor as last parameter
java.lang.Object[]	getValueSet(IAuditableCommon auditableCommon, IWorkItem workItem, boolean includeArchived, org.eclipse.core.runtime.IProgressMonitor monitor) Returns a list of valid values for this attribute on the given work item.
java.lang.Object[]	getValueSet(IAuditableCommon auditableCommon, IWorkItem workItem, org.eclipse.core.runtime.IProgressMonitor monitor) Returns a list of valid values for this attribute on the given work item.
java.lang.Object[]	getValueSet(com.ibm.team.workitem.common.internal.attributeValueProviders.IValueSetProvider2.ValueSetProviderInput input, org.eclipse.core.runtime.IProgressMonitor monitor) Returns a list of valid values for this attribute on the given work item.
boolean	hasCalculatedValue(IAuditableCommon auditableCommon, org.eclipse.core.runtime.IProgressMonitor monitor) Returns true if this attribute has a calculated value provider.
boolean	hasValueSet(IAuditableCommon auditableCommon, org.eclipse.core.runtime.IProgressMonitor monitor) Returns true if this attribute can have a value set.
boolean	isBuiltIn() Returns true iff all work items have this attribute and it cannot be removed from work items.
boolean	isInternal() Returns true iff this attribute is an implementation detail and it and its value should not be shown to the user.
boolean	isReadOnly() Returns true iff a work item's value of this attribute cannot be changed by a client, the system may still update the value.
void	setAttributeType(java.lang.String value) Deprecated. immutable
void	setDisplayName(java.lang.String value) Sets the name to the given value.
void	setExternalURI(java.lang.String value) Sets the external URI to the given value.
void	setIdentifier(java.lang.String value) Deprecated. immutable
void	setInternal(boolean isInternal) Sets the internal flag to the given value.
org.eclipse.core.runtime.IStatus	validate(IAuditableCommon auditableCommon, IWorkItem workItem, org.eclipse.core.runtime.IProgressMonitor monitor) Validates the value of this attribute in the context of a work item.

Methods inherited from interface com.ibm.team.repository.common.IAuditable

getMergePredecessorState, getPredecessorState

Methods inherited from interface com.ibm.team.repository.common.IManagedItem

isNewItem

Methods inherited from interface com.ibm.team.repository.common.IItem

getContextId, getItemHandle, getModifiedBy, getRedactedCopy, getRequestedModified, getRequestedStateId, getStateHandle, getWorkingCopy, hasHistory, isComplete, isPropertySet, isRedactedCopy, isWorkingCopy, modified, setContextId, setRequestedModified, setRequestedStateId

Methods inherited from interface com.ibm.team.repository.common.IItemHandle

equals, getAdapter, getFullState, getItemId, getItemType, getOrigin, getStateId, hasFullState, hasStateId, isAuditable, isConfigurationAware, isImmutable, isSimple, isUnmanaged, makeImmutable, protect, sameItemId, sameStateId, size

Field Detail

ITEM_TYPE

static final IItemType ITEM_TYPE

The attribute item type.

PROJECT_AREA_PROPERTY

static final java.lang.String PROJECT_AREA_PROPERTY

The project area property, see getProjectArea().

IDENTIFIER_PROPERTY

static final java.lang.String IDENTIFIER_PROPERTY

The identifier property, see getIdentifier().

TYPE_PROPERTY

static final java.lang.String TYPE_PROPERTY

The type property, see getAttributeType().

DISPLAY_NAME_PROPERTY

static final java.lang.String DISPLAY_NAME_PROPERTY

The name property, see getDisplayName().

EXTERNAL_URI_PROPERTY

static final java.lang.String EXTERNAL_URI_PROPERTY

The name property, see getExternalURI().

DEPENDENCIES_PROPERTY

static final java.lang.String DEPENDENCIES_PROPERTY

The dependencies property, see getDependencies().

BUILT_IN_PROPERTY

static final java.lang.String BUILT_IN_PROPERTY

The built-in property, see isBuiltIn().

READ_ONLY_PROPERTY

static final java.lang.String READ_ONLY_PROPERTY

The read-only property, see isReadOnly().

INTERNAL_PROPERTY

static final java.lang.String INTERNAL_PROPERTY

The internal property, see isInternal().

FULL_TEXT_KIND_PROPERTY

static final java.lang.String FULL_TEXT_KIND_PROPERTY

The full-text kind property, see getFullTextKind().

FULL_TEXT_KIND_DEFAULT

static final java.lang.String FULL_TEXT_KIND_DEFAULT

Place-holder when creating an attribute for the type-dependent default full-text kind.

FULL_TEXT_KIND_NONE

static final java.lang.String FULL_TEXT_KIND_NONE

Full-text kind indicating that no full-text indexing of this attribute should be done.

See Also:

Constant Field Values

FULL_TEXT_KIND_ID

static final java.lang.String FULL_TEXT_KIND_ID

See ISearchableFields.ID.

See Also:

Constant Field Values

FULL_TEXT_KIND_NAME

static final java.lang.String FULL_TEXT_KIND_NAME

See ISearchableFields.NAME.

See Also:

Constant Field Values

FULL_TEXT_KIND_CONTENT

static final java.lang.String FULL_TEXT_KIND_CONTENT

See ISearchableFields.CONTENT.

See Also:

Constant Field Values

FULL_TEXT_KIND_TAGS

static final java.lang.String FULL_TEXT_KIND_TAGS

See ISearchableFields.TAGS.

See Also:

Constant Field Values

FULL_TEXT_KIND_META

static final java.lang.String FULL_TEXT_KIND_META

See ISearchableFields.META.

See Also:

Constant Field Values

SMALL_PROFILE

static final ItemProfile<IAttribute> SMALL_PROFILE

DEFAULT_PROFILE

static final ItemProfile<IAttribute> DEFAULT_PROFILE

MEDIUM_PROFILE

static final ItemProfile<IAttribute> MEDIUM_PROFILE

LARGE_PROFILE

static final ItemProfile<IAttribute> LARGE_PROFILE

FULL_PROFILE

static final ItemProfile<IAttribute> FULL_PROFILE

The full item profile.

Method Detail

getProjectArea

IProjectAreaHandle getProjectArea()

Returns the project area this attribute belongs to. Only work items of the same project area can have this attribute.

Specified by:

getProjectArea in interface IProjectScoped

Returns:

the project area

getIdentifier

java.lang.String getIdentifier()

Returns the identifier, unique within a project area.

Returns:

the identifier

setIdentifier

@Deprecated
void setIdentifier(java.lang.String value)

Deprecated. immutable

getAttributeType

java.lang.String getAttributeType()

Returns the type identifier.

Returns:

the type identifier

See Also:

AttributeTypes

setAttributeType

@Deprecated
void setAttributeType(java.lang.String value)

Deprecated. immutable

getDisplayName

java.lang.String getDisplayName()

Returns the name suitable for presenting it as part of a label to the user.

Returns:

the name

setDisplayName

void setDisplayName(java.lang.String value)

Sets the name to the given value.

Parameters:

value - the new name

getExternalURI

java.lang.String getExternalURI()

Returns the external URI.

Returns:

the external URI

setExternalURI

void setExternalURI(java.lang.String value)

Sets the external URI to the given value.

Parameters:

value - the new external URI

getDependencies

java.util.List<IAttributeHandle> getDependencies()

Returns a list of attributes this attribute depends on.

Returns:

the list of dependencies

getNullValue

java.lang.Object getNullValue(IAuditableCommon auditableCommon,
                            org.eclipse.core.runtime.IProgressMonitor monitor)
                              throws TeamRepositoryException

Returns the null value of this attribute.

Parameters:

auditableCommon - the common auditable library

monitor - a progress monitor or null

Returns:

the null value

Throws:

TeamRepositoryException - if anything goes wrong

getDefaultValue

java.lang.Object getDefaultValue(IAuditableCommon auditableCommon,
                               IWorkItem workItem,
                               org.eclipse.core.runtime.IProgressMonitor monitor)
                                 throws TeamRepositoryException

Returns the default value of this attribute. The default value is used to initialize the attribute on a work item.

Parameters:

auditableCommon - the common auditable library

monitor - a progress monitor or null

Returns:

the default value

Throws:

TeamRepositoryException - if anything goes wrong

getValue

java.lang.Object getValue(IAuditableCommon auditableCommon,
                        IWorkItem workItem,
                        org.eclipse.core.runtime.IProgressMonitor monitor)
                          throws TeamRepositoryException

Returns the current -- calculated -- value of this attribute.

Parameters:

auditableCommon - the common auditable library

monitor - a progress monitor or null

Returns:

the current value

Throws:

TeamRepositoryException - if anything goes wrong

hasCalculatedValue

boolean hasCalculatedValue(IAuditableCommon auditableCommon,
                         org.eclipse.core.runtime.IProgressMonitor monitor)
                           throws TeamRepositoryException

Returns true if this attribute has a calculated value provider.

Parameters:

auditableCommon - the common auditable library

monitor - a progress monitor or null

Returns:

True if there is a calculated value provider for this attribute. False otherwise.

Throws:

TeamRepositoryException - if anything goes wrong

hasValueSet

boolean hasValueSet(IAuditableCommon auditableCommon,
                  org.eclipse.core.runtime.IProgressMonitor monitor)
                    throws TeamRepositoryException

Returns true if this attribute can have a value set.

Parameters:

auditableCommon - the common auditable library

monitor - a progress monitor or null

Returns:

False if getValueSet(IAuditableCommon, IWorkItem) always returns an empty value set. True otherwise.

Throws:

TeamRepositoryException - if anything goes wrong

getValueSet

java.lang.Object[] getValueSet(IAuditableCommon auditableCommon,
                             IWorkItem workItem,
                             org.eclipse.core.runtime.IProgressMonitor monitor)
                               throws TeamRepositoryException

Returns a list of valid values for this attribute on the given work item. The list will include archived values.

Parameters:

auditableCommon - the common auditable library

workItem - the work item

monitor - a progress monitor or null

Returns:

a list of valid values

Throws:

TeamRepositoryException - if anything goes wrong

getValueSet

java.lang.Object[] getValueSet(IAuditableCommon auditableCommon,
                             IWorkItem workItem,
                             boolean includeArchived,
                             org.eclipse.core.runtime.IProgressMonitor monitor)
                               throws TeamRepositoryException

Returns a list of valid values for this attribute on the given work item.

Parameters:

auditableCommon - the common auditable library

workItem - the work item

includeArchived - if true, will also return values that have been archived and false to ignore those.

monitor - a progress monitor or null

Returns:

a list of valid values

Throws:

TeamRepositoryException - if anything goes wrong

getValueSet

java.lang.Object[] getValueSet(com.ibm.team.workitem.common.internal.attributeValueProviders.IValueSetProvider2.ValueSetProviderInput input,
                             org.eclipse.core.runtime.IProgressMonitor monitor)
                               throws TeamRepositoryException

Returns a list of valid values for this attribute on the given work item.

Parameters:

input - a set of parameters passed to the value set provider

monitor - a progress monitor or null

Returns:

a list of valid values

Throws:

TeamRepositoryException - if anything goes wrong

validate

org.eclipse.core.runtime.IStatus validate(IAuditableCommon auditableCommon,
                                        IWorkItem workItem,
                                        org.eclipse.core.runtime.IProgressMonitor monitor)
                                          throws TeamRepositoryException

Validates the value of this attribute in the context of a work item.

Parameters:

workItem - the work item

Returns:

a status with a severity and a message if the status is not OK

Throws:

TeamRepositoryException

isBuiltIn

boolean isBuiltIn()

Returns true iff all work items have this attribute and it cannot be removed from work items.

Returns:

true iff the attribute is built-in

isReadOnly

boolean isReadOnly()

Returns true iff a work item's value of this attribute cannot be changed by a client, the system may still update the value.

Returns:

true iff this attribute is read-only

isInternal

boolean isInternal()

Returns true iff this attribute is an implementation detail and it and its value should not be shown to the user.

Returns:

true iff this attribute is internal

setInternal

void setInternal(boolean isInternal)

Sets the internal flag to the given value.

Parameters:

isInternal - the new value

getFullTextKind

java.lang.String getFullTextKind()

The full-text kind determines if and how values of this attribute should be indexed in the full-text index.

Returns:

the full-text kind

getValueSet

@Deprecated
java.lang.Object[] getValueSet(IAuditableCommon auditableCommon,
                                        IWorkItem workItem)
                               throws TeamRepositoryException

Deprecated. add IProgressMonitor as last parameter

Throws:

TeamRepositoryException

getNullValue

@Deprecated
java.lang.Object getNullValue(IAuditableCommon auditableCommon)
                              throws TeamRepositoryException

Deprecated. add IProgressMonitor as last parameter

Throws:

TeamRepositoryException