Package com.evolveum.midpoint.prism

Interface PrismItemAccessDefinition

All Known Subinterfaces:

AttributeContainerDefinitionDelegator, AttributeDefinitionDelegator<T>, ContainerDefinitionDelegator<C>, ItemDefinition<I>, ItemDefinitionDelegator<I>, LayerRefinedAttributeDefinition<T>, MutableItemDefinition<I>, MutablePrismContainerDefinition<C>, MutablePrismObjectDefinition<O>, MutablePrismPropertyDefinition<T>, MutablePrismReferenceDefinition, MutableResourceAttributeDefinition<T>, ObjectDefinitionDelegator<O>, PrismContainerDefinition<C>, PrismItemAccessDefinition.Mutable, PrismObjectDefinition<O>, PrismPropertyDefinition<T>, PrismReferenceDefinition, PropertyDefinitionDelegator<T>, ReferenceDefinitionDelegator, RefinedAttributeDefinition<T>, RefinedAttributeDefinitionDelegator<T>, ResourceAttributeContainerDefinition, ResourceAttributeDefinition<T>

All Known Implementing Classes:

com.evolveum.midpoint.prism.impl.ItemDefinitionImpl, LayerRefinedAttributeDefinitionImpl, com.evolveum.midpoint.prism.impl.PrismContainerDefinitionImpl, com.evolveum.midpoint.prism.impl.PrismPropertyDefinitionImpl, RefinedAttributeDefinitionImpl, ResourceAttributeContainerDefinitionImpl, ResourceAttributeDefinitionImpl

public interface PrismItemAccessDefinition

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	PrismItemAccessDefinition.Mutable

Method Summary

Modifier and Type	Method	Description
boolean	canAdd()	Returns true if this item can be added: it can be part of an object that is created.
boolean	canModify()	Returns true if this item can be modified (updated).
boolean	canRead()	Returns true if this item can be read (displayed).

Method Detail

canRead

boolean canRead()

Returns true if this item can be read (displayed). In case of containers this flag is, strictly speaking, not applicable. Container is an empty shell. What matters is access to individual sub-item. However, for containers this value has a "hint" meaning. It means that the container itself contains something that is readable. Which can be used as a hint by the presentation to display container label or block. This usually happens if the container contains at least one readable item. This does NOT mean that also all the container items can be displayed. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.

Note: It was considered to use a different meaning for this flag - a meaning that would allow canRead()=false containers to have readable items. However, this was found not to be very useful. Therefore the "something readable inside" meaning was confirmed instead.

canModify

boolean canModify()

Returns true if this item can be modified (updated). In case of containers this means that the container itself should be displayed in modification forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one modifiable item. This does NOT mean that also all the container items can be modified. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.

canAdd

boolean canAdd()

Returns true if this item can be added: it can be part of an object that is created. In case of containers this means that the container itself should be displayed in creation forms E.g. that the container label or block should be displayed. This usually happens if the container contains at least one createable item. This does NOT mean that also all the container items can be created. The sub-item permissions are controlled by similar properties on the items. This property only applies to the container itself: the "shell" of the container.