Interface IHasCustomValues
- All Known Subinterfaces:
IApprovalStruct,IAttachment,IAttachmentBase,IBaseline,IBaselineCollection,IBaselineCollectionElement,IBuild,IBuildArtifact,IBuildDeploymentArtifact,IBuildEvent,IBuildEvents,IBuildLinkedWorkItemStruct,IBuildTestResults,ICategory,IComment,ICommentBase<T>,IDocumentWorkflowSignature,IExternallyLinkedWorkItemStruct,IFeatureSelection,IFeatureSelectionItem,IGroupEntity,IGroupUniqueObject,IHyperlinkStruct,ILinkedOslcResourceStruct,ILinkedRevisionStruct,ILinkedWorkItemStruct,IModule,IModule.IOutlineNumberingDef,IModule.IRenderingLayoutStruct,IModule.IStructureNode,IModuleAttachment,IModuleComment,IModuleComment.IImportedCommentStruct,IParameterDefinitionStruct,IParametersAndDefinitionsStruct,IParameterStruct<T>,IPlan,IPlanningConstraintStruct,IPlanRecord,IPObject,IProject,IProjectGroup,IPrototype,IRevision,IRichPage,IRichPageAttachment,IRichPageComment,IRow,IScript,ISignature,ISignatureData,IStructure,ITable,ITestRecord,ITestRun,ITestRunAttachment,ITestRunComment,ITestRunWorkflowSignature,ITestStep,ITestStepResult,ITestSteps,ITimePoint,ITrackerBuild,ITrackerProject,ITrackerRevision,ITrackerUser,IUniqueObject,IUser,IUserGroup,IWatchList,IWikiPage,IWikiPageAttachment,IWithLinkedOslcResources,IWorkflowObject,IWorkflowSignature,IWorkItem,IWorkItemWorkflowSignature,IWorkRecord
public interface IHasCustomValues
- Since:
- 3.21.1
-
Method Summary
Modifier and TypeMethodDescriptiongetCustomField(String key) Shortcut forICustomFieldsService.getCustomField(key, getProtoName(), getContextId())voidsetCustomField(String key, Object value) Sets the value of the given custom field.
-
Method Details
-
getCustomField
- Parameters:
key- The value of the given custom field ornullif no such value exists.- Throws:
IllegalArgumentException- If the key is the name of the field defined by the prototype (this tries to discover coding errors quickly)
-
setCustomField
Sets the value of the given custom field. The value type must be checked against the custom field configuration. If the field configuration does not exist, only theStringvalue is accepted.- Parameters:
key-value-
-
getCustomFieldsList
- Returns:
- Collection of
Stringnames of custom fields, which are defined for this object or exist on this object.
-
getCustomFieldPrototype
Shortcut forICustomFieldsService.getCustomField(key, getProtoName(), getContextId())- Parameters:
key-- See Also:
-