com.taskadapter.redmineapi

Class CustomFieldManager

java.lang.Object

com.taskadapter.redmineapi.CustomFieldManager

public class CustomFieldManager
extends java.lang.Object

Works with Custom Field Definitions (read-only at this moment).

Obtain it via RedmineManager:

 RedmineManager mgr = RedmineManagerFactory.createWithUserAuth(redmineURI, login, password);
 CustomFieldManager customFieldManager = mgr.getCustomFieldManager();
 List list = customFieldManager.getCustomFieldDefinitions();
 

The current version only allows loading custom fields definition from the server (Redmine v. 1 through 3). You cannot create new Custom Field definitions through Redmine REST API. Please see http://www.redmine.org/issues/9664 for details.

Sample usage:

  definitions = customFieldManager.getCustomFieldDefinitions();
 

See Also:

RedmineManager

Method Summary

Modifier and Type	Method and Description
java.util.List<CustomFieldDefinition>	getCustomFieldDefinitions() Fetch custom field definitions from server.

Methods inherited from class java.lang.Object

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

Method Detail

getCustomFieldDefinitions

public java.util.List<CustomFieldDefinition> getCustomFieldDefinitions()
                                                                throws RedmineException

Fetch custom field definitions from server.

Returns:

List of custom field definitions

Throws:

RedmineException

Since:

Redmine 2.4