Uses of Interface
com.ibm.pim.hierarchy.category.Category

Packages that use Category
com.ibm.pim.attribute   
com.ibm.pim.catalog.item   
com.ibm.pim.collaboration   
com.ibm.pim.common   
com.ibm.pim.extensionpoints   
com.ibm.pim.hierarchy   
com.ibm.pim.hierarchy.category   
com.ibm.pim.search   
com.ibm.pim.selection   
com.ibm.pim.system   
com.ibm.pim.userdefinedlog   
 

Uses of Category in com.ibm.pim.attribute
 

Methods in com.ibm.pim.attribute that return Category
 Category InheritedValue.getLocation()
          Information on what location the inherited value came from
 Category LocationAttributeInstance.getLocation()
          Returns the LocationData object this LocationDataAttributeInstance belongs to.
 

Methods in com.ibm.pim.attribute that return types with arguments of type Category
 PIMCollection<Category> ExtendedAttributeOwner.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.
 java.util.List<Category> ExtendedAttributeChanges.getLocationsAddedAsAvailable(Category location)
          Return a List of all available locations in B that were not marked available in A
 java.util.List<Category> ExtendedAttributeChanges.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> ExtendedAttributeChanges.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> ExtendedAttributeChanges.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.
 PIMCollection<Category> ExtendedAttributeOwner.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.
 java.util.List<Category> ExtendedAttributeChanges.getLocationsRemovedAsAvailable(Category location)
          Return a List of all available locations in A that are no longer marked available in B
 

Methods in com.ibm.pim.attribute with parameters of type Category
 PIMCollection<Category> ExtendedAttributeOwner.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.
 java.util.List<LocationAttributeInstance> ExtendedAttributeChanges.getDeletedLocationAttributes(Category location)
          Return a List of attributes that were present in A but are no longer present in B.
 java.util.List<LocationAttributeInstance> ExtendedAttributeChanges.getDeletedLocationAttributes(Category location, boolean onlyLeafLevelAttributes)
          Return a List of attributes that were present in A but are no longer present in B.
 LocationAttributeInstance ExtendedAttributeOwner.getLocationAttributeInstance(Category location, java.lang.String attributeInstancePath)
          Retrieve the attribute instance at the specified path
 java.lang.Object ExtendedAttributeOwner.getLocationAttributeValue(Category location, java.lang.String attributeInstancePath)
          Retrieve the attribute value at the specified path for this entry at this location.
 java.util.List<Category> ExtendedAttributeChanges.getLocationsAddedAsAvailable(Category location)
          Return a List of all available locations in B that were not marked available in A
 java.util.List<Category> ExtendedAttributeChanges.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> ExtendedAttributeChanges.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> ExtendedAttributeChanges.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.
 PIMCollection<Category> ExtendedAttributeOwner.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.
 java.util.List<Category> ExtendedAttributeChanges.getLocationsRemovedAsAvailable(Category location)
          Return a List of all available locations in A that are no longer marked available in B
 java.util.List<LocationAttributeInstance> ExtendedAttributeChanges.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> ExtendedAttributeChanges.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.
 java.util.List<LocationAttributeInstance> ExtendedAttributeChanges.getNewlyAddedLocationAttributes(Category location)
          Return a List of attributes that were not present in A but present in B.
 java.util.List<LocationAttributeInstance> ExtendedAttributeChanges.getNewlyAddedLocationAttributes(Category location, boolean onlyLeafLevelAttributes)
          Return a List of attributes that were not present in A but present in B.
 LocationAttributeInstance ExtendedAttributeOwner.getRootLocationAttributeInstance(Category location)
          Retrieve the root attribute instance at the specified location.
 boolean ExtendedAttributeOwner.isAvailableInLocation(Category location)
          Determines if the item is available in the given location.
 void ExtendedAttributeOwner.makeAvailableInLocation(Category location)
          Make this item available at the given location.
 void ExtendedAttributeOwner.makeAvailableInLocationRecursively(Category location)
          Make this item available in given location and all its descendant locations.
 void ExtendedAttributeOwner.makeUnavailableInLocation(Category location)
          This will make the item unavailable in the given location.
 void ExtendedAttributeOwner.makeUnavailableInLocationRecursively(Category location)
          This will make the item unavailable in the given location and all its descendant locations.
 void ExtendedAttributeOwner.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.
 

Uses of Category in com.ibm.pim.catalog.item
 

Methods in com.ibm.pim.catalog.item that return types with arguments of type Category
 java.util.Collection<Category> Item.getCategories()
          Returns all the categories to which this item belongs.
 java.util.Collection<Category> Item.getCategories(Hierarchy hierarchy)
          Returns all the categories of the Hierarchy which is passed in, to which this item belongs.
 

Methods in com.ibm.pim.catalog.item with parameters of type Category
 void Item.addToCategory(Category category)
          Deprecated. use mapToCategory() instead.
 void Item.mapToCategory(Category category)
          Map an item to a category.
 void Item.removeFromCategory(Category category)
          Remove an item from a category.
 

Method parameters in com.ibm.pim.catalog.item with type arguments of type Category
 void Item.moveToCategories(java.util.Collection<Category> categories)
          Move item from existing categories to new set of categories.
 void Item.moveToCategoriesWithMapping(java.util.Collection<Category> categories)
          This method behaves exactly like Item.moveToCategories(Collection categories), the only difference being, even after the move to the new set of categories the mapping to the original category is maintained
 

Uses of Category in com.ibm.pim.collaboration
 

Methods in com.ibm.pim.collaboration that return Category
 Category CollaborationCategory.getSourceCategory()
           
 

Methods in com.ibm.pim.collaboration that return types with arguments of type Category
 java.util.Collection<Category> CollaborationItem.getCategories()
          Returns all the categories to which this item belongs.
 

Methods in com.ibm.pim.collaboration with parameters of type Category
 void CollaborationItem.addToCategory(Category category)
          Add this item to a category.
 void CategoryCollaborationArea.checkout(Category category)
          Checks out the specified category to the collaboration area.
 void CategoryCollaborationArea.checkout(Category category, CollaborationStep checkoutStep)
          Checks out the specified category to the collaboration area into the specified step.
 void CategoryCollaborationArea.checkout(Category category, CollaborationStep checkoutStep, java.lang.String commentString)
          Checks out the specified category to the collaboration area into the specified step.
 void CategoryCollaborationArea.checkout(Category category, java.lang.String commentString)
          Checks out the specified category to the collaboration area.
 CheckoutStatus CategoryCollaborationArea.checkoutAndWaitForStatus(Category category)
          Checks out the specified category to the collaboration area.
 CheckoutStatus CategoryCollaborationArea.checkoutAndWaitForStatus(Category category, CollaborationStep checkoutStep)
          Checks out the specified category to the collaboration area into the specified step.
 CheckoutStatus CategoryCollaborationArea.checkoutAndWaitForStatus(Category category, CollaborationStep checkoutStep, java.lang.String commentString)
          Checks out the specified category to the collaboration area into the specified step.
 CheckoutStatus CategoryCollaborationArea.checkoutAndWaitForStatus(Category category, java.lang.String commentString)
          Checks out the specified category to the collaboration area.
 void CollaborationItem.mapToCategory(Category category)
          Map an item to a category.
 void CollaborationItem.removeFromCategory(Category category)
          Remove an item from a category.
 

Method parameters in com.ibm.pim.collaboration with type arguments of type Category
 void CategoryCollaborationArea.checkout(java.util.Collection<Category> categories)
          Checks out the specified categories to the collaboration area.
 void CategoryCollaborationArea.checkout(java.util.Collection<Category> categories, CollaborationStep checkoutStep)
          Checks out the specified categories to the collaboration area into the specified step.
 void CategoryCollaborationArea.checkout(java.util.Collection<Category> categories, CollaborationStep checkoutStep, java.lang.String commentString)
          Checks out the specified categories to the collaboration area into the specified step.
 void CategoryCollaborationArea.checkout(java.util.Collection<Category> categories, java.lang.String commentString)
          Checks out the specified categories to the collaboration area.
 java.util.Map<java.lang.String,CheckoutStatus> CategoryCollaborationArea.checkoutAndWaitForStatus(java.util.Collection<Category> categories)
          Checks out the specified categories to the collaboration area.
 java.util.Map<java.lang.String,CheckoutStatus> CategoryCollaborationArea.checkoutAndWaitForStatus(java.util.Collection<Category> categories, CollaborationStep checkoutStep)
          Checks out the specified categories to the collaboration area into the specified step.
 java.util.Map<java.lang.String,CheckoutStatus> CategoryCollaborationArea.checkoutAndWaitForStatus(java.util.Collection<Category> categories, CollaborationStep checkoutStep, java.lang.String commentString)
          Checks out the specified categories to the collaboration area into the specified step.
 java.util.Map<java.lang.String,CheckoutStatus> CategoryCollaborationArea.checkoutAndWaitForStatus(java.util.Collection<Category> categories, java.lang.String commentString)
          Checks out the specified categories to the collaboration area.
 void CollaborationItem.moveToCategories(java.util.Collection<Category> categories)
          Move item from existing categories to new set of categories.
 void CollaborationItem.moveToCategoriesWithMapping(java.util.Collection<Category> categories)
          Move item from existing categories to new set of categories and add mappings.
 

Uses of Category in com.ibm.pim.common
 

Methods in com.ibm.pim.common that return types with arguments of type Category
 java.util.Collection<Category> ExtendedValidationErrors.getLocationsWithErrors()
          Returns a collection of locations associated with the source that have validation errors.
 

Methods in com.ibm.pim.common with parameters of type Category
 java.util.List<ValidationError> ExtendedValidationErrors.getErrorsForLocation(Category location)
          Returns the list of validation errors on the source for a given location.
 

Uses of Category in com.ibm.pim.extensionpoints
 

Methods in com.ibm.pim.extensionpoints that return Category
 Category PostCategorySaveFunctionArguments.getCategory()
          Obtains the current category for this invocation.
 Category EntryBuildFunctionArguments.getCategory()
          Obtains the category entry being processed for this EntryBuildFunction.
 Category DataEntryFunctionArguments.getCategory()
          Obtain the category for this DataEntryFunction.
 Category CategoryValidationRuleFunctionArguments.getCategory()
          Obtains the category to be processed by this rule function.
 Category CategoryStringEnumerationValueRuleFunctionArguments.getCategory()
          Obtains the category to be processed by this rule function.
 Category CategoryRunValueRuleFunctionArguments.getCategory()
          Obtains the category to be processed by this rule function.
 Category CategoryPrePostProcessingFunctionArguments.getCategory()
          Obtains the category to be processed by this pre/post function.
 Category CategoryNonPersistedAttributeRuleFunctionArguments.getCategory()
          Obtains the category to be processed by this rule function.
 Category CategoryMacroFunctionArguments.getCategory()
          Obtains the category entry being processed for this EntryMacroFunction.
 Category CategoryDefaultValueRuleFunctionArguments.getCategory()
          Obtains the category to be processed by this rule function.
 

Methods in com.ibm.pim.extensionpoints that return types with arguments of type Category
 PIMCollection<Category> CategoryPreviewFunctionArguments.getCategories()
          Obtains the categories for this EntryPreviewFunction.
 

Uses of Category in com.ibm.pim.hierarchy
 

Methods in com.ibm.pim.hierarchy that return Category
 Category Hierarchy.createCategory(java.lang.String parentCategoryPath, java.lang.String delimiter, java.lang.String pathValue)
          Returns a new category object.
 Category Hierarchy.createCategory(java.lang.String parentCategoryPath, java.lang.String delimiter, java.lang.String pathValue, java.lang.String primaryKeyValue)
          Returns a new category object.
 Category Hierarchy.getCategoryByPath(java.lang.String path)
          Retrieves a Category based upon Path name
 Category Hierarchy.getCategoryByPath(java.lang.String path, java.lang.String delimiter)
          Retrieves a Category based upon Path name
 Category Hierarchy.getCategoryByPrimaryKey(java.lang.String primaryKey)
          Retrieves a Category based upon Primary key
 Category Hierarchy.getRootCategory()
          Returns the root category for this Hierarchy
 

Methods in com.ibm.pim.hierarchy that return types with arguments of type Category
 PIMCollection<Category> Hierarchy.getCategories()
          Retrieves a collection of all the Category objects in this hierarchy.
 PIMCollection<Category> Hierarchy.getCategoriesAtLevel(int level)
          Retrieves a collection of all the Category objects in this hierarchy residing at a particular level.
 PIMCollection<Category> Hierarchy.getCategoriesByItemSecondarySpec(SecondarySpec spec)
          Retrieves a collection of all the Category objects in this hierarchy implementing a particular secondary spec.
 java.util.Collection<Category> Hierarchy.getCategoriesByPaths(java.util.Collection<java.lang.String> paths)
          Retrieves a collection of all the Category objects in this hierarchy based upon their path names.
 java.util.Collection<Category> Hierarchy.getCategoriesByPaths(java.util.Collection<java.lang.String> paths, java.lang.String delimiter)
          Retrieves a collection of all the Category objects in this hierarchy based upon their path names.
 PIMCollection<Category> Hierarchy.getCategoriesByStandAloneSpec(SecondarySpec spec)
          Retrieves a collection of all the Category objects in this hierarchy implementing a particular standalone spec.
 PIMCollection<Category> Hierarchy.getCategoriesWithAttributeValue(java.lang.String attributeInstancePath, java.lang.Object attributeValue)
          Retrieves a collection of all the Category objects in this hierarchy based upon a particular attribute value.
 java.util.Collection<Category> HierarchyMap.getDestinationCategories(Category sourceCategory)
          Returns a collection of destination categories the given source category is mapped to in this hierarchy map.
 java.util.Collection<Category> HierarchyMap.getSourceCategories()
          Returns a collection of source categories in the hierarchy map.
 

Methods in com.ibm.pim.hierarchy with parameters of type Category
 void HierarchyMap.addMapping(Category sourceCategory, Category destinationCategory)
          Adds a mapping between two categories to the hierarchymap.
 java.util.Collection<Category> HierarchyMap.getDestinationCategories(Category sourceCategory)
          Returns a collection of destination categories the given source category is mapped to in this hierarchy map.
 void HierarchyMap.removeMapping(Category sourceCategory, Category destinationCategory)
          Removes a mapping between two categories in the hierarchymap.
 

Uses of Category in com.ibm.pim.hierarchy.category
 

Methods in com.ibm.pim.hierarchy.category that return Category
 Category Category.getParent()
          Returns this category's parent.
 

Methods in com.ibm.pim.hierarchy.category that return types with arguments of type Category
 java.util.Collection<Category> Category.getChildren()
          Returns the categories immediately below this category.
 java.util.Collection<Category> Category.getChildren(Catalog catalog, boolean ordered, boolean restrictToSubtreeWithItems)
          Returns the categories immediately below this category.
 PIMCollection<Category> Category.getDescendents()
          Returns all the descendants of this category.
 java.util.Collection<Category> Category.getParents()
          Returns the parent categories of the given Category.
 

Methods in com.ibm.pim.hierarchy.category with parameters of type Category
 void Category.addChild(Category childCategory)
          Adds a category as a child of this category.
 void Category.removeChild(Category childCategory)
          Remove the given child Category from this category's children.
 

Uses of Category in com.ibm.pim.search
 

Methods in com.ibm.pim.search that return Category
 Category SearchResultSet.getCategory(int columnIndex)
          Get the value of a column in the current row as MDMPIM Category object.
 

Uses of Category in com.ibm.pim.selection
 

Methods in com.ibm.pim.selection that return types with arguments of type Category
 PIMCollection<Category> StaticItemSelection.getCategories()
          Fetches the categories present in the selection
 

Methods in com.ibm.pim.selection with parameters of type Category
 void StaticItemSelection.addCategory(Category category)
          Adds a category to the selection.
 void StaticItemSelection.removeCategory(Category category)
          Removes the category from the selection if it is present in the selection.
 

Uses of Category in com.ibm.pim.system
 

Methods in com.ibm.pim.system with parameters of type Category
 java.lang.String UIHelper.getCollaborationEntryURL(CollaborationStep collaborationStep, Category category)
          Returns a String object representing the URL which can be used to display the category in the collaborationStep
 java.lang.String UIHelper.getItemListURL(Catalog catalog, Category category)
          Returns a String object representing the URL which can be used to render all the items contained within the catalog that are grouped under the category on the List Items screen.
 java.lang.String UIHelper.getSingleEditURL(Category category)
          Returns a String object representing the URL which can be used to render the category on the Single Edit screen.
 

Uses of Category in com.ibm.pim.userdefinedlog
 

Methods in com.ibm.pim.userdefinedlog that return Category
 Category UserDefinedLogEntry.getTargetCategory()
          Fetches the category to which this UserDefinedLogEntry is associated.
 

Methods in com.ibm.pim.userdefinedlog with parameters of type Category
 UserDefinedLogEntry CategoryUserDefinedLog.createLogEntry(Category category, java.lang.String entry)
          Creates a UserDefinedLogEntry for a given category.
 UserDefinedLogEntry ItemUserDefinedLog.createLogEntry(Item item, Category category, java.lang.String entry)
          Creates a UserDefinedLogEntry for a given item which belongs to the specific category passed as argument.
 void CategoryUserDefinedLog.deleteEntries(Category category)
          Deletes the UserDefinedLogEntries corresponding to this category.
 void ItemUserDefinedLog.deleteEntries(Item item, Category category)
          Deletes the UserDefinedLogEntries corresponding to the item which belongs to the specific category passed as argument.
 PIMCollection<UserDefinedLogEntry> CategoryUserDefinedLog.getLogEntries(Category category)
          Fetches the UserDefinedLogEntry objects corresponding to the category passed in.
 PIMCollection<UserDefinedLogEntry> ItemUserDefinedLog.getLogEntries(Item item, Category category)
          Retrieves all UserDefinedLogEntry objects associated with the item which belongs to the specific category passed as argument.