com.atlassian.jira.rest.client.api.domain

Class CimFieldInfo

java.lang.Object

com.atlassian.jira.rest.client.api.domain.CimFieldInfo

All Implemented Interfaces:

IdentifiableEntity<String>, NamedEntity

public class CimFieldInfo
extends Object
implements NamedEntity, IdentifiableEntity<String>

Contains information about field in IssueType.
The CIM prefix stands for CreateIssueMetadata as this class is used in output of IssueRestClient.getCreateIssueMetadata(GetCreateIssueMetadataOptions)

Since:

v1.0

Constructor Summary

Constructors

Constructor and Description
CimFieldInfo(String id, boolean required, String name, FieldSchema schema, Set<StandardOperation> operations, Iterable<Object> allowedValues, URI autoCompleteUri)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Iterable<Object>	getAllowedValues() Returns list of values that are allowed to be used as value to this field.
URI	getAutoCompleteUri() Returns URI to Auto Complete feature for this field.
String	getId()
String	getName()
Set<StandardOperation>	getOperations() Returns set of operations allowed for this field.
FieldSchema	getSchema() Returns schema of this field that describes type of that field and contained items type.
protected com.google.common.base.Objects.ToStringHelper	getToStringHelper() Returns ToStringHelper with all fields inserted.
int	hashCode()
boolean	isRequired()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CimFieldInfo

public CimFieldInfo(String id,
            boolean required,
            @Nullable
            String name,
            FieldSchema schema,
            Set<StandardOperation> operations,
            @Nullable
            Iterable<Object> allowedValues,
            @Nullable
            URI autoCompleteUri)

Method Detail

getId

public String getId()

Specified by:

getId in interface IdentifiableEntity<String>

isRequired

public boolean isRequired()

getName

@Nullable
public String getName()

Specified by:

getName in interface NamedEntity

getSchema

public FieldSchema getSchema()

Returns schema of this field that describes type of that field and contained items type.

Returns:

schema of this field.

getOperations

public Set<StandardOperation> getOperations()

Returns set of operations allowed for this field.

Returns:

set of operations allowed for this field.

getAllowedValues

@Nullable
public Iterable<Object> getAllowedValues()

Returns list of values that are allowed to be used as value to this field.

Returns:

list of allowed values.

getAutoCompleteUri

@Nullable
public URI getAutoCompleteUri()

Returns URI to Auto Complete feature for this field. To make use of it append searched text to returned address.
Example:
URI uriToGetResponseFrom = new URI(getAutoCompleteUri() + "typedLetters");

Returns:

URI to Auto Complete feature for this field

getToStringHelper

protected com.google.common.base.Objects.ToStringHelper getToStringHelper()

Returns ToStringHelper with all fields inserted. Override this method to insert additional fields.

Returns:

ToStringHelper

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object