|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface LocationAttributeInstance
This interface represents an instance of a location specific attribute on an item.
Field Summary |
---|
Fields inherited from interface com.ibm.pim.attribute.AttributeInstance |
---|
copyright, OCCURRENCE_DELIMITER, PATH_DELIMITER |
Method Summary | |
---|---|
java.util.List<LocationAttributeInstance> |
getChildren()
Exactly the same as super.getChildren(), except for that children are of type LocationAttributeInstance and the children of a multi-occurrence attribute instance may come from another location. |
java.util.List<LocationAttributeInstance> |
getInheritedChildren()
Get the inherited children which contains multi-occurrence children that apply if the "own" multi-occurrence attribute instance has no children. |
InheritedValue |
getInheritedValue()
Returns the inherited value for this attribute, which provides both the inherited value and where it came from. |
Category |
getLocation()
Returns the LocationData object this LocationDataAttributeInstance belongs to. |
java.util.List<LocationAttributeInstance> |
getNonInheritedChildren()
This method is exactly like getChildren, except that inherited children are ignored. |
java.lang.Object |
getNonInheritedValue()
Returns the "own" value for this attribute. |
ExtendedAttributeOwner |
getOwner()
Same as super.getOwner(), except returns a more specific type. |
LocationAttributeInstance |
getParent()
The parent attribute instance of an attribute instance is the attribute instance that contains this attribute instance and would return this attribute instance when getChildren() is called. |
boolean |
hasInheritedValue()
Identifies if this locationdata attribute has a non null inherited value. |
boolean |
hasNonInheritedValue()
Identifies if this locationdata attribute has a non null, non inherited value. |
boolean |
isInheriting()
Identifies if this locationdata attribute inherits |
void |
useInheritance(boolean flag)
Sets this location attribute (either value or multi-occurrence), to either override inheritance or to inherit from its parent without providing any values. |
Methods inherited from interface com.ibm.pim.attribute.AttributeInstance |
---|
addOccurrence, canAddOccurrence, getAttributeDefinition, getDisplayValue, getOccurrenceIndex, getPath, getPossibleValues, getValue, isGrouping, isMultiOccurrence, isValue, removeOccurrence, setValue, setValue, setValue, setValueByExecutingNonPersistedAttributeRule |
Method Detail |
---|
ExtendedAttributeOwner getOwner()
getOwner
in interface AttributeInstance
PIMInternalException
- If an internal error occursCategory getLocation()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useLocationAttributeInstance getParent()
For the 3 different types of AttributeInstance:
1. Value: If max occurrence of the value is one, then the parent is definitely a directory. If the max occurrence of the value is greater than one, then the parent is a multi-occurrence container. 2. Directory: The parent of a directory is ALWAYS a multi-occurrence container 3. Multi-Occurrence Container: The parent of a multi-occurrence container is always a directory
getParent
in interface AttributeInstance
PIMInternalException
- If an internal error occursjava.util.List<LocationAttributeInstance> getChildren()
getChildren
in interface AttributeInstance
java.lang.UnsupportedOperationException
- if this is a value instance (cannot have children)
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useboolean isInheriting()
PIMInternalException
- If an internal error occursboolean hasInheritedValue()
PIMInternalException
- if an internal error occursboolean hasNonInheritedValue()
PIMInternalException
- if an internal error occursInheritedValue getInheritedValue()
java.lang.UnsupportedOperationException
- if this attribute is not inheriting a value
PIMInternalException
- If an internal error occursjava.lang.Object getNonInheritedValue()
java.lang.UnsupportedOperationException
- if this attribute is not inheriting a valuejava.util.List<LocationAttributeInstance> getInheritedChildren()
PIMInternalException
- If an internal error occursjava.util.List<LocationAttributeInstance> getNonInheritedChildren()
Note, that this only applies to getting children for MultiOccurrence attribute instances, because inheritance for individual values occurs inside the value AttributeInstance. In other words, getNonINheritedChildren returns the same exact result as getChildren() except in the case of:
1. Calling getOwnChildren() on a MultiOccurrence AttributeInstance<p/> 2. The AttributeInstance has no child occurrences (children) of it's own<p/> 3. A parent location does have child occurrences.
PIMInternalException
- If an internal error occursvoid useInheritance(boolean flag)
In other words, an attribute instance can contain a special null value which means no value, but don't inherit.
If the attribute already does not inherit (has a value or child occurrences), then this method has no effect. Note This method unsets the value if it is set to inherited If this is called on an attribute that has a value, nothing is done.
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.UnsupportedOperationException
- if called on a grouping attribute instance or a value
attribute instance that can have multiple occurrences.
Permission.CATALOG_MODIFY_ITEMS
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |