|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface HierarchyMap
Mapping can be established between categories belonging to two hierarchies. This interface provides access to the mapping between two hierarchies. The existing mappings can be inspected and manipulated as well as new mapping can be added using the methods in this interface.
HierarchyManager.getHierarchyMap(Hierarchy, Hierarchy)()
Field Summary | |
---|---|
static java.lang.String |
copyright
|
Method Summary | |
---|---|
void |
addMapping(Category sourceCategory,
Category destinationCategory)
Adds a mapping between two categories to the hierarchymap. |
java.util.Collection<Category> |
getDestinationCategories(Category sourceCategory)
Returns a collection of destination categories the given source category is mapped to in this hierarchy map. |
Hierarchy |
getDestinationHierarchy()
Returns the destination hierarchy. |
java.util.Collection<Category> |
getSourceCategories()
Returns a collection of source categories in the hierarchy map. |
Hierarchy |
getSourceHierarchy()
Returns the source hierarchy. |
void |
removeAllMappings()
Removes all mappings in the hierarchymap. |
void |
removeMapping(Category sourceCategory,
Category destinationCategory)
Removes a mapping between two categories in the hierarchymap. |
void |
save()
Saves the hierarchy map |
Field Detail |
---|
static final java.lang.String copyright
Method Detail |
---|
void addMapping(Category sourceCategory, Category destinationCategory)
sourceCategory
- Category to map items fromdestinationCategory
- Category to map items to
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter has not yet been
savedjava.util.Collection<Category> getSourceCategories()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usejava.util.Collection<Category> getDestinationCategories(Category sourceCategory)
sourceCategory
- The source category in the hierarchy map
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- if sourceCategory is null
java.lang.IllegalStateException
- if sourceCategory has not yet been savedHierarchy getSourceHierarchy()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future useHierarchy getDestinationHierarchy()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid removeMapping(Category sourceCategory, Category destinationCategory)
sourceCategory
- Category to map fromdestinationCategory
- Category to map to
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
java.lang.IllegalArgumentException
- if any of the parameters is null
java.lang.IllegalStateException
- if any API object passed as a parameter has not yet been
savedvoid removeAllMappings()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future usevoid save()
PIMInternalException
- If an internal error occurs
PIMAuthorizationException
- Reserved for future use
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |