MultiLayout (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.MultiLayout

```
public class MultiLayout
extends java.lang.Object
```
This class tries to offer the same functionality as a normal Layout while working on multiple catalogs. This class makes no guarantees which catalog will generate the FieldDefinition objects which are returned by some of the implemented methods.

Since:

9.0

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object o)` Compares this layout to the specified object.
`CumulusSession`	`getCumulusSession()` Returns the current `CumulusSession` object.
`FieldDefinition`	`getFieldDefinition(GUID fieldUID)` Returns the `FieldDefinition` for the specified `fieldUID` or throws an Exception if that field is not contained in this layout (read: in any of the catalogs of the `MultiItemCollection`).
`java.util.Map<java.lang.Integer,FieldDefinition>`	`getFieldDefinitions(GUID fieldUID)` Returns the `FieldDefinition` instances for the specified `fieldUID` of all catalogs.
`java.util.Set<GUID>`	`getFieldUIDs()` Returns the set of field `UIDs` that are contained in this layout.
`java.util.Set<GUID>`	`getFieldUIDs(boolean includeVirtualFieldUIDs)` Returns the set of field `UIDs` that are contained in this layout.
`java.util.Set<GUID>`	`getFieldUIDs(boolean includeVirtualFieldUIDs, boolean inAllCatalogs)` Returns the set of field `UIDs` that are contained in this layout.
`java.lang.String`	`getTableName()` Returns the table name of the table of this layout.
`boolean`	`hasFieldDefinition(GUID fieldUID)` Returns whether the field with the specified `UID` is contained in this layout (read: in any of the catalog layouts of this `MultiItemCollection`.
`boolean`	`hasFieldDefinition(GUID fieldUID, boolean inAllCatalogs)` Returns whether the field with the specified `UID` is contained in this layout.
`int`	`hashCode()`
`java.util.Iterator<FieldDefinition>`	`iterator()` Return an iterator that iterates over all `field definitions` of this collection.

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

- Method Detail
  - getFieldUIDs
```
public java.util.Set<GUID> getFieldUIDs()
```
    Returns the set of field UIDs that are contained in this layout.
    
    Returns:
    set of field UIDs without virtual field UIDs for base fields of multiple languages fields
    Since:
    
    9.0
  - getFieldUIDs
```
public java.util.Set<GUID> getFieldUIDs(boolean includeVirtualFieldUIDs)
```
    Returns the set of field UIDs that are contained in this layout.
    
    Parameters:
    includeVirtualFieldUIDs - whether the virtual field UID for the base language of a multiple languages field should be included
    
    Returns:
    set of field UIDs
    Since:
    
    9.0
  - getFieldUIDs
```
public java.util.Set<GUID> getFieldUIDs(boolean includeVirtualFieldUIDs,
                               boolean inAllCatalogs)
```
    Returns the set of field UIDs that are contained in this layout.
    
    Parameters:
    includeVirtualFieldUIDs - whether the virtual field UID for the base language of a multiple languages field should be included
    inAllCatalogs - true if only fields available in all catalogs should be returned
    
    Returns:
    set of field UIDs
    Since:
    
    9.2
  - hasFieldDefinition
```
public boolean hasFieldDefinition(GUID fieldUID)
```
    Returns whether the field with the specified UID is contained in this layout (read: in any of the catalog layouts of this MultiItemCollection.
    
    Parameters:
    fieldUID - the UID of the field
    
    Returns:
    true if the field with the specified UID is contained in this layout
    Since:
    
    9.0
  - hasFieldDefinition
```
public boolean hasFieldDefinition(GUID fieldUID,
                         boolean inAllCatalogs)
```
    Returns whether the field with the specified UID is contained in this layout.
    
    Parameters:
    fieldUID - the UID of the field
    inAllCatalogs - true if the field should exist in all catalogs
    
    Returns:
    true if the field with the specified UID is contained in this layout
    Since:
    
    9.2
  - getFieldDefinition
```
public FieldDefinition getFieldDefinition(GUID fieldUID)
                                   throws InvalidArgumentException
```
    Returns the FieldDefinition for the specified fieldUID or throws an Exception if that field is not contained in this layout (read: in any of the catalogs of the MultiItemCollection).
    
    Parameters:
    fieldUID - the field to get the FieldDefinition for
    
    Returns:
    the FieldDefinition for the specified fieldUID
    
    Throws:
    
    InvalidArgumentException - if the given fieldUID is not valid for this layout
    Since:
    
    9.0
  - getFieldDefinitions
```
public java.util.Map<java.lang.Integer,FieldDefinition> getFieldDefinitions(GUID fieldUID)
                                                                     throws InvalidArgumentException
```
    Returns the FieldDefinition instances for the specified fieldUID of all catalogs.
    
    Parameters:
    fieldUID - the field to get the FieldDefinition for
    
    Returns:
    the FieldDefinition for the specified fieldUID
    
    Throws:
    
    InvalidArgumentException - if the given fieldUID is not valid for this layout
    Since:
    
    9.2
  - getCumulusSession
```
public CumulusSession getCumulusSession()
```
    Returns the current CumulusSession object.
    
    Returns:
    the current CumulusSession object.
    Since:
    
    9.0
  - getTableName
```
public java.lang.String getTableName()
```
    Returns the table name of the table of this layout.
    
    Returns:
    table name of the table of this layout
    Since:
    
    9.0
  - iterator
```
public java.util.Iterator<FieldDefinition> iterator()
```
    Return an iterator that iterates over all field definitions of this collection. This includes also FieldDefinition instances which are only contained in some catalogs. This allows you to use Java 5 for-each loops that simplify your source code:
```
 for (FieldDefinition fieldDefinition : layout)
 {
    // use the fieldDefinition
 }
 
```
    The iterator returned does not support the remove operation.
    Returns:
    An iterator for all field definitions in this layout.
    Since:
    
    9.0
  - equals
```
public boolean equals(java.lang.Object o)
```
    Compares this layout to the specified object. The result is true if and only if the argument is not null and is a Layout object that represents the same layout as this object.
    
    Overrides:
    
    equals in class java.lang.Object
    
    Parameters:
    o - the object to compare
    
    Returns:
    true if the layout are equal; false otherwise.
    Since:
    
    9.0
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object

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 MultiLayout

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getFieldUIDs

getFieldUIDs

getFieldUIDs

hasFieldDefinition

hasFieldDefinition

getFieldDefinition

getFieldDefinitions

getCumulusSession

getTableName

iterator

equals

hashCode