CategoriesFieldValue (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.fieldvalue.CategoriesFieldValue

All Implemented Interfaces:

FieldValue
```
public class CategoriesFieldValue
extends java.lang.Object
implements FieldValue
```
A field value wrapper for the category assignment of a record item. Use RecordItem.getCategoriesValue() to get this wrapper class object. You can then use RecordItem.setCategoriesValue(CategoriesFieldValue) to set the field value back into the item. You can use the wrapper object from one RecordItem to save it to another RecordItem but both have to belong to the same catalog.

Since:

8.0

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addID(int categoryID)` Add a single category assignment to the list.
`void`	`addIDs(java.util.Set<java.lang.Integer> categoryIDs)` Add category assignments to the list.
`void`	`clearValue()` Remove all category assignment.
`java.lang.String`	`getDisplayString()` Get a string to be displayed to the user.
`java.lang.String`	`getDisplayString(java.util.Locale locale)` Get a string to be displayed to the user.
`java.util.Set<java.lang.Integer>`	`getIDs()` Get the IDs of the assigned categories.
`java.util.List<java.lang.Integer>`	`getSortedIDs()` Get the IDs of the assigned categories sorted alphabetically by the category name.
`boolean`	`hasValue()` Return whether the record item has any categories assigned to it.
`void`	`removeID(int categoryID)` Remove one category assignment.
`void`	`removeIDs(java.util.Set<java.lang.Integer> categoryIDs)` Remove some category assignments.
`void`	`setFromDisplayString(java.util.Locale locale, java.lang.String value)` This method is not supported for categories.
`void`	`setFromDisplayString(java.lang.String value)` This method is not supported for categories.
`void`	`setIDs(java.util.Set<java.lang.Integer> categoryIDs)` Set the list of assigned categories.
`java.lang.String`	`toString()` Return a string representation of the assigned categories.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - hasValue
```
public boolean hasValue()
```
    Return whether the record item has any categories assigned to it.
    
    Specified by:
    
    hasValue in interface FieldValue
    
    Returns:
    true if the record item has categories assigned, false otherwise.
  - clearValue
```
public void clearValue()
```
    Remove all category assignment. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.
    
    Specified by:
    
    clearValue in interface FieldValue
  - getDisplayString
```
public java.lang.String getDisplayString()
```
    Get a string to be displayed to the user. The string is a comma separated list of category names.
    
    Specified by:
    
    getDisplayString in interface FieldValue
    
    Returns:
    A string containing all assigned categories (an empty string if it has no assigned categories).
  - getDisplayString
```
public java.lang.String getDisplayString(java.util.Locale locale)
```
    Get a string to be displayed to the user. The string is a comma separated list of category names.
    
    Specified by:
    
    getDisplayString in interface FieldValue
    
    Parameters:
    locale - This parameter is not used.
    
    Returns:
    A string containing all assigned categories (an empty string if it has no assigned categories).
  - setFromDisplayString
```
public void setFromDisplayString(java.lang.String value)
                          throws InvalidArgumentException
```
    This method is not supported for categories.
    
    Specified by:
    
    setFromDisplayString in interface FieldValue
    
    Parameters:
    value - The display string to set the value from.
    
    Throws:
    
    InvalidArgumentException - if the display string is not of the right format.
  - setFromDisplayString
```
public void setFromDisplayString(java.util.Locale locale,
                        java.lang.String value)
                          throws InvalidArgumentException
```
    This method is not supported for categories.
    
    Specified by:
    
    setFromDisplayString in interface FieldValue
    
    Parameters:
    locale - The locale to use for formatting and language selection.
    value - The display string to set the value from.
    
    Throws:
    
    InvalidArgumentException - if the display string is not of the right format.
  - getIDs
```
public java.util.Set<java.lang.Integer> getIDs()
```
    Get the IDs of the assigned categories.
    
    Returns:
    The IDs of the assigned categories.
  - getSortedIDs
```
public java.util.List<java.lang.Integer> getSortedIDs()
```
    Get the IDs of the assigned categories sorted alphabetically by the category name.
    
    Returns:
    The IDs of the assigned categories sorted alphabetically by the category name.
    Since:
    
    8.1.1
  - setIDs
```
public void setIDs(java.util.Set<java.lang.Integer> categoryIDs)
            throws InvalidArgumentException
```
    Set the list of assigned categories. It will replace the old list of assignments. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.
    
    Parameters:
    categoryIDs - The new assigned categories.
    
    Throws:
    
    InvalidArgumentException - if one of the category IDs is invalid.
  - addIDs
```
public void addIDs(java.util.Set<java.lang.Integer> categoryIDs)
            throws InvalidArgumentException
```
    Add category assignments to the list. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.
    
    Parameters:
    categoryIDs - The IDs of the categories to be added to the list of assigned categories.
    
    Throws:
    
    InvalidArgumentException - if one of the category IDs is invalid.
  - addID
```
public void addID(int categoryID)
           throws InvalidArgumentException
```
    Add a single category assignment to the list. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.
    
    Parameters:
    categoryID - The ID of the category to be added to the list of assigned categories.
    
    Throws:
    
    InvalidArgumentException - if the category ID is invalid.
  - removeID
```
public void removeID(int categoryID)
              throws InvalidArgumentException
```
    Remove one category assignment. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.
    
    Parameters:
    categoryID - The ID of the category to be removed from the assignments.
    
    Throws:
    
    InvalidArgumentException - if the category ID is invalid.
  - removeIDs
```
public void removeIDs(java.util.Set<java.lang.Integer> categoryIDs)
               throws InvalidArgumentException
```
    Remove some category assignments. You need to set the field value of an item using this field value wrapper and then call Item.save() to save this change back to the catalog.
    
    Parameters:
    categoryIDs - The IDs of the categories to be removed from the assignments.
    
    Throws:
    
    InvalidArgumentException - if one of the category IDs is invalid.
  - toString
```
public java.lang.String toString()
```
    Return a string representation of the assigned categories.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    a string representation.
    See Also:
    getDisplayString()

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class CategoriesFieldValue

Method Summary

Methods inherited from class java.lang.Object

Method Detail

hasValue

clearValue

getDisplayString

getDisplayString

setFromDisplayString

setFromDisplayString

getIDs

getSortedIDs

setIDs

addIDs

addID

removeID

removeIDs

toString