com.ibm.pim.attribute
Interface ExtendedAttributeChanges

All Superinterfaces:
AttributeChanges

public interface ExtendedAttributeChanges
extends AttributeChanges


Field Summary
 
Fields inherited from interface com.ibm.pim.attribute.AttributeChanges
copyright
 
Method Summary
 java.util.List<LocationAttributeInstance> getDeletedLocationAttributes(Category location)
          Return a List of attributes that were present in A but are no longer present in B.
 java.util.List<Category> getLocationsAddedAsAvailable(Category location)
          Return a List of all available locations in B that were not marked available in A
 java.util.List<Category> getLocationsChangedNotToHaveData(Category location)
          Return a List of locations that are available in both A and B and have no data in B but do have data in A
 java.util.List<Category> getLocationsChangedToHaveData(Category location)
          Return a List of locations that are available in both A and B and have no data in A but do have data in B
 java.util.List<Category> getLocationsHavingChangedData(Category location)
          Return a List of locations that are available in both A and B but have at least one location attribute at that location with different data values.
 java.util.List<Category> getLocationsRemovedAsAvailable(Category location)
          Return a List of all available locations in A that are no longer marked available in B
 java.util.List<LocationAttributeInstance> getModifiedLocationAttributesWithNewData(Category location)
          Return a List of attributes that are present in both A & B and which contain different data in A and B at the specified location.
 java.util.List<LocationAttributeInstance> getModifiedLocationAttributesWithOldData(Category location)
          Return a List of attributes that are present in both A & B and which contain different data in A and B at the specified location.
 
Methods inherited from interface com.ibm.pim.attribute.AttributeChanges
getDeletedAttributes, getModifiedAttributesWithNewData, getModifiedAttributesWithOldData, getNewlyAddedAttributes
 

Method Detail

getModifiedLocationAttributesWithNewData

java.util.List<LocationAttributeInstance> getModifiedLocationAttributesWithNewData(Category location)
Return a List of attributes that are present in both A & B and which contain different data in A and B at the specified location.

It is possible for an attribute to have different attribute instance paths across A & B, for example because a multi-occurrence sibling has been deleted. In this case, we return an attribute instance representing the new version of the attribute in B.

Parameters:
location - the location to examine
Returns:
a List of attributes
Throws:
java.lang.IllegalArgumentException - if location is null
PIMInternalException - if there is internal error
java.lang.UnsupportedOperationException - if the specified location is not valid for this item

getModifiedLocationAttributesWithOldData

java.util.List<LocationAttributeInstance> getModifiedLocationAttributesWithOldData(Category location)
Return a List of attributes that are present in both A & B and which contain different data in A and B at the specified location.

It is possible for an attribute to have different attribute definition locations (attribute paths) across A & B, for example because a multi-occurrence sibling has been deleted. In this case, we return an attribute representing the new version of the attribute in B.

Parameters:
location - the location to examine
Returns:
a List of attributes
Throws:
java.lang.IllegalArgumentException - if location is null
PIMInternalException - if there is internal error
java.lang.UnsupportedOperationException - if the specified location is not valid for this item

getDeletedLocationAttributes

java.util.List<LocationAttributeInstance> getDeletedLocationAttributes(Category location)
Return a List of attributes that were present in A but are no longer present in B.

Parameters:
location - the location to examine
Returns:
a List of attributes
Throws:
java.lang.IllegalArgumentException - if location is null
PIMInternalException - if there is internal error
java.lang.UnsupportedOperationException - if the specified location is not valid for this item

getLocationsAddedAsAvailable

java.util.List<Category> getLocationsAddedAsAvailable(Category location)
Return a List of all available locations in B that were not marked available in A

Returns:
a List of all available locations
Throws:
PIMInternalException - if there is internal error
java.lang.IllegalArgumentException - if location is null

getLocationsRemovedAsAvailable

java.util.List<Category> getLocationsRemovedAsAvailable(Category location)
Return a List of all available locations in A that are no longer marked available in B

Returns:
a List of all available locations
Throws:
PIMInternalException - if there is internal error

getLocationsHavingChangedData

java.util.List<Category> getLocationsHavingChangedData(Category location)
Return a List of locations that are available in both A and B but have at least one location attribute at that location with different data values.

Returns:
a List of locations
Throws:
java.lang.IllegalArgumentException - if location is null
PIMInternalException - if there is internal error

getLocationsChangedToHaveData

java.util.List<Category> getLocationsChangedToHaveData(Category location)
Return a List of locations that are available in both A and B and have no data in A but do have data in B

Returns:
a List of locations
Throws:
java.lang.IllegalArgumentException - if location is null
PIMInternalException - if there is internal error

getLocationsChangedNotToHaveData

java.util.List<Category> getLocationsChangedNotToHaveData(Category location)
Return a List of locations that are available in both A and B and have no data in B but do have data in A

Returns:
a List of locations
Throws:
java.lang.IllegalArgumentException - if location is null
PIMInternalException - if there is internal error