TopicInput value object

The TopicInput value object has the required name field for the topic name and optional parameters.

  • projectName—Name to categorize the topic (required if newProject is true), with a maximum length of 255 characters.
  • description—Optional description, with a maximum length of 2000 characters.
  • workteams—A list of work team names.
  • newProject—A boolean set to true to create new project.
  • templateId—ID for the topic template.

Any optional values must be set to null if they are not defined otherwise.

The server creates the topic with a default initial state but no values are set for any topics fields. Topic names are not unique. If a topic is created with the same name as an existing topic, the user might see multiple topics with the same name in the topic drop-down list. A user can display the Select Topic dialog box to distinguish between different topics with the same name by viewing other fields associated with the topic.

If specified, the templateId field should have the ID of the topic template from the user's selection and is available from the TopicTemplateContext. If the user does not select a topic template, set the template ID to null.

If you do choose not to support projects in your user interface or do not display the project drop-down list, then if the user creates a topic, you must set the projectName field to Unassigned.

class TopicInput {
 String name;
 String projectName;
 String description;
 String[] workteams;
 boolean newProject;
 Long templateId;
}