Package de.hybris.platform.jalo.type

Class ComposedType

java.lang.Object
de.hybris.platform.util.BridgeAbstraction
de.hybris.platform.jalo.Item
de.hybris.platform.jalo.ExtensibleItem
de.hybris.platform.jalo.c2l.LocalizableItem
de.hybris.platform.jalo.type.TypeManagerManaged
de.hybris.platform.jalo.type.Type
de.hybris.platform.jalo.type.ComposedType
All Implemented Interfaces:
Serializable, Comparable
Direct Known Subclasses:
EnumerationType, GeneratedCMSComponentType, GeneratedCMSPageType, GeneratedRestrictionType, GeneratedVariantType, RelationType, ViewType
public class ComposedType extends Type
The base type describing jalo item instances. The name composed type refers to AtomicType which describes just single values whereas composed types describe objects which consists of many values. Inside the hybris platform normally these are Items.

Composed types holdAttributeDescriptors which describes a single field of the item. Attribute descriptors are inherited from the declaring type to all its subtypes. Subtypes may change them afterwards locally which does not affect the original attribute descriptor belonging to the declaring type (though type compatibility checks are made).

Additionally non-abstract composed types show all persistence information belonging to the item:

  • database table
  • dump property database table
  • ejb jndi name
  • ejb bean typecode

These types may be used for creating new item instances generically without having to call their actual managers via newInstance(Map) . This provides a way of creating and setting additionally data inside one step (which normally cannot be done using the manager).

Composed type can be retrieved byjalo class or code .

An essential use case of composed types are searches via FlexibleSearch: 

 ComposedType myType = TypeManager.getInstance().getComposedType(MyClass.class);
 List<MyClass> myItems = jaloSession.getFlexibleSearch().search(//
                "SELECT {" + Item.PK + "} FROM {" + myType.getCode() + "}", //
                Collections.EMPTY_MAP, //
                MyClass.class).getResult();
See Also:

  • Field Details

    • SUPERTYPE

      public static final String SUPERTYPE
      The supertype attribute qualifier constant.

    • SUBTYPES

      public static final String SUBTYPES
      The subtypes attribute qualifier constant.

    • DECLAREDATTRIBUTEDESCRIPTORS

      public static final String DECLAREDATTRIBUTEDESCRIPTORS
      The declared attribute descriptors attribute qualifier constant.

    • INHERITEDATTRIBUTEDESCRIPTORS

      public static final String INHERITEDATTRIBUTEDESCRIPTORS
      The inherited attribute descriptors attribute qualifier constant.

    • ATTRIBUTEDESCRIPTORS

      public static final String ATTRIBUTEDESCRIPTORS
      The (all) attribute descriptors attribute qualifier constant.

    • JALOCLASS

      public static final String JALOCLASS
      The jalo class attribute qualifier constant.

    • INHERITANCEPATH

      protected static final String INHERITANCEPATH
      Internal attribute The inheritance path.

    • SINGLETON

      public static final String SINGLETON
      The singleton attribute qualifier constant.

    • JALOONLY

      public static final String JALOONLY
      The jalo-only attribute qualifier constant.

    • DYNAMIC

      public static final String DYNAMIC
      The dynami attribute qualifier constant.

    • ABSTRACT

      public static final String ABSTRACT
      The abstract attribute qualifier constant.

    • TABLE

      public static final String TABLE
      The database table attribute qualifier constant.

    • DUMPPROPERTYTABLE

      public static final String DUMPPROPERTYTABLE
      The dump property table attribute qualifier constant.

    • JNDINAME

      public static final String JNDINAME
      The jndi name attribute qualifier constant.

    • ALLSUPERTYPES

      public static final String ALLSUPERTYPES
      The all supertypes attribute qualifier constant.

    • ALLSUBTYPES

      public static final String ALLSUBTYPES
      The all subtypes attribute qualifier constant.

  • Constructor Details

    • ComposedType

      public ComposedType()

  • Method Details

    • newInstance

      public static <E extends Item> E newInstance(SessionContext ctx, Class jaloClass, Map attributeValues) throws JaloGenericCreationException, JaloAbstractTypeException, JaloItemNotFoundException
      Convenience method for creating typed instances of a given composed type.
      Parameters:
      ctx - the session context
      jaloClass - the jalo class which specifies the composed type
      attributeValues - the attribute values to be used for creation
      Returns:
      the new item
      Throws:
      JaloGenericCreationException - in case something goes wrong during creation
      JaloAbstractTypeException - if the actual composed type is abstract
      JaloItemNotFoundException - if the specified class does not belong to any composed type

    • newInstance

      public static <E extends Item> E newInstance(SessionContext ctx, Class jaloClass, Object... params) throws JaloGenericCreationException, JaloAbstractTypeException, JaloItemNotFoundException
      Convenience method for creating typed instances of a given composed type. This method does not take a parameter map but allows to pass parameters as value list.

      Use as follows: 

       Product p = ComposedType.newInstance(ctx, Product.class, Product.CODE, "myCode", Product.UNIT, unit);

      In other words: make sure the parameter list always contains one attribute qualifer followed by its value etc. Otherwise an exception will be raised.

      Parameters:
      ctx - the session context
      jaloClass - the jalo class which specifies the composed type
      params - the attribute values as list of qualifier, value, ...
      Returns:
      the new item
      Throws:
      JaloGenericCreationException - in case something goes wrong during creation
      JaloAbstractTypeException - if the actual composed type is abstract
      JaloItemNotFoundException - if the specified class does not belong to any composed type

    • newInstance

      public static <E extends Item> E newInstance(SessionContext ctx, String typeCode, Map attributeValues) throws JaloGenericCreationException, JaloAbstractTypeException, JaloItemNotFoundException
      Convenience method for creating typed instances of a given composed type.
      Parameters:
      ctx - the session context
      typeCode - the code which specifies the composed type
      attributeValues - the attribute values to be used for creation
      Returns:
      the new item
      Throws:
      JaloGenericCreationException - in case something goes wrong during creation
      JaloAbstractTypeException - if the actual composed type is abstract
      JaloItemNotFoundException - if the specified code does not belong to any composed type

    • newInstance

      public static <E extends Item> E newInstance(SessionContext ctx, String typeCode, Object... params) throws JaloGenericCreationException, JaloAbstractTypeException, JaloItemNotFoundException
      Convenience method for creating typed instances of a given composed type.This method does not take a parameter map but allows to pass parameters as value list.

      Use as follows: 

       Product p = ComposedType.newInstance(ctx, Product.class, Product.CODE, "myCode", Product.UNIT, unit);

      In other words: make sure the parameter list always contains one attribute qualifer followed by its value etc. Otherwise an exception will be raised.

      Parameters:
      ctx - the session context
      typeCode - the code which specifies the composed type
      params - the attribute value list
      Returns:
      the new item
      Throws:
      JaloGenericCreationException - in case something goes wrong during creation
      JaloAbstractTypeException - if the actual composed type is abstract
      JaloItemNotFoundException - if the specified code does not belong to any composed type

    • createItem

      protected Item createItem(SessionContext ctx, ComposedType type, Item.ItemAttributeMap allAttributes) throws JaloBusinessException
      The generic creator method for creating new composed types by newInstance(Map).

      Required attributes are:

      Specified by:
      createItem in class Item
      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

    • getNonInitialAttributes

      protected Item.ItemAttributeMap getNonInitialAttributes(SessionContext ctx, Item.ItemAttributeMap allAttributes)
      Cuts SUPERTYPE and Type.CODE from the attribute map since these values are already set actual item during creation.
      Overrides:
      getNonInitialAttributes in class Item
      Parameters:
      ctx - session context with language = NULL
      allAttributes - a ItemAttributeMap contaning attribute values.
      Returns:
      a ItemAttributeMap containing all attribute values, which belong to non-initial attributes.

    • toString

      public String toString(SessionContext ctx, Object value) throws JaloInvalidParameterException
      Specified by:
      toString in class Type
      Throws:
      JaloInvalidParameterException
      Since:
      2.10

    • parseValue

      public Object parseValue(SessionContext ctx, String value) throws JaloInvalidParameterException
      Specified by:
      parseValue in class Type
      Throws:
      JaloInvalidParameterException
      Since:
      2.10

    • getTable

      public String getTable()
      Returns:
      the name of the database table assoziated with this type. for abstract types this name may be NULL.

    • getDumpPropertyTable

      public String getDumpPropertyTable()
      Returns the name of the dump property table. Any untyped property attribute is read and written from and into this table.

      Typed property attributes are attributes declared in items.xml and so created during system initialization. Any other property attribute which was created afterwards will store its values inside the dump table just like properties which do not have an attribute at all.

    • getJNDIName

      public String getJNDIName()
      Returns:
      the JNDI name of the assoziated item EJB. since abstract types normally dont have deployed item EJB's this may return NULL for such types.

    • getItemTypeCode

      public int getItemTypeCode()
      Returns:
      the typecode of the assoziated item EJB. abstract types doesnt have such typecode, so 0 will be returned.

    • getAllConcreteItemTypeCodes

      public Set<Integer> getAllConcreteItemTypeCodes()
      Since:
      2.10

    • getJaloClass

      public Class getJaloClass()
      Returns:
      the jalo class object of the item defined by this type. if this type doesnt have a own jalo class the supertype is used.

    • getDeclaredJaloClass

      public Class getDeclaredJaloClass()
      Returns:
      the jalo class which has been declared for this type. if no class has been declared null is returned.

    • setJaloClass

      public void setJaloClass(Class newOne)
      changes this type's jalo class
      Parameters:
      newOne - the new jalo class ; setting to null means using the supertype jalo class

    • getInheritedAttributeDescriptors

      public Set<AttributeDescriptor> getInheritedAttributeDescriptors()
      Returns all attribute descriptors of this composedy type which have been declared by one of its supertype and are inherited (copied) for this type.

      Please note that these attribute descriptors belong to this type exclusively since it has been copied from the direct supertype's same attribute descriptor.

      See Also:

    • getAllSuperTypes

      public List<ComposedType> getAllSuperTypes()
      Returns the complete supertype list of this type containing the top-most type at the end of the list and its direct supertype at first.
      See Also:

    • getSuperType

      public ComposedType getSuperType()
      Returns:
      this types direct supertype.
      See Also:

    • getInheritancePathString

      protected String getInheritancePathString()
      Returns the internal representation if this types supertype list. Dont use directly!

    • getSubTypes

      public Set<ComposedType> getSubTypes()
      Returns the direct subtypes of this type.
      See Also:

    • getAllSubTypes

      public Set<ComposedType> getAllSubTypes()
      Returns all subtypes of this type. This includes its direct subtypes, their subtypes, etc.
      See Also:

    • getInitialAttributeDescriptors

      public Set getInitialAttributeDescriptors()
      Returns all attribute descriptors of this type which are marked as being initial.

      Initial attributes are normally non-writable attributes intented to be set during item creation only. Therefore having initial and writable attributed doesnt make much sense.

    • _sortAttributesByQualifier

      protected void _sortAttributesByQualifier(List<AttributeDescriptor> lst)

    • getDeclaredAttributeDescriptors

      public Set getDeclaredAttributeDescriptors()
      Returns all attributes which are declared by this type.

      The type may own additional attribute descriptors which are not declared by itself but one of its supertypes.

      See Also:

    • setDeclaredAttributeDescriptors

      @Deprecated(since="ages", forRemoval=false) public void setDeclaredAttributeDescriptors(Set fds) throws JaloInvalidParameterException
      Deprecated.
      since ages - dont use any more - add new attribute descriptors via createAttributeDescriptor(String, Type, int) instead
      Throws:
      JaloInvalidParameterException

    • getAttributeDescriptors

      public Set<AttributeDescriptor> getAttributeDescriptors()
      Returns all attribute descriptors owned by this type. This includes attributes declared by it as well as attributes declared by any of its supertypes.
      See Also:

    • getPartOfAutoRemovalAttributeDescriptors

      public Set<AttributeDescriptor> getPartOfAutoRemovalAttributeDescriptors()

    • getAttributeDescriptorsIncludingPrivate

      public Set<AttributeDescriptor> getAttributeDescriptorsIncludingPrivate()
      Returns all attribute descriptors of this type including all marked as private.

    • getAttributeDescriptorsIncludingPrivate

      public Set<AttributeDescriptor> getAttributeDescriptorsIncludingPrivate(Collection<String> qualifiers)

    • getAttributeDescriptorIncludingPrivate

      public AttributeDescriptor getAttributeDescriptorIncludingPrivate(String qualifier) throws JaloItemNotFoundException
      Returns a declared or inherited attribute descriptor of this type even if is marked as private.
      Parameters:
      qualifier - the attribute descriptor qualifier
      Throws:
      JaloItemNotFoundException

    • getDeclaredAttributeDescriptor

      public AttributeDescriptor getDeclaredAttributeDescriptor(String qualifier) throws JaloItemNotFoundException
      Returns a specific declared attribute descriptor.
      Parameters:
      qualifier - the attribute qualifier (case insensitive)
      Throws:
      JaloItemNotFoundException - in case no such attribute descriptor exists

    • getAttributeDescriptor

      public AttributeDescriptor getAttributeDescriptor(String qualifier) throws JaloItemNotFoundException
      Returns a specific attribute descriptor regardless of whether it has been declared by this type or not.
      Parameters:
      qualifier - the attribute qualifier (case insensitive)
      Throws:
      JaloItemNotFoundException - in case no such attribute descriptor exists

    • hasAttribute

      public boolean hasAttribute(String qualifier) throws JaloItemNotFoundException
      Returns true of the attribute with the given qualifier exist in this composed type
      Parameters:
      qualifier - the attribute qualifier (case insensitive)
      Throws:
      JaloItemNotFoundException

    • getEveryAttributeDescriptor

      @Deprecated(since="ages", forRemoval=false) public AttributeDescriptor getEveryAttributeDescriptor(String qualifier) throws JaloItemNotFoundException
      Deprecated.
      since ages - usegetAttributeDescriptorIncludingPrivate(String) instead
      Returns a specific attribute descriptor regardless of whether it has been declared by this type or not. Additionally this method will also find attribute descriptors marked as private.
      Parameters:
      qualifier - the attribute qualifier (case insensitive)
      Throws:
      JaloItemNotFoundException - in case no such attribute descriptor exists

    • getRelations

      public Set<RelationType> getRelations()
      Returns all relations this type is involved in. These are all relations which define a RelationDescriptor for this type.

    • createAttributeDescriptor

      public AttributeDescriptor createAttributeDescriptor(String qualifier, Type valueType, int modifiers) throws JaloDuplicateQualifierException, JaloInvalidParameterException
      Adds a new attribute descriptor to this type.
      Parameters:
      qualifier - the qualifier of the new attribute
      valueType - the value type of the new attribute
      modifiers - attribute settings as combinations of
      Throws:
      JaloDuplicateQualifierException - in case this type already owns an attribute descriptor with the same (case insensitive) qualifier
      JaloInvalidParameterException - in case of unsupported settings or value type

    • createAttributeDescriptor

      public AttributeDescriptor createAttributeDescriptor(PK pk, String qualifier, Type valueType, int modifiers) throws JaloDuplicateQualifierException, JaloInvalidParameterException
      Adds a new attribute descriptor to this type.
      Parameters:
      pk - the pk for the new item; it will be equipped with type code additionally (-)
      qualifier - the qualifier of the new attribute
      valueType - the value type of the new attribute
      modifiers - attribute settings as combinations of
      Throws:
      JaloDuplicateQualifierException - in case this type already owns an attribute descriptor with the same (case insensitive) qualifier
      JaloInvalidParameterException - in case of unsupported settings or value type

    • newInstance

      public Item newInstance(Map attributeAssignment) throws JaloGenericCreationException, JaloAbstractTypeException
      Creates a new instance of the Jalo Item described by this type. The whole creation can be considered as being atomic - if any error was raised during creation all changes will not take effect.

      Please refer to the documentation regarding transaction support for the installation plaform and database to ensure if this behaviour can be guaranteed!

      An example: 

       // get the desired type
 ComposedType currencyType = jaloSession.getTypeManager().getComposedType(Currency.class);

 // fill attribute value map
 Map attributes = new HashMap();
 attibutes.put(C2LItem.ISOCODE, "DE");
 attibutes.put(Currency.DIGITS, new Integer(2));
 attibutes.put(C2LItem.SYMBOL, "EUR");

 // create item instance
 Currency newOne = null;
 try
 {
        newOne = (Currency) currencyType.newInstance(attributes);
 }
 catch (JaloGenericCreationException e)
 {
        Throwable cause = e.getCause();
        // check expected exceptions
        if (cause instanceof ConsistencyCheckException)
    {
                System.err.println("duplicate ISO code : " + cause);
    }
        // report unexpected exceptions
        else
    {
                throw new JaloSystemException(e);
    }
 }
      Parameters:
      attributeAssignment - a map containing all attribute values required for the specific item during creation - optional attribute may be passed as well here
      Throws:
      JaloGenericCreationException - in case any business eaxception was raised during creation
      JaloAbstractTypeException - in case the type is abstract, means there cannot exist instances of it

    • newInstance

      public Item newInstance(SessionContext ctx, Map attributeAssignment) throws JaloGenericCreationException, JaloAbstractTypeException
      Creates a new instance of the Jalo Item described by this type. The whole creation can be considered as being atomic - if any error was raised during creation all changes will not take effect.

      Please refer to the documentation regarding transaction support for the installation plaform and database to ensure if this behaviour can be guaranteed!

      An example: 

       // get the desired type
 ComposedType currencyType = jaloSession.getTypeManager().getComposedType(Currency.class);

 // fill attribute value map
 Map attributes = new HashMap();
 attibutes.put(C2LItem.ISOCODE, "EUR");
 attibutes.put(Currency.DIGITS, new Integer(2));
 attibutes.put(C2LItem.SYMBOL, "EUR");
 // localized attributes too
 attibutes.put(C2LItem.NAME, "Deutsch");

 // create item instance
 Currency newOne = null;
 try
 {
        SessionContext deCtx = jaloSession.createSessionContext();
        deCtx.setLanguage(jaloSession.getC2LManager().getLanguageByIsoCode("de"));
        newOne = (Currency) currencyType.newInstance(deCtx, attributes);
 }
 catch (JaloGenericCreationException e)
 {
        Throwable cause = e.getCause();
        // check expected exceptions
        if (cause instanceof ConsistencyCheckException)
    {
                System.err.println("duplicate ISO code : " + cause);
    }
        // report unexpected exceptions
        else
    {
                throw new JaloSystemException(e);
    }
 }
      Parameters:
      ctx - the session context which the new item should be created within - define language of localized values here
      attributeAssignment - a map containing all attribute values required for the specific item during creation - optional attribute may be passed as well here
      Throws:
      JaloGenericCreationException - in case any business eaxception was raised during creation
      JaloAbstractTypeException - in case the type is abstract, means there cannot exist instances of it

    • getCreatorInstance

      protected Item getCreatorInstance(Class<? extends Item> jaloClass) throws JaloGenericCreationException
      Throws:
      JaloGenericCreationException

    • getAllDefaultValues

      public Map getAllDefaultValues()
      Returns all default values of this type. The map contains mapping from attribute qualifiers to their default values unless the attribute do not own a default value or is not writable.

      The returned map works case insensitive.

      See Also:

    • getAllDefaultValues

      public Map getAllDefaultValues(SessionContext ctx)
      Returns all default values of this type. The map contains mapping from attribute qualifiers to their default values unless the attribute do not own a default value or is not writable.

      The returned map works case insensitive.

      See Also:

    • getDefaultValues

      public Map getDefaultValues(Set fdCodes) throws JaloItemNotFoundException
      Returns the default values for a specified set of attributes. The map contains mapping from attribute qualifiers to their default values unless the attribute do not own a default value or is not writable.

      The returned map works case insensitive.

      Parameters:
      fdCodes - a set of attribute descriptor qualifiers
      Throws:
      JaloItemNotFoundException - in case of missing attribute for one specified qualifer

    • getDefaultValues

      public Map getDefaultValues(SessionContext ctx, Set fdCodes) throws JaloItemNotFoundException, JaloInvalidParameterException
      Returns the default values for a specified set of attributes.The map contains mapping from attribute qualifiers to their default values unless the attribute do not own a default value or is not writable.

      The returned map works case insensitive.

      Parameters:
      fdCodes - a set of attribute descriptor qualifiers
      Throws:
      JaloItemNotFoundException - in case of missing attribute for one specified qualifier
      JaloInvalidParameterException

    • getAllInstances

      public Set getAllInstances()
      Returns all instances of this type. Since search restrictions may apply this includes all jalo items which are visible to the current session user.

    • createJaloOnlyInstance

      protected Item createJaloOnlyInstance(SessionContext ctx, Map attributes)

    • getAllInstances

      public Set getAllInstances(SessionContext ctx)
      Returns all instances of this type. Since search restrictions may apply this includes all jalo items which are visible to the current session user.

    • getAllInstancesCount

      public long getAllInstancesCount()
      Returns the number of instances of this type. Since search restrictions may apply to the current user this will show the number of visible instances only.

    • isSingleton

      public boolean isSingleton()
      Tells whether or not this type describes at most one instance or not.
      Returns:
      true if this type describes at most one instance

    • isJaloOnly

      public boolean isJaloOnly()
      Tells whether this type is not really an item but just a jalo class which access all the attributes.
      NOTE: This attribute is applicable on the singleton type only!
      Returns:
      true if this type is not really an item but just a jalo class which access all the attributes

    • isDynamic

      public boolean isDynamic()
      Tells whether this type is dynamic.
      NOTE: This attribute is applicable on the enumeration type only!
      Returns:
      true if this type is changeable at runtime

    • isAbstract

      public boolean isAbstract()
      Tells whether this type may have instances or not.
      Returns:
      true if the type cannot have instances.

    • isJaloClassAbstract

      protected boolean isJaloClassAbstract()

    • setSingleton

      public void setSingleton(boolean isSingleton) throws JaloInvalidParameterException
      Changes this types singleton status.
      Parameters:
      isSingleton - if true the type is marked as having just one instance
      Throws:
      JaloInvalidParameterException - in case a type with more than one instance is tried to mark as singleton.

    • setJaloOnly

      public void setJaloOnly(boolean isJaloOnly) throws JaloInvalidParameterException
      Changes this types jalo-only status.
      NOTE: This attribute is applicable on the singleton type only!
      Parameters:
      isJaloOnly - if true the instance of this type is not really an item but just a jalo class which access all the attributes
      Throws:
      JaloInvalidParameterException

    • getXMLCustomProperties

      protected Map getXMLCustomProperties(String forExtension)
      Override to add custom properties to this type's xml definition.

    • getXMLDefinition

      public String getXMLDefinition()
      Returns the XML definition text for declaring this type in items.xml. This method will show the declaration to put inside the items.xml of the extension which this type belongs to.

      Any changes made to this type by means of other extensions items.xml will not show up here - use getXMLDefinition(String) to get them.

      Specified by:
      getXMLDefinition in class Type
      See Also:

    • getXMLDefinition

      public String getXMLDefinition(String forExtension)
      Returns the XML definition text for a specified extension. This will include any attributes added by this extensions items.xml.
      Parameters:
      forExtension -
      See Also:

    • exportXMLDefinition

      public String exportXMLDefinition(org.znerd.xmlenc.XMLOutputter xout)
      Specified by:
      exportXMLDefinition in class TypeManagerManaged

    • exportXMLDefinition

      public String exportXMLDefinition(org.znerd.xmlenc.XMLOutputter xout, String forExtension)

    • hasOwnDeployment

      public final boolean hasOwnDeployment()
      Tells whether this type has defined his own deployment.
      Returns:
      true if this type has own deployment

    • getComposedTypeImpl

      protected ComposedType.ComposedTypeImpl getComposedTypeImpl()
      Internal access to persistence layer.

    • isAssignableFrom

      public boolean isAssignableFrom(Type type)
      Checks whether this type is assignable from the specified type. This is the case if this type is the same or supertype of the specified type and this type's jalo class is assignable from the specified type's jalo class.
      Specified by:
      isAssignableFrom in class Type
      Parameters:
      type - the type to check assignability for

    • isSameOrSuperTypeOf

      protected boolean isSameOrSuperTypeOf(ComposedType type)
      Tests if this type is the same or supertype of the specified type.

    • isInstance

      public boolean isInstance(Object o)
      Tests if the given object is an item instance of this type.
      Specified by:
      isInstance in class Type
      Parameters:
      o - the object to be checked.

    • toString

      public String toString()
      Returns the string representation of this type including its code, supertype and its declared attribute descriptors. Use carefully since this method may become quite costly putting together all attributes.
      Overrides:
      toString in class Type
      Returns:
      the String representation of this item.

    • setTypeSearchSessionContex

      @Deprecated(since="5.0.1", forRemoval=false) protected boolean setTypeSearchSessionContex()
      Deprecated.
      since 5.0.1
      Internal - dont use.

    • unsetTypeSearchContext

      @Deprecated(since="5.0.1", forRemoval=false) protected void unsetTypeSearchContext(boolean useLocal)
      Deprecated.
      since 5.0.1
      Internal - dont use.

    • checkTypePermission

      public boolean checkTypePermission(UserRight right)
      Checks the type permission of the current session user.

      works similar to Item.checkPermission(UserRight) except that supertype permissions are evaluated in case no permission is set for this type.

      Parameters:
      right - the user right to check
      Returns:
      true if the current session user has the permission on the specified UserRight

    • checkTypePermission

      public boolean checkTypePermission(Principal p, UserRight right)
      Checks the type permission of a given user.

      works similar to Item.checkPermission(UserRight) except that supertype permissions are evaluated in case no permission is set for this type.

      Parameters:
      p - the principal to check
      right - the user right to check
      Returns:
      true if the specified Principal has the permission on the specified UserRight

    • checkItemPermission

      protected int checkItemPermission(Principal principal, UserRight right)
      Allow type package to see this method
      Overrides:
      checkItemPermission in class Item

    • getSingletonInstance

      public Item getSingletonInstance()
      Gets the singleton instance of this type if the type is marked as singleton. Tries to get the existing instance, if not existent a new one will be created.
      Returns:
      the singleton instance of this type
      Throws:
      JaloInvalidParameterException - type is not marked as singleton type
      JaloSystemException - error while instance creation
      Since:
      3.0