Class CockpitObjectAbstractCollectionModel

All Implemented Interfaces:
Serializable
Direct Known Subclasses:
CockpitObjectCollectionModel, CockpitObjectSpecialCollectionModel

public class CockpitObjectAbstractCollectionModel extends ItemModel
Generated model class for type CockpitObjectAbstractCollection first defined at extension cockpit.
See Also:
  • Field Details

    • _TYPECODE

      public static final String _TYPECODE
      Generated model type code constant.
      See Also:
    • _USER2COCKPITOBJECTABSTRACTCOLLECTIONRELATION

      public static final String _USER2COCKPITOBJECTABSTRACTCOLLECTIONRELATION
      Generated relation code constant for relation User2CockpitObjectAbstractCollectionRelation defining source attribute user in extension cockpit.
      See Also:
    • _READPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION

      public static final String _READPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION
      Generated relation code constant for relation ReadPrincipal2CockpitObjectAbstractCollectionRelation defining source attribute readPrincipals in extension cockpit.
      See Also:
    • _WRITEPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION

      public static final String _WRITEPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION
      Generated relation code constant for relation WritePrincipal2CockpitObjectAbstractCollectionRelation defining source attribute writePrincipals in extension cockpit.
      See Also:
    • QUALIFIER

      public static final String QUALIFIER
      Generated constant - Attribute key of CockpitObjectAbstractCollection.qualifier attribute defined at extension cockpit.
      See Also:
    • LABEL

      public static final String LABEL
      Generated constant - Attribute key of CockpitObjectAbstractCollection.label attribute defined at extension cockpit.
      See Also:
    • DESCRIPTION

      public static final String DESCRIPTION
      Generated constant - Attribute key of CockpitObjectAbstractCollection.description attribute defined at extension cockpit.
      See Also:
    • USER

      public static final String USER
      Generated constant - Attribute key of CockpitObjectAbstractCollection.user attribute defined at extension cockpit.
      See Also:
    • READPRINCIPALS

      public static final String READPRINCIPALS
      Generated constant - Attribute key of CockpitObjectAbstractCollection.readPrincipals attribute defined at extension cockpit.
      See Also:
    • WRITEPRINCIPALS

      public static final String WRITEPRINCIPALS
      Generated constant - Attribute key of CockpitObjectAbstractCollection.writePrincipals attribute defined at extension cockpit.
      See Also:
    • ELEMENTS

      public static final String ELEMENTS
      Generated constant - Attribute key of CockpitObjectAbstractCollection.elements attribute defined at extension cockpit.
      See Also:
  • Constructor Details

    • CockpitObjectAbstractCollectionModel

      public CockpitObjectAbstractCollectionModel()
      Generated constructor - Default constructor for generic creation.
    • CockpitObjectAbstractCollectionModel

      public CockpitObjectAbstractCollectionModel(ItemModelContext ctx)
      Generated constructor - Default constructor for creation with existing context
      Parameters:
      ctx - the model context to be injected, must not be null
    • CockpitObjectAbstractCollectionModel

      @Deprecated(since="4.1.1", forRemoval=true) public CockpitObjectAbstractCollectionModel(String _qualifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      Generated constructor - Constructor with all mandatory attributes.
      Parameters:
      _qualifier - initial attribute declared by type CockpitObjectAbstractCollection at extension cockpit
    • CockpitObjectAbstractCollectionModel

      @Deprecated(since="4.1.1", forRemoval=true) public CockpitObjectAbstractCollectionModel(ItemModel _owner, String _qualifier)
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 4.1.1 Please use the default constructor without parameters
      Generated constructor - for all mandatory and initial attributes.
      Parameters:
      _owner - initial attribute declared by type Item at extension core
      _qualifier - initial attribute declared by type CockpitObjectAbstractCollection at extension cockpit
  • Method Details

    • getDescription

      @Accessor(qualifier="description", type=GETTER) public String getDescription()
      Generated method - Getter of the CockpitObjectAbstractCollection.description attribute defined at extension cockpit.
      Returns:
      the description
    • getDescription

      @Accessor(qualifier="description", type=GETTER) public String getDescription(Locale loc)
      Generated method - Getter of the CockpitObjectAbstractCollection.description attribute defined at extension cockpit.
      Parameters:
      loc - the value localization key
      Returns:
      the description
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language
    • getElements

      @Accessor(qualifier="elements", type=GETTER) public List<ObjectCollectionElementModel> getElements()
      Generated method - Getter of the CockpitObjectAbstractCollection.elements attribute defined at extension cockpit. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the elements
    • getLabel

      @Accessor(qualifier="label", type=GETTER) public String getLabel()
      Generated method - Getter of the CockpitObjectAbstractCollection.label attribute defined at extension cockpit.
      Returns:
      the label
    • getLabel

      @Accessor(qualifier="label", type=GETTER) public String getLabel(Locale loc)
      Generated method - Getter of the CockpitObjectAbstractCollection.label attribute defined at extension cockpit.
      Parameters:
      loc - the value localization key
      Returns:
      the label
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language
    • getQualifier

      @Accessor(qualifier="qualifier", type=GETTER) public String getQualifier()
      Generated method - Getter of the CockpitObjectAbstractCollection.qualifier attribute defined at extension cockpit.
      Returns:
      the qualifier
    • getReadPrincipals

      @Accessor(qualifier="readPrincipals", type=GETTER) public Collection<PrincipalModel> getReadPrincipals()
      Generated method - Getter of the CockpitObjectAbstractCollection.readPrincipals attribute defined at extension cockpit. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the readPrincipals
    • getUser

      @Accessor(qualifier="user", type=GETTER) public UserModel getUser()
      Generated method - Getter of the CockpitObjectAbstractCollection.user attribute defined at extension cockpit.
      Returns:
      the user
    • getWritePrincipals

      @Accessor(qualifier="writePrincipals", type=GETTER) public Collection<PrincipalModel> getWritePrincipals()
      Generated method - Getter of the CockpitObjectAbstractCollection.writePrincipals attribute defined at extension cockpit. Consider using FlexibleSearchService::searchRelation for pagination support of large result sets.
      Returns:
      the writePrincipals
    • setDescription

      @Accessor(qualifier="description", type=SETTER) public void setDescription(String value)
      Generated method - Setter of CockpitObjectAbstractCollection.description attribute defined at extension cockpit.
      Parameters:
      value - the description
    • setDescription

      @Accessor(qualifier="description", type=SETTER) public void setDescription(String value, Locale loc)
      Generated method - Setter of CockpitObjectAbstractCollection.description attribute defined at extension cockpit.
      Parameters:
      value - the description
      loc - the value localization key
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language
    • setElements

      @Accessor(qualifier="elements", type=SETTER) public void setElements(List<ObjectCollectionElementModel> value)
      Generated method - Setter of CockpitObjectAbstractCollection.elements attribute defined at extension cockpit.
      Parameters:
      value - the elements
    • setLabel

      @Accessor(qualifier="label", type=SETTER) public void setLabel(String value)
      Generated method - Setter of CockpitObjectAbstractCollection.label attribute defined at extension cockpit.
      Parameters:
      value - the label
    • setLabel

      @Accessor(qualifier="label", type=SETTER) public void setLabel(String value, Locale loc)
      Generated method - Setter of CockpitObjectAbstractCollection.label attribute defined at extension cockpit.
      Parameters:
      value - the label
      loc - the value localization key
      Throws:
      IllegalArgumentException - if localization key cannot be mapped to data language
    • setQualifier

      @Accessor(qualifier="qualifier", type=SETTER) public void setQualifier(String value)
      Generated method - Setter of CockpitObjectAbstractCollection.qualifier attribute defined at extension cockpit.
      Parameters:
      value - the qualifier
    • setReadPrincipals

      @Accessor(qualifier="readPrincipals", type=SETTER) public void setReadPrincipals(Collection<PrincipalModel> value)
      Generated method - Setter of CockpitObjectAbstractCollection.readPrincipals attribute defined at extension cockpit.
      Parameters:
      value - the readPrincipals
    • setUser

      @Accessor(qualifier="user", type=SETTER) public void setUser(UserModel value)
      Generated method - Setter of CockpitObjectAbstractCollection.user attribute defined at extension cockpit.
      Parameters:
      value - the user
    • setWritePrincipals

      @Accessor(qualifier="writePrincipals", type=SETTER) public void setWritePrincipals(Collection<PrincipalModel> value)
      Generated method - Setter of CockpitObjectAbstractCollection.writePrincipals attribute defined at extension cockpit.
      Parameters:
      value - the writePrincipals