|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ExtendedAttributeOwner
Field Summary |
---|
Fields inherited from interface com.ibm.pim.attribute.AttributeOwner |
---|
copyright |
Method Summary | |
---|---|
void |
executeNonPersistedScript()
Execute non-persisted script for all attributes in the item to populate their values. |
ExtendedAttributeChanges |
getAttributeChangesComparedTo(ExtendedAttributeOwner otherAttributeOwner)
Identify Attribute Changes between this and another AttributeOwner. |
ExtendedAttributeChanges |
getAttributeChangesSinceLastSave()
Identify Attribute Changes since the last time the AttributeOwner was saved. |
PIMCollection<Category> |
getAvailableLocations(Category location)
Returns the locations this item is available in from the set of locations given by the passed in location and its descendants. |
LocationAttributeInstance |
getLocationAttributeInstance(Category location,
java.lang.String attributeInstancePath)
Retrieve the attribute instance at the specified path |
java.lang.Object |
getLocationAttributeValue(Category location,
java.lang.String attributeInstancePath)
Retrieve the attribute value at the specified path for this entry at this location. |
PIMCollection<Category> |
getLocationsHavingData(Category location)
Identifies the locations this item has location specific data for from the set of locations given by the passed in location and its descendants. |
LocationAttributeInstance |
getRootLocationAttributeInstance(Category location)
Retrieve the root attribute instance at the specified location. |
boolean |
isAvailableInLocation(Category location)
Determines if the item is available in the given location. |
void |
makeAvailableInLocation(Category location)
Make this item available at the given location. |
void |
makeAvailableInLocationRecursively(Category location)
Make this item available in given location and all its descendant locations. |
void |
makeUnavailableInLocation(Category location)
This will make the item unavailable in the given location. |
void |
makeUnavailableInLocationRecursively(Category location)
This will make the item unavailable in the given location and all its descendant locations. |
void |
setLocationAttributeValue(Category location,
java.lang.String attributePath,
java.lang.Object value)
This will set an attribute value on this AttributeOwner at the specified Attribute Instance Path on the location. |
Methods inherited from interface com.ibm.pim.attribute.AttributeOwner |
---|
getAttributeChangesComparedTo, getAttributeInstance, getAttributeValue, getOriginalAttributeOwner, getRootAttributeInstance, getRootAttributeInstances, getSpecs, isComparable, setAttributeValue |
Method Detail |
---|
boolean isAvailableInLocation(Category location)
location
- -
The Category object representing the location.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- Reserved for future usevoid makeAvailableInLocation(Category location)
location
- -
The Category object representing the location.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
void makeAvailableInLocationRecursively(Category location)
location
- -
the Category object representing the location.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
void makeUnavailableInLocation(Category location)
location
- -
The Category object representing the location.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
void makeUnavailableInLocationRecursively(Category location)
location
- -
The Category object representing the location.
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
PIMCollection<Category> getAvailableLocations(Category location)
location
- -
the category object representing a location
java.lang.IllegalArgumentException
- If the location parameter is null
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- reserved for future use.for more info
PIMCollection<Category> getLocationsHavingData(Category location)
Please note this is a lazily instantiated collection
location
- -
The Category object representing a location
PIMInternalException
- if an internal error occurs
PIMAuthorizationException
- reserved for future usefor more info
LocationAttributeInstance getLocationAttributeInstance(Category location, java.lang.String attributeInstancePath)
location
- The category for this locationattributeInstancePath
- -
the path to return the instance from This path must be valid
(per AttributePathHelper.isValid()) and can be instantiated
(per canInstantiateAttributeAt(path), and hasAttributeInstance
must return true.
java.lang.UnsupportedOperationException
- If the category is not an available location or the attribute
path is invalid
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If the location or attributeInstancePath parameters is null
or empty
PIMAuthorizationException
- Reserved for future useLocationAttributeInstance getRootLocationAttributeInstance(Category location)
This is equivalent to getLocationAttributeInstance("/" + locationSpec.getName()), which returns the attribute instance that corresponds to the top grouping level of the only spec for the location hierarchy.
location
- The category for this location
PIMInternalException
- If an internal error occurs
java.lang.IllegalArgumentException
- If the location parameter is null or emptyExtendedAttributeChanges getAttributeChangesComparedTo(ExtendedAttributeOwner otherAttributeOwner)
otherAttributeOwner
- -
a previous version of this AttributeOwner to compare with the
current attribute values for this version
java.lang.IllegalArgumentException
- If the previousVersion parameters is null
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useExtendedAttributeChanges getAttributeChangesSinceLastSave()
Note: This method suggests that save() should be exposed at the attribute owner level.
getAttributeChangesSinceLastSave
in interface AttributeOwner
PIMInternalException
- If an internal error occursjava.lang.Object getLocationAttributeValue(Category location, java.lang.String attributeInstancePath)
Note, this is slightly more efficient than getting the value from the corresponding attribute instance because this method is much lighter weight. Thus, if a value is needed, prefer getLocationAttributeValue(location, path) over getLocationAttributeInstance(location, path).getValue()
location
- The category for this locationattributeInstancePath
- -
a valid attribute instance path
java.lang.IllegalArgumentException
- If the attributeInstancePath parameters is null or empty
PIMInternalException
- If the category is not an available location, the attribute
path is invalid, or an internal error occursvoid setLocationAttributeValue(Category location, java.lang.String attributePath, java.lang.Object value)
Note, calling setLocationAttributeValue(location, path, value) is more efficient than calling getLocationAttributeInstance(location, path).setValue() because setLocationAttributeValue(location, path) is far lighter.
location
- The category for this locationattributePath
- -
a path at which an attribute instance exists or can be createdvalue
- -
the value for the AttributeInstance
java.lang.IllegalArgumentException
- If the attributeInstancePath parameters is null or empty
PIMInternalException
- If the category is not an available location, the attribute
path is invalid, the value is invalid, or if an internal
error occursfor more details on
attribute paths
void executeNonPersistedScript()
PIMInternalException
- If an internal error occurs.
PIMAuthorizationException
- If the user does not have the equivalent of
Permission.CATALOG_MODIFY_ITEMS
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |