com.canto.cumulus.prefs

Interface Item

All Known Implementing Classes:

AssetAction, AssetHandlingSet, CatalogTemplate, CategoryViewSet, CollectionSet, CropTemplate, EmailClass, EmailLayout, MetadataTemplate, PermissionTemplate, PrintSet, Query, RecordFilter, RecordViewSet, Workflow

public interface Item

This interface is the base for set operations.

Method Summary

Methods

Modifier and Type	Method and Description
JPack	exportSet() Exports this item into a JPack.
java.lang.String	getDescription(int languageID) Returns the description for the given language id.
java.lang.String	getDisplayName(int languageID, boolean fallbackToDefaultName) Returns the display name for the given language id.
java.lang.String	getID() Returns the UID of the item in the items namespace.
RestrictionsList	getRestrictionsList() Returns the list of restrictions for this item.
boolean	isDefault() Returns whether this item is the default item.
boolean	isSharingRestricted() Returns whether the set visibility is restricted to a group of users or roles.
void	setDescription(int languageID, java.lang.String description) Sets the description for the given language.
void	setDisplayName(int languageID, java.lang.String displayName) Sets the display name for the given language.
void	setSharingRestricted(boolean value) Sets whether the set visibility is restricted to a group of users or roles.

Method Detail

getID

java.lang.String getID()

Returns the UID of the item in the items namespace.

Returns:

item UID

isDefault

boolean isDefault()

Returns whether this item is the default item.

Returns:

true if this is the default item

getDescription

java.lang.String getDescription(int languageID)

Returns the description for the given language id.

Parameters:

languageID - specifying the language for the description

Returns:

description text

Since:

8.0

setDescription

void setDescription(int languageID,
                  java.lang.String description)

Sets the description for the given language.

Parameters:

languageID - the language to set the description for

description - the new description

Since:

8.0

getDisplayName

java.lang.String getDisplayName(int languageID,
                              boolean fallbackToDefaultName)

Returns the display name for the given language id.

Parameters:

languageID - specifying the language for the display name

fallbackToDefaultName - when set to true this method returns the default name when now localized display name is available otherwise null

Returns:

display name

Since:

8.5

setDisplayName

void setDisplayName(int languageID,
                  java.lang.String displayName)

Sets the display name for the given language.

Parameters:

languageID - the language to set the display name for

displayName - the new display name

Since:

8.5

exportSet

JPack exportSet()

Exports this item into a JPack.

Returns:

exported data as JPack

Since:

8.1.1

isSharingRestricted

boolean isSharingRestricted()

Returns whether the set visibility is restricted to a group of users or roles.

Returns:

true if the set visibility is restricted to a group of users or roles

Since:

8.6

setSharingRestricted

void setSharingRestricted(boolean value)

Sets whether the set visibility is restricted to a group of users or roles.

Parameters:

value - set to true if the set visibility should be restricted to a group of users or roles

Since:

8.6

getRestrictionsList

RestrictionsList getRestrictionsList()

Returns the list of restrictions for this item.

Returns:

list of restrictions

Since:

8.6