CollectionSet (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.prefs.BaseManager
- - com.canto.cumulus.prefs.CollectionSet

All Implemented Interfaces:

Item
```
public class CollectionSet
extends BaseManager
implements Item
```
This class manages the settings of a collection set.

Nested Class Summary
- Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager
  BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COMMAND_OPEN_COLLECTION
- Fields inherited from class com.canto.cumulus.prefs.BaseManager
  TYPE_EJP, TYPE_NATIVE

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COMMAND_OPEN_COLLECTION`

Method Summary

Methods
Modifier and Type	Method and Description
`JPack`	`exportSet()` Exports this set into a `JPack`.
`java.util.Set<java.lang.String>`	`getCatalogLocations()` Get the list of catalogs that this collection contains records from.
`CollectionType`	`getCollectionType()` Returns the collection type of this collection.
`java.lang.String`	`getCreatingUserUID()` Returns the user unique ID of the user who created this collection.
`java.util.Date`	`getCreationDate()` Returns the date when this collection set was created.
`CustomData`	`getCustomData()` Returns the custom data for this collection set.
`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.
`boolean`	`getIsDefault()` Returns whether this is the default collection set.
`java.lang.String`	`getLinkedCollection()` Returns the name of the collection set this linked collection set points to.
`java.util.Date`	`getModificationDate()` Returns the date when this collection set was modified last.
`java.lang.String`	`getName()` Returns the name of this collection.
`java.net.URI`	`getOpenCollectionURI(Server server)` Returns an URI for this collection which will make the locally installed native client application open this collection.
`RestrictionsList`	`getRestrictionsList()` Returns the list of roles and users that are allowed to view this set.
`boolean`	`isAutoCollection()` Returns whether this is an auto collection.
`boolean`	`isCollectionBasketCollection()` Returns whether this is an collection basket collection.
`boolean`	`isDefault()` Returns whether this item is the default item.
`boolean`	`isLinkedCollection()` Returns whether this collection set is a link collection set that points to another collection set.
`boolean`	`isPINCollection()` Returns whether this is a PIN collection.
`boolean`	`isSharingRestricted()` Returns whether the set visibility is restricted to a group of users or roles.
`boolean`	`isUploadCollection()` Returns whether this is a collection set for an upload collection.
`boolean`	`isUserCollection()` Returns whether this is a user created collection set (no auto or collection basket collection).
`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`	`setModificationDate(java.util.Date modificationDate)` Set the date when this collection was modified last.
`void`	`setSharingRestricted(boolean value)` Sets whether the set visibility is restricted to a group of users or roles.

Methods inherited from class com.canto.cumulus.prefs.BaseManager
addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

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

- Field Detail
  - COMMAND_OPEN_COLLECTION
```
public static final java.lang.String COMMAND_OPEN_COLLECTION
```
    See Also:
    Constant Field Values
- Method Detail
  - isAutoCollection
```
public boolean isAutoCollection()
```
    Returns whether this is an auto collection.
    
    Returns:
    true if this is an auto collection
  - isCollectionBasketCollection
```
public boolean isCollectionBasketCollection()
```
    Returns whether this is an collection basket collection.
    
    Returns:
    true if this is an collection basket collection
  - isPINCollection
```
public boolean isPINCollection()
```
    Returns whether this is a PIN collection.
    
    Returns:
    true if this is a PIN collection
    Since:
    
    8.1
  - isUserCollection
```
public boolean isUserCollection()
```
    Returns whether this is a user created collection set (no auto or collection basket collection).
    
    Returns:
    true if this is a user created collection set
  - isUploadCollection
```
public boolean isUploadCollection()
```
    Returns whether this is a collection set for an upload collection.
    
    Returns:
    true if this is a collection set for an upload collection
    Since:
    
    9.0
  - getCollectionType
```
public CollectionType getCollectionType()
```
    Returns the collection type of this collection.
    
    Returns:
    type of this collection
    Since:
    
    9.0
  - getName
```
public java.lang.String getName()
```
    Returns the name of this collection.
    
    Returns:
    name of this collection
  - getIsDefault
```
public boolean getIsDefault()
```
    Returns whether this is the default collection set.
    
    Returns:
    true if this is the default collection set
  - isLinkedCollection
```
public boolean isLinkedCollection()
```
    Returns whether this collection set is a link collection set that points to another collection set.
    
    Returns:
    true if this is a linked collection set
  - getLinkedCollection
```
public java.lang.String getLinkedCollection()
```
    Returns the name of the collection set this linked collection set points to.
    
    Returns:
    the name of the linked collection set or null
  - getCustomData
```
public CustomData getCustomData()
```
    Returns the custom data for this collection set.
    
    Returns:
    8.5
  - getOpenCollectionURI
```
public java.net.URI getOpenCollectionURI(Server server)
```
    Returns an URI for this collection which will make the locally installed native client application open this collection.
    
    Parameters:
    server - server for this collection
    
    Returns:
    URI
    Since:
    
    8.6
  - getID
```
public java.lang.String getID()
```
    Description copied from interface: Item
    
    Returns the UID of the item in the items namespace.
    
    Specified by:
    
    getID in interface Item
    
    Returns:
    item UID
  - isDefault
```
public boolean isDefault()
```
    Description copied from interface: Item
    
    Returns whether this item is the default item.
    
    Specified by:
    
    isDefault in interface Item
    
    Returns:
    true if this is the default item
  - getDescription
```
public java.lang.String getDescription(int languageID)
```
    Returns the description for the given language id.
    
    Specified by:
    
    getDescription in interface Item
    
    Parameters:
    languageID - specifying the language for the description
    
    Returns:
    description text
    Since:
    
    8.6.1
  - setDescription
```
public void setDescription(int languageID,
                  java.lang.String description)
```
    Sets the description for the given language.
    
    Specified by:
    
    setDescription in interface Item
    
    Parameters:
    languageID - the language to set the description for
    description - the new description
    Since:
    
    8.6.1
  - getDisplayName
```
public java.lang.String getDisplayName(int languageID,
                              boolean fallbackToDefaultName)
```
    Returns the display name for the given language id.
    
    Specified by:
    
    getDisplayName in interface Item
    
    Parameters:
    languageID - specifying the language for the display name
    fallbackToDefaultName - when set to true this method returns the default name when no localized display name is available otherwise null
    
    Returns:
    display name
    Since:
    
    8.6.1
  - setDisplayName
```
public void setDisplayName(int languageID,
                  java.lang.String displayName)
```
    Sets the display name for the given language.
    
    Specified by:
    
    setDisplayName in interface Item
    
    Parameters:
    languageID - the language to set the display name for
    displayName - the new display name
    Since:
    
    8.5
  - getCatalogLocations
```
public java.util.Set<java.lang.String> getCatalogLocations()
```
    Get the list of catalogs that this collection contains records from.
    
    Returns:
    The list of catalogs by their location string. Use the Server.getCatalogIDs(boolean, boolean) and Server.getCatalogInfo(int) to get the location of a catalog currently opened at the server.
    Since:
    
    9.2.1
  - exportSet
```
public JPack exportSet()
```
    Exports this set into a JPack.
    
    Specified by:
    
    exportSet in interface Item
    
    Returns:
    exported data as JPack
    Since:
    
    8.6.1
    
    See Also:
    MetadataTemplatesList.importSet(com.canto.cumulus.utils.JPack, SetImportDuplicatesMode)
  - isSharingRestricted
```
public boolean isSharingRestricted()
```
    Returns whether the set visibility is restricted to a group of users or roles.
    
    Specified by:
    
    isSharingRestricted in interface Item
    
    Returns:
    true if the set visibility is restricted to a group of users or roles
    Since:
    
    8.6.1
  - setSharingRestricted
```
public void setSharingRestricted(boolean value)
```
    Sets whether the set visibility is restricted to a group of users or roles.
    
    Specified by:
    
    setSharingRestricted in interface Item
    
    Parameters:
    value - set to true if the set visibility should be restricted to a group of users or roles
    Since:
    
    8.6.1
  - getRestrictionsList
```
public RestrictionsList getRestrictionsList()
```
    Returns the list of roles and users that are allowed to view this set. Only applicable for shared set and if isSharingRestricted() returns true.
    
    Specified by:
    
    getRestrictionsList in interface Item
    
    Returns:
    list of roles and users that are allowed to view this set
    Since:
    
    8.6.1
  - getCreationDate
```
public java.util.Date getCreationDate()
```
    Returns the date when this collection set was created. If the information is missing (collections created prior to 9.1) null is returned.
    
    Returns:
    The creation date
    Since:
    
    9.1
  - getModificationDate
```
public java.util.Date getModificationDate()
```
    Returns the date when this collection set was modified last. If the information is missing (collections created prior to 9.1) null is returned.
    
    Returns:
    The modification date
    Since:
    
    9.1
  - setModificationDate
```
public void setModificationDate(java.util.Date modificationDate)
```
    Set the date when this collection was modified last. It may be necessary to set this explicitly as assets are assigned to upload collections by an asset record field value.
    
    Parameters:
    modificationDate - The modification date
    Since:
    
    10.0
  - getCreatingUserUID
```
public java.lang.String getCreatingUserUID()
```
    Returns the user unique ID of the user who created this collection. If the information is missing (collections created prior to 10.0) null is returned.
    
    Returns:
    The unique ID of the creating user
    Since:
    
    10.0

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 CollectionSet

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

Method Summary

Methods inherited from class com.canto.cumulus.prefs.BaseManager

Methods inherited from class java.lang.Object

Field Detail

COMMAND_OPEN_COLLECTION

Method Detail

isAutoCollection

isCollectionBasketCollection

isPINCollection

isUserCollection

isUploadCollection

getCollectionType

getName

getIsDefault

isLinkedCollection

getLinkedCollection

getCustomData

getOpenCollectionURI

getID

isDefault

getDescription

setDescription

getDisplayName

setDisplayName

getCatalogLocations

exportSet

isSharingRestricted

setSharingRestricted

getRestrictionsList

getCreationDate

getModificationDate

setModificationDate

getCreatingUserUID