Class GeneratedCockpitObjectAbstractCollection

All Implemented Interfaces:
Serializable, Comparable
Direct Known Subclasses:
CockpitObjectAbstractCollection

public abstract class GeneratedCockpitObjectAbstractCollection extends GenericItem
Generated class for type CockpitObjectAbstractCollection.
See Also:
  • Field Details

    • QUALIFIER

      public static final String QUALIFIER
      Qualifier of the CockpitObjectAbstractCollection.qualifier attribute
      See Also:
    • LABEL

      public static final String LABEL
      Qualifier of the CockpitObjectAbstractCollection.label attribute
      See Also:
    • DESCRIPTION

      public static final String DESCRIPTION
      Qualifier of the CockpitObjectAbstractCollection.description attribute
      See Also:
    • USER

      public static final String USER
      Qualifier of the CockpitObjectAbstractCollection.user attribute
      See Also:
    • READPRINCIPALS

      public static final String READPRINCIPALS
      Qualifier of the CockpitObjectAbstractCollection.readPrincipals attribute
      See Also:
    • READPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_SRC_ORDERED

      protected static String READPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_SRC_ORDERED
      Relation ordering override parameter constants for ReadPrincipal2CockpitObjectAbstractCollectionRelation from ((cockpit))
    • READPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_TGT_ORDERED

      protected static String READPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_TGT_ORDERED
    • READPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_MARKMODIFIED

      protected static String READPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_MARKMODIFIED
      Relation disable markmodifed parameter constants for ReadPrincipal2CockpitObjectAbstractCollectionRelation from ((cockpit))
    • WRITEPRINCIPALS

      public static final String WRITEPRINCIPALS
      Qualifier of the CockpitObjectAbstractCollection.writePrincipals attribute
      See Also:
    • WRITEPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_SRC_ORDERED

      protected static String WRITEPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_SRC_ORDERED
      Relation ordering override parameter constants for WritePrincipal2CockpitObjectAbstractCollectionRelation from ((cockpit))
    • WRITEPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_TGT_ORDERED

      protected static String WRITEPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_TGT_ORDERED
    • WRITEPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_MARKMODIFIED

      protected static String WRITEPRINCIPAL2COCKPITOBJECTABSTRACTCOLLECTIONRELATION_MARKMODIFIED
      Relation disable markmodifed parameter constants for WritePrincipal2CockpitObjectAbstractCollectionRelation from ((cockpit))
    • ELEMENTS

      public static final String ELEMENTS
      Qualifier of the CockpitObjectAbstractCollection.elements attribute
      See Also:
    • USERHANDLER

      BidirectionalOneToManyHandler for handling 1:n USER's relation attributes from 'one' side.
    • ELEMENTSHANDLER

      protected static final OneToManyHandler<ObjectCollectionElement> ELEMENTSHANDLER
      OneToManyHandler for handling 1:n ELEMENTS's relation attributes from 'many' side.
    • DEFAULT_INITIAL_ATTRIBUTES

      protected static final Map<String,Item.AttributeMode> DEFAULT_INITIAL_ATTRIBUTES
  • Constructor Details

    • GeneratedCockpitObjectAbstractCollection

      public GeneratedCockpitObjectAbstractCollection()
  • Method Details

    • getDefaultAttributeModes

      protected Map<String,Item.AttributeMode> getDefaultAttributeModes()
      Overrides:
      getDefaultAttributeModes in class Item
    • createItem

      protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException
      Description copied from class: Item
      Has to be implemented for each concrete subtype of item. This method is responsible for creating a new item instance ( by calling managers, ejb homes, etc. ) during ComposedType.newInstance(Map).

      In case this method uses any of the attribute values during creation it is required to override Item.getNonInitialAttributes(SessionContext, ItemAttributeMap) too.
      Sn example:

      
       public static final String MY_ATTRIBUTE = "someAttribute"; ... protected Item createItem(SessionContext
       ctx, ComposedType type, Map allAttributes ) throws JaloBusinessException { MyManager man = ... return
       man.createMyItem( (String)allAttributes.get(MY_ATTRIBUTE) );
       // here MY_ATTRIBUTE is used for creation, so it must not be set again } protected Map getNonInitialAttributes(
       SessionContext ctx, Map allAttributes ) { // let superclass remove its own initial attributes Map ret =
       super.getNonInitialAttributes( ctx, allAttributes );
       // remove MY_ATTRIBUTE from all attributes since if has already been set ret.remove(MY_ATTRIBUTE); return ret; }
      
       
      Overrides:
      createItem in class GenericItem
      Parameters:
      ctx - the current session context which this item is created within
      type - the actual item type ( since subtypes may not provide a own jalo class this may be different from the type which this method was implemented for )
      Returns:
      the new item instance
      Throws:
      JaloBusinessException - indicates an error during creation - any changes will be rollbacked
    • getDescription

      public String getDescription(SessionContext ctx)
      Generated method - Getter of the CockpitObjectAbstractCollection.description attribute.
      Returns:
      the description
    • getDescription

      public String getDescription()
      Generated method - Getter of the CockpitObjectAbstractCollection.description attribute.
      Returns:
      the description
    • getAllDescription

      public Map<Language,String> getAllDescription(SessionContext ctx)
      Generated method - Getter of the CockpitObjectAbstractCollection.description attribute.
      Returns:
      the localized description
    • getAllDescription

      public Map<Language,String> getAllDescription()
      Generated method - Getter of the CockpitObjectAbstractCollection.description attribute.
      Returns:
      the localized description
    • setDescription

      public void setDescription(SessionContext ctx, String value)
      Generated method - Setter of the CockpitObjectAbstractCollection.description attribute.
      Parameters:
      value - the description
    • setDescription

      public void setDescription(String value)
      Generated method - Setter of the CockpitObjectAbstractCollection.description attribute.
      Parameters:
      value - the description
    • setAllDescription

      public void setAllDescription(SessionContext ctx, Map<Language,String> value)
      Generated method - Setter of the CockpitObjectAbstractCollection.description attribute.
      Parameters:
      value - the description
    • setAllDescription

      public void setAllDescription(Map<Language,String> value)
      Generated method - Setter of the CockpitObjectAbstractCollection.description attribute.
      Parameters:
      value - the description
    • getElements

      public List<ObjectCollectionElement> getElements(SessionContext ctx)
      Generated method - Getter of the CockpitObjectAbstractCollection.elements attribute.
      Returns:
      the elements
    • getElements

      public List<ObjectCollectionElement> getElements()
      Generated method - Getter of the CockpitObjectAbstractCollection.elements attribute.
      Returns:
      the elements
    • setElements

      public void setElements(SessionContext ctx, List<ObjectCollectionElement> value)
      Generated method - Setter of the CockpitObjectAbstractCollection.elements attribute.
      Parameters:
      value - the elements
    • setElements

      public void setElements(List<ObjectCollectionElement> value)
      Generated method - Setter of the CockpitObjectAbstractCollection.elements attribute.
      Parameters:
      value - the elements
    • addToElements

      public void addToElements(SessionContext ctx, ObjectCollectionElement value)
      Generated method - Adds value to elements.
      Parameters:
      value - the item to add to elements
    • addToElements

      public void addToElements(ObjectCollectionElement value)
      Generated method - Adds value to elements.
      Parameters:
      value - the item to add to elements
    • removeFromElements

      public void removeFromElements(SessionContext ctx, ObjectCollectionElement value)
      Generated method - Removes value from elements.
      Parameters:
      value - the item to remove from elements
    • removeFromElements

      public void removeFromElements(ObjectCollectionElement value)
      Generated method - Removes value from elements.
      Parameters:
      value - the item to remove from elements
    • isMarkModifiedDisabled

      @Deprecated(since="2105", forRemoval=true) public boolean isMarkModifiedDisabled(Item referencedItem)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      isMarkModifiedDisabled in class Item
    • getLabel

      public String getLabel(SessionContext ctx)
      Generated method - Getter of the CockpitObjectAbstractCollection.label attribute.
      Returns:
      the label
    • getLabel

      public String getLabel()
      Generated method - Getter of the CockpitObjectAbstractCollection.label attribute.
      Returns:
      the label
    • getAllLabel

      public Map<Language,String> getAllLabel(SessionContext ctx)
      Generated method - Getter of the CockpitObjectAbstractCollection.label attribute.
      Returns:
      the localized label
    • getAllLabel

      public Map<Language,String> getAllLabel()
      Generated method - Getter of the CockpitObjectAbstractCollection.label attribute.
      Returns:
      the localized label
    • setLabel

      public void setLabel(SessionContext ctx, String value)
      Generated method - Setter of the CockpitObjectAbstractCollection.label attribute.
      Parameters:
      value - the label
    • setLabel

      public void setLabel(String value)
      Generated method - Setter of the CockpitObjectAbstractCollection.label attribute.
      Parameters:
      value - the label
    • setAllLabel

      public void setAllLabel(SessionContext ctx, Map<Language,String> value)
      Generated method - Setter of the CockpitObjectAbstractCollection.label attribute.
      Parameters:
      value - the label
    • setAllLabel

      public void setAllLabel(Map<Language,String> value)
      Generated method - Setter of the CockpitObjectAbstractCollection.label attribute.
      Parameters:
      value - the label
    • getQualifier

      public String getQualifier(SessionContext ctx)
      Generated method - Getter of the CockpitObjectAbstractCollection.qualifier attribute.
      Returns:
      the qualifier
    • getQualifier

      public String getQualifier()
      Generated method - Getter of the CockpitObjectAbstractCollection.qualifier attribute.
      Returns:
      the qualifier
    • setQualifier

      public void setQualifier(SessionContext ctx, String value)
      Generated method - Setter of the CockpitObjectAbstractCollection.qualifier attribute.
      Parameters:
      value - the qualifier
    • setQualifier

      public void setQualifier(String value)
      Generated method - Setter of the CockpitObjectAbstractCollection.qualifier attribute.
      Parameters:
      value - the qualifier
    • getReadPrincipals

      public Collection<Principal> getReadPrincipals(SessionContext ctx)
      Generated method - Getter of the CockpitObjectAbstractCollection.readPrincipals attribute.
      Returns:
      the readPrincipals
    • getReadPrincipals

      public Collection<Principal> getReadPrincipals()
      Generated method - Getter of the CockpitObjectAbstractCollection.readPrincipals attribute.
      Returns:
      the readPrincipals
    • getReadPrincipalsCount

      public long getReadPrincipalsCount(SessionContext ctx)
    • getReadPrincipalsCount

      public long getReadPrincipalsCount()
    • setReadPrincipals

      public void setReadPrincipals(SessionContext ctx, Collection<Principal> value)
      Generated method - Setter of the CockpitObjectAbstractCollection.readPrincipals attribute.
      Parameters:
      value - the readPrincipals
    • setReadPrincipals

      public void setReadPrincipals(Collection<Principal> value)
      Generated method - Setter of the CockpitObjectAbstractCollection.readPrincipals attribute.
      Parameters:
      value - the readPrincipals
    • addToReadPrincipals

      public void addToReadPrincipals(SessionContext ctx, Principal value)
      Generated method - Adds value to readPrincipals.
      Parameters:
      value - the item to add to readPrincipals
    • addToReadPrincipals

      public void addToReadPrincipals(Principal value)
      Generated method - Adds value to readPrincipals.
      Parameters:
      value - the item to add to readPrincipals
    • removeFromReadPrincipals

      public void removeFromReadPrincipals(SessionContext ctx, Principal value)
      Generated method - Removes value from readPrincipals.
      Parameters:
      value - the item to remove from readPrincipals
    • removeFromReadPrincipals

      public void removeFromReadPrincipals(Principal value)
      Generated method - Removes value from readPrincipals.
      Parameters:
      value - the item to remove from readPrincipals
    • getUser

      public User getUser(SessionContext ctx)
      Generated method - Getter of the CockpitObjectAbstractCollection.user attribute.
      Returns:
      the user
    • getUser

      public User getUser()
      Generated method - Getter of the CockpitObjectAbstractCollection.user attribute.
      Returns:
      the user
    • setUser

      public void setUser(SessionContext ctx, User value)
      Generated method - Setter of the CockpitObjectAbstractCollection.user attribute.
      Parameters:
      value - the user
    • setUser

      public void setUser(User value)
      Generated method - Setter of the CockpitObjectAbstractCollection.user attribute.
      Parameters:
      value - the user
    • getWritePrincipals

      public Collection<Principal> getWritePrincipals(SessionContext ctx)
      Generated method - Getter of the CockpitObjectAbstractCollection.writePrincipals attribute.
      Returns:
      the writePrincipals
    • getWritePrincipals

      public Collection<Principal> getWritePrincipals()
      Generated method - Getter of the CockpitObjectAbstractCollection.writePrincipals attribute.
      Returns:
      the writePrincipals
    • getWritePrincipalsCount

      public long getWritePrincipalsCount(SessionContext ctx)
    • getWritePrincipalsCount

      public long getWritePrincipalsCount()
    • setWritePrincipals

      public void setWritePrincipals(SessionContext ctx, Collection<Principal> value)
      Generated method - Setter of the CockpitObjectAbstractCollection.writePrincipals attribute.
      Parameters:
      value - the writePrincipals
    • setWritePrincipals

      public void setWritePrincipals(Collection<Principal> value)
      Generated method - Setter of the CockpitObjectAbstractCollection.writePrincipals attribute.
      Parameters:
      value - the writePrincipals
    • addToWritePrincipals

      public void addToWritePrincipals(SessionContext ctx, Principal value)
      Generated method - Adds value to writePrincipals.
      Parameters:
      value - the item to add to writePrincipals
    • addToWritePrincipals

      public void addToWritePrincipals(Principal value)
      Generated method - Adds value to writePrincipals.
      Parameters:
      value - the item to add to writePrincipals
    • removeFromWritePrincipals

      public void removeFromWritePrincipals(SessionContext ctx, Principal value)
      Generated method - Removes value from writePrincipals.
      Parameters:
      value - the item to remove from writePrincipals
    • removeFromWritePrincipals

      public void removeFromWritePrincipals(Principal value)
      Generated method - Removes value from writePrincipals.
      Parameters:
      value - the item to remove from writePrincipals