A B C D E F G H I J L M N O P Q R S T U V W

A

accept(UserDefinedLogWriter) - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLog
Writes the UserDefinedLogEntries.
AccessControlGroup - Interface in com.ibm.pim.organization
Access control groups are used to set the permissions in accordance to which users can view/edit specific objects like catalogs, hierarchies, selections, workflows and collaboration areas.
add(E) - Method in interface com.ibm.pim.collection.PIMCollection
Add the ID of the specified PIM object to this PIM collection.
addAll(Collection<? extends E>) - Method in interface com.ibm.pim.collection.PIMCollection
Add all the elements in the specified collection to this collection.
addAllAttributes(Spec) - Method in interface com.ibm.pim.attribute.AttributeCollection
Adds all the attribute definitions from a Spec to the attribute collection.
addAllAttributes(Collection<AttributeDefinition>) - Method in interface com.ibm.pim.attribute.AttributeCollection
Adds all attribute defintions in a collection of AttributeDefinitions to this AttributeCollection, All attribute definitions of the collection will be added to the attribute collection.
addAllContents(ExportList.Type) - Method in interface com.ibm.pim.utils.ExportList
Adds contents of all objects of type specified by parameter 'type' to the export list.
addAllObjects(ExportList.Type, ExportList.ActionMode) - Method in interface com.ibm.pim.utils.ExportList
Adds all objects of type specified by parameter 'type' in the action mode specified by the parameter 'actionMode' to this export list.
addAllRequisites() - Method in interface com.ibm.pim.utils.ExportList
Adds all the objects on which the objects in this list are dependent on, to the list.
addAttribute(AttributeDefinition) - Method in interface com.ibm.pim.attribute.AttributeCollection
Adds an attribute to the attribute collection by specifying a AttributeDefinition.
addAttribute(String) - Method in interface com.ibm.pim.attribute.AttributeCollection
Adds an attribute to the attribute collection by specifying the path to the AttributeDefinition.
addCategory(Category) - Method in interface com.ibm.pim.selection.StaticItemSelection
Adds a category to the selection.
addChild(CollaborationCategory) - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Adds a category as a child of this category.
addChild(Category) - Method in interface com.ibm.pim.hierarchy.category.Category
Adds a category as a child of this category.
addChild(Organization) - Method in interface com.ibm.pim.organization.Organization
Adds a organization as a child of this organization.
addContent(ExportList.Type, Object) - Method in interface com.ibm.pim.utils.ExportList
Adds contents of objects to the ExportList
addCurrencies(List<Currency>) - Method in interface com.ibm.pim.organization.Company
Adds new Currencies to those available to this company
addCustomParameterValue(String, String) - Method in interface com.ibm.pim.catalog.Catalog
Add the given value to the set of values for the custom parameter with the given name.
addDistribution(Distribution) - Method in interface com.ibm.pim.utils.DistributionGroup
Adds a distribution to this distribution group
addFilter(String) - Method in interface com.ibm.pim.view.ScreenView
Add an empty filter with the specified name to the end of the list.
addFilter(String, int) - Method in interface com.ibm.pim.view.ScreenView
Add an empty filter with the specified name to the specified location in the list Attribute Collections can be added to the filter via ScreenViewFilter.addAttributeCollection or ScreenViewFilter.setAttributeCollections
addHierarchyMap(String, String) - Method in interface com.ibm.pim.utils.ImportList
Adds the hierarchy map to this list.
addIntoCollaborationArea(CollaborationCategory) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Allows a newly created category to be saved directly into a collaboration area, into the Initial step, instead of saving to a source hierarchy, for example during an import.
addIntoCollaborationArea(CollaborationCategory, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Allows a newly created category to be saved directly into a collaboration area, into the Initial step, instead of saving to a source hierarchy, for example during an import.
addIntoCollaborationArea(CollaborationCategory, CollaborationStep) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Allows a newly created category to be saved directly into a collaboration area, into a particular step, instead of saving to a source hierarchy, for example during an import.
addIntoCollaborationArea(CollaborationCategory, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Allows a newly created category to be saved directly into a collaboration area, into a particular step, instead of saving to a source hierarchy, for example during an import.
addIntoCollaborationArea(CollaborationItem) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Allow a newly created item to be saved directly into a collaboration area, into the Initial step, instead of saving to a source catalog, for example during an import.
addIntoCollaborationArea(CollaborationItem, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Allow a newly created item to be saved directly into a collaboration area, into the Initial step, instead of saving to a source catalog, for example during an import, with a comment.
addIntoCollaborationArea(CollaborationItem, CollaborationStep) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Allow a newly created item to be saved directly into a collaboration area, into a particular step, instead of saving to a source catalog, for example during an import.
addIntoCollaborationArea(CollaborationItem, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Allow a newly created item to be saved directly into a collaboration area, into a particular step, instead of saving to a source catalog, for example during an import, with a comment.
addItem(Item) - Method in interface com.ibm.pim.selection.StaticItemSelection
Adds an item to the selection.
addItemSecondarySpec(SecondarySpec, boolean, boolean) - Method in interface com.ibm.pim.hierarchy.category.Category
Associates a secondary item spec to this Category.
addItemSecondarySpec(SecondarySpec, Collection<Catalog>, boolean, boolean) - Method in interface com.ibm.pim.hierarchy.category.Category
Associates a secondary item spec to this Category.
addLocale(Locale) - Method in interface com.ibm.pim.spec.Spec
Add the given locale to the list of existing locales of this spec
addLocaleRestriction(Locale) - Method in interface com.ibm.pim.attribute.AttributeCollection
Adds a locale as a restricted locale for this attribute collection.
addLocales(List<Locale>) - Method in interface com.ibm.pim.organization.Company
Adds new Locales to those available to this company
addLocationDataConfiguration(Hierarchy, SecondarySpec) - Method in interface com.ibm.pim.catalog.Catalog
Adds location specific data for a catalog.
addMapping(Category, Category) - Method in interface com.ibm.pim.hierarchy.HierarchyMap
Adds a mapping between two categories to the hierarchymap.
addMapping(AttributeDefinition, AttributeDefinition) - Method in interface com.ibm.pim.spec.SpecMap
Adds a mapping between sourceAttributeDefinition and destinationAttributeDefinition in to the specMap The newly added mapping must be persisted by calling SpecMap.save() on the containing specMap
addNestedWorkflowStep(Workflow) - Method in interface com.ibm.pim.workflow.Workflow
Add another workflow as a nested workflow step into this workflow.
addObject(ExportList.Type, Object, ExportList.ActionMode) - Method in interface com.ibm.pim.utils.ExportList
Adds the objects of type specified by parameter 'type' in the action mode specified by the parameter 'actionMode' to the ExportList.
addObject(ExportList.Type, String) - Method in interface com.ibm.pim.utils.ImportList
Adds the object of specified type and name to this list.
addObjects(ExportList.Type) - Method in interface com.ibm.pim.utils.ImportList
Adds all the objects of the specified type to this list.
addOccurrence() - Method in interface com.ibm.pim.attribute.AttributeInstance
Add an occurrence to this attribute instance if this a multi-occurrence attribute .
addPerformer(Performer) - Method in interface com.ibm.pim.workflow.WorkflowStep
Override/set the performer for this step
addPerformers(Collection<Performer>) - Method in interface com.ibm.pim.workflow.WorkflowStep
Override/set the list of performers for this step
addSecondaryHierarchy(Hierarchy) - Method in interface com.ibm.pim.catalog.Catalog
Add the hierarchy as a secondary hierarchy to this Catalog
addSecondaryHierarchy(OrganizationHierarchy) - Method in interface com.ibm.pim.catalog.Catalog
Add the Organization hierarchy as a secondary hierarchy to this Catalog
addSecondarySpec(SecondarySpec) - Method in interface com.ibm.pim.hierarchy.category.Category
Associates a secondary spec defining this category’s attributes.
addSpec(Spec) - Method in interface com.ibm.pim.attribute.AttributeCollection
Adds a Spec to the attribute collection as a dynamic source of attributes.
addStep(String, String, WorkflowStep.Type) - Method in interface com.ibm.pim.workflow.Workflow
Add a workflow step to this workflow
addToCategory(Category) - Method in interface com.ibm.pim.catalog.item.Item
Deprecated. use mapToCategory() instead.
addToCategory(Category) - Method in interface com.ibm.pim.collaboration.CollaborationItem
Add this item to a category.
addValidationError(AttributeInstance, ValidationError.Type, String) - Method in interface com.ibm.pim.extensionpoints.CategoryPrePostProcessingFunctionArguments
Adds a validation error, constructed from the error type and error message, to the given attribute instance.
addValidationError(ValidationError.Type, String) - Method in interface com.ibm.pim.extensionpoints.CategoryRunValueRuleFunctionArguments
Adds a validation error, constructed from the given error type and error message, to the attribute instance for this rule function.
addValidationError(AttributeInstance, ValidationError.Type, String) - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPrePostProcessingFunctionArguments
Adds a validation error, constructed from the error type and error message, to the given attribute instance.
addValidationError(ValidationError.Type, String) - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryRunValueRuleFunctionArguments
Adds a validation error, constructed from the given error type and error message, to the attribute instance for this rule function.
addValidationError(AttributeInstance, ValidationError.Type, String) - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPrePostProcessingFunctionArguments
Adds a validation error, constructed from the error type and error message, to the given attribute instance.
addValidationError(ValidationError.Type, String) - Method in interface com.ibm.pim.extensionpoints.CollaborationItemRunValueRuleFunctionArguments
Adds a validation error, constructed from the given error type and error message, to the attribute instance for this rule function.
addValidationError(AttributeInstance, ValidationError.Type, String) - Method in interface com.ibm.pim.extensionpoints.ItemPrePostProcessingFunctionArguments
Adds a validation error, constructed from the error type and error message, to the given attribute instance.
addValidationError(ValidationError.Type, String) - Method in interface com.ibm.pim.extensionpoints.ItemRunValueRuleFunctionArguments
Adds a validation error, constructed from the given error type and error message, to the attribute instance for this rule function.
AdminHelper - Interface in com.ibm.pim.system
Interface providing admin methods.
areAllRequisitesMet() - Method in interface com.ibm.pim.utils.ExportList
Determines whether any object dependency is present for this export list.
areAllRequisitesMet() - Method in interface com.ibm.pim.utils.ImportList
Determines whether any object dependency is present.
associateUser(User) - Method in interface com.ibm.pim.organization.Organization
Associates a user with this Organization.
AttributeChanges - Interface in com.ibm.pim.attribute
 
AttributeCollection - Interface in com.ibm.pim.attribute
An AttributeCollection is a collection of Attribute Definitions.
AttributeCollectionManager - Interface in com.ibm.pim.attribute
Manager for the creation and retrieval of AttributeCollections
AttributeDefinition - Interface in com.ibm.pim.attribute
This interface provides methods pertaining to an attribute definition within a Spec object.
AttributeDefinition.Type - Enum in com.ibm.pim.attribute
Attribute definition types.
AttributeDefinitionProperty - Interface in com.ibm.pim.attribute
This interface provides methods to define and modify properties of an attribute An AttributeDefinitionProperty can have single or multiple values depending on the property type.
AttributeDefinitionProperty.Name - Enum in com.ibm.pim.attribute
All possible property names of an attribute definition.
AttributeInstance - Interface in com.ibm.pim.attribute
An AttributeInstance is on object representing an occurrence of a data value AttributeDefinition on a particular Item or Category.
AttributeOwner - Interface in com.ibm.pim.attribute
This is the group of common methods for objects that have Spec Driven attributes.
AttributePathHelper - Interface in com.ibm.pim.attribute
String attribute paths are used in MDMPIM for a number of purposes: For retrieving attribute definitions Inside an Attribute Collection to specify which fields which will be included in that attribute collection For creating or retrieving data for a particular attribute (field) on an item, category, location or organization - an Attribute Instance For specifying data for optional attributes on a item, category or location For specifying and retrieving data occurrences on an item or category, for multi-occurrence attributes

B

Batchable - Interface in com.ibm.pim.common
The Batchable interface specifies the set of methods that a class needs to implement to allow persistence to the data store in a batched manner as opposed to singleton object saves.
BatchStatistics - Interface in com.ibm.pim.common
Interface that provides statistics information about a batched operation.

C

canAddOccurrence() - Method in interface com.ibm.pim.attribute.AttributeInstance
Determine if the current attribute instance allows another child occurrence to be created Return true if the attribute instance meets all of the following conditions:
Catalog - Interface in com.ibm.pim.catalog
Catalogs are repositories or containers for items
catalogExport(CatalogExportFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunction
Export a catalog.
CatalogExportFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Catalog Export function.
CatalogExportFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to Catalog Export Function invocations.
CatalogExportFunctionArguments.CatalogExportDiffStatus - Interface in com.ibm.pim.extensionpoints
 
CatalogManager - Interface in com.ibm.pim.catalog
Catalog Manager, providing methods to create new and retrieve existing Catalog Objects
catalogPreview(CatalogPreviewFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.CatalogPreviewFunction
Create a 'preview' of a Catalog.
CatalogPreviewFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Catalog Preview function
CatalogPreviewFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to CatalogPreviewFunction invocations.
catalogToCatalogExport(CatalogToCatalogExportFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunction
Perform a Catalog to Catalog Export
CatalogToCatalogExportFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Catalog To Catalog Export function
CatalogToCatalogExportFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to CatalogToCatalogExportFunction invocations.
Category - Interface in com.ibm.pim.hierarchy.category
Interface for Category object (belongs to a Hierarchy, and groups Items)
Category.SaveResult - Enum in com.ibm.pim.hierarchy.category
Describes the Category Status after a Save operation
CategoryCollaborationArea - Interface in com.ibm.pim.collaboration
The JAVA API interface CategoryCollaborationArea lets you access a category Collaboration Area.
CategoryDefaultValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CategoryImport - Interface in com.ibm.pim.job
Interface for Category import type
CategoryMacroFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to EntryMacroFunction invocations.
CategoryNonPersistedAttributeRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CategoryPrePostProcessingFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to PrePostProcessingFunction invocations.
CategoryPreviewFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CategoryRunValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CategoryStringEnumerationValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CategoryStringEnumerationValueRuleFunctionArguments.CategoryReRunPerOccurrenceControl - Interface in com.ibm.pim.extensionpoints
Interface to allow the value rule to control the rerun per occurence flag available within the corresponding script type as the variable 'run_rule_per_occurrence'
CategoryUserDefinedLog - Interface in com.ibm.pim.userdefinedlog
Interface representing a UserDefinedLog object that holds log entries for categories.
CategoryValidationRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CharSet - Enum in com.ibm.pim.utils
Interface for CharSet
checkout(Collection<Category>) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified categories to the collaboration area.
checkout(Collection<Category>, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified categories to the collaboration area.
checkout(Collection<Category>, CollaborationStep) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified categories to the collaboration area into the specified step.
checkout(Collection<Category>, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified categories to the collaboration area into the specified step.
checkout(Category) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified category to the collaboration area.
checkout(Category, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified category to the collaboration area.
checkout(Category, CollaborationStep) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified category to the collaboration area into the specified step.
checkout(Category, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified category to the collaboration area into the specified step.
checkout(Collection<Item>) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Checks out the specified items to the collaboration area.
checkout(Collection<Item>, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Checks out the specified items to the collaboration area, with a comment.
checkout(Collection<Item>, CollaborationStep) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Checks out the specified items to the collaboration area into the specified step.
checkout(Collection<Item>, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Checks out the specified items to the collaboration area into a specified step.
checkout(Item) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Checks out the specified item to the collaboration area.
checkout(Item, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Checks out the specified item to the collaboration area, with a comment.
checkout(Item, CollaborationStep) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Checks out the specified item to the collaboration area into a specified step.
checkout(Item, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Checks out the specified item to the collaboration area into a specified step, with a comment.
checkoutAndWaitForStatus(Collection<Category>) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified categories to the collaboration area.
checkoutAndWaitForStatus(Collection<Category>, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified categories to the collaboration area.
checkoutAndWaitForStatus(Collection<Category>, CollaborationStep) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified categories to the collaboration area into the specified step.
checkoutAndWaitForStatus(Collection<Category>, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified categories to the collaboration area into the specified step.
checkoutAndWaitForStatus(Category) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified category to the collaboration area.
checkoutAndWaitForStatus(Category, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified category to the collaboration area.
checkoutAndWaitForStatus(Category, CollaborationStep) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified category to the collaboration area into the specified step.
checkoutAndWaitForStatus(Category, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Checks out the specified category to the collaboration area into the specified step.
checkoutAndWaitForStatus(Collection<Item>) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Schedule the concurrent checkout of the specified items to the collaboration area.
checkoutAndWaitForStatus(Collection<Item>, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Schedule the concurrent checkout of the specified items to the collaboration area, with a comment.
checkoutAndWaitForStatus(Collection<Item>, CollaborationStep) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Schedule the concurrent checkout of the specified items to the collaboration area into a specified step.
checkoutAndWaitForStatus(Collection<Item>, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Schedule the concurrent checkout of the specified items to a collaboration area into a specified step, with a comment.
checkoutAndWaitForStatus(Item) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Schedule the concurrent checkout of the specified items to a collaboration area.
checkoutAndWaitForStatus(Item, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Schedule the concurrent checkout of the specified items to a collaboration area, with a comment.
checkoutAndWaitForStatus(Item, CollaborationStep) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Schedule the concurrent checkout of the specified item to a collaboration area into a specified step.
checkoutAndWaitForStatus(Item, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Schedule the concurrent checkout of the specified items to a collaboration area into a specified step, with a comment.
CheckoutStatus - Enum in com.ibm.pim.collaboration
An enum class used for specifying the status of a checkout event on a collaboration object, such as an item or a category, within a collaboration area.
cleanUp() - Method in interface com.ibm.pim.context.Context
Clean up the resources that are used in the context.
clear() - Method in interface com.ibm.pim.collection.PIMCollection
Remove all the elements from this collection, making it empty.
CollaborationArea - Interface in com.ibm.pim.collaboration
The JAVA API interface CollaborationArea lets you access a Collaboration Area in MDMPIM, as seen by the user.
CollaborationAreaManager - Interface in com.ibm.pim.collaboration
Read-write interface for the manager of Collaboration Area objects.
CollaborationCategory - Interface in com.ibm.pim.collaboration
The JAVA API interface CollaborationCategory represents a category object that has been checked out to a collaboration area and collaborated upon.
CollaborationCategoryDefaultValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationCategoryMacroFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to EntryMacroFunction invocations.
CollaborationCategoryNonPersistedAttributeRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationCategoryPrePostProcessingFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to PrePostProcessingFunction invocations.
CollaborationCategoryPreviewFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationCategoryRunValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationCategoryStringEnumerationValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationCategoryStringEnumerationValueRuleFunctionArguments.CollaborationCategoryReRunPerOccurrenceControl - Interface in com.ibm.pim.extensionpoints
Interface to allow the value rule to control the rerun per occurence flag available within the corresponding script type as the variable 'run_rule_per_occurrence'
CollaborationCategoryValidationRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationHistoryEvent - Interface in com.ibm.pim.collaboration
The Java API interface CollaborationHistoryEvent represents a collaboration history event for a collaboration area.
CollaborationItem - Interface in com.ibm.pim.collaboration
The JAVA API interface CollaborationItem represents an item object that has been checked out to a collaboration area and collaborated upon.
CollaborationItem.SaveResult - Enum in com.ibm.pim.collaboration
Describes the Item Status after a Save operation
CollaborationItemDefaultValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationItemMacroFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to EntryMacroFunction invocations.
CollaborationItemNonPersistedAttributeRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationItemPrePostProcessingFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to PrePostProcessingFunction invocations.
CollaborationItemPreviewFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationItemRunValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationItemStringEnumerationValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationItemStringEnumerationValueRuleFunctionArguments.CollaborationItemReRunPerOccurrenceControl - Interface in com.ibm.pim.extensionpoints
Interface to allow the value rule to control the rerun per occurence flag available within the corresponding script type as the variable 'run_rule_per_occurrence'
CollaborationItemValidationRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
CollaborationObject - Interface in com.ibm.pim.collaboration
The Java API interface CollaborationObject represents an object that can be checked out to a collaboration area and operated upon in a cooperative protocol.
CollaborationObject.Type - Enum in com.ibm.pim.collaboration
 
CollaborationStep - Interface in com.ibm.pim.collaboration
CollaborationStep represents an instance of a workflow step in a collaboration area.
CollaborationStepTransitionConfiguration - Interface in com.ibm.pim.collaboration
The interface CollaborationStepTransitionConfiguration represents a configuration for the transition of one or more collaboration objects moving together on a particular exit value out of a collaboration step.
com.ibm.pim.attribute - package com.ibm.pim.attribute
 
com.ibm.pim.catalog - package com.ibm.pim.catalog
 
com.ibm.pim.catalog.item - package com.ibm.pim.catalog.item
 
com.ibm.pim.collaboration - package com.ibm.pim.collaboration
 
com.ibm.pim.collection - package com.ibm.pim.collection
 
com.ibm.pim.common - package com.ibm.pim.common
 
com.ibm.pim.common.exceptions - package com.ibm.pim.common.exceptions
 
com.ibm.pim.context - package com.ibm.pim.context
 
com.ibm.pim.docstore - package com.ibm.pim.docstore
 
com.ibm.pim.extensionpoints - package com.ibm.pim.extensionpoints
 
com.ibm.pim.hierarchy - package com.ibm.pim.hierarchy
 
com.ibm.pim.hierarchy.category - package com.ibm.pim.hierarchy.category
 
com.ibm.pim.job - package com.ibm.pim.job
 
com.ibm.pim.lookuptable - package com.ibm.pim.lookuptable
 
com.ibm.pim.organization - package com.ibm.pim.organization
 
com.ibm.pim.search - package com.ibm.pim.search
 
com.ibm.pim.selection - package com.ibm.pim.selection
 
com.ibm.pim.spec - package com.ibm.pim.spec
 
com.ibm.pim.system - package com.ibm.pim.system
 
com.ibm.pim.userdefinedlog - package com.ibm.pim.userdefinedlog
 
com.ibm.pim.utils - package com.ibm.pim.utils
 
com.ibm.pim.view - package com.ibm.pim.view
 
com.ibm.pim.webservice - package com.ibm.pim.webservice
 
com.ibm.pim.workflow - package com.ibm.pim.workflow
 
commit() - Method in interface com.ibm.pim.context.Context
Commit transaction.
Company - Interface in com.ibm.pim.organization
Interface for Company object.
contains(String) - Method in interface com.ibm.pim.attribute.AttributeCollection
Checks if an attribute definition is present in this attribute collection.
contains(AttributeDefinition) - Method in interface com.ibm.pim.attribute.AttributeCollection
Checks if an attribute definition is present in this attribute collection.
contains(Object) - Method in interface com.ibm.pim.collection.PIMCollection
Check if the object o is in the collection.
containsAll(Collection<?>) - Method in interface com.ibm.pim.collection.PIMCollection
Check if all the elements of Collection c are within this PIMCollection.
containsItem(String) - Method in interface com.ibm.pim.catalog.Catalog
Identifies if the catalog contains an item with the given primary key.
Context - Interface in com.ibm.pim.context
Interface providing methods for Context
copyright - Static variable in interface com.ibm.pim.attribute.AttributeChanges
 
copyright - Static variable in interface com.ibm.pim.attribute.AttributeCollection
 
copyright - Static variable in interface com.ibm.pim.attribute.AttributeDefinition
 
copyright - Static variable in interface com.ibm.pim.attribute.AttributeDefinitionProperty
 
copyright - Static variable in interface com.ibm.pim.attribute.AttributeInstance
 
copyright - Static variable in interface com.ibm.pim.attribute.AttributeOwner
 
copyright - Static variable in interface com.ibm.pim.attribute.AttributePathHelper
 
copyright - Static variable in interface com.ibm.pim.attribute.InheritedValue
 
copyright - Static variable in interface com.ibm.pim.catalog.item.Item
 
copyright - Static variable in interface com.ibm.pim.catalog.LocationDataConfiguration
 
copyright - Static variable in interface com.ibm.pim.collaboration.CollaborationArea
 
copyright - Static variable in interface com.ibm.pim.collaboration.CollaborationHistoryEvent
 
copyright - Static variable in interface com.ibm.pim.collaboration.CollaborationObject
 
copyright - Static variable in interface com.ibm.pim.collaboration.CollaborationStep
 
copyright - Static variable in interface com.ibm.pim.collaboration.CollaborationStepTransitionConfiguration
 
copyright - Static variable in interface com.ibm.pim.collection.PIMCollection
 
copyright - Static variable in interface com.ibm.pim.common.Batchable
 
copyright - Static variable in interface com.ibm.pim.common.BatchStatistics
 
copyright - Static variable in exception com.ibm.pim.common.exceptions.PIMAlreadyInTransactionException
 
copyright - Static variable in exception com.ibm.pim.common.exceptions.PIMAuthenticationException
 
copyright - Static variable in exception com.ibm.pim.common.exceptions.PIMAuthorizationException
 
copyright - Static variable in exception com.ibm.pim.common.exceptions.PIMException
 
copyright - Static variable in exception com.ibm.pim.common.exceptions.PIMInternalException
 
copyright - Static variable in exception com.ibm.pim.common.exceptions.PIMInvalidOperationException
 
copyright - Static variable in exception com.ibm.pim.common.exceptions.PIMInvalidPathException
 
copyright - Static variable in exception com.ibm.pim.common.exceptions.PIMSearchException
 
copyright - Static variable in exception com.ibm.pim.common.exceptions.PIMUndefinedValueException
 
copyright - Static variable in interface com.ibm.pim.common.Manager
 
copyright - Static variable in interface com.ibm.pim.common.ProcessingOptions
 
copyright - Static variable in interface com.ibm.pim.common.ValidationError
 
copyright - Static variable in interface com.ibm.pim.common.ValidationErrors
 
copyright - Static variable in interface com.ibm.pim.common.VersionInfo
 
copyright - Static variable in interface com.ibm.pim.context.Context
 
copyright - Static variable in class com.ibm.pim.context.PIMContextFactory
 
copyright - Static variable in class com.ibm.pim.context.PIMWebServicesContextFactory
 
copyright - Static variable in interface com.ibm.pim.docstore.Directory
 
copyright - Static variable in interface com.ibm.pim.docstore.Document
 
copyright - Static variable in interface com.ibm.pim.docstore.DocumentAuditLog
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CatalogExportFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CatalogPreviewFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CatalogPreviewFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CategoryDefaultValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CategoryMacroFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CategoryNonPersistedAttributeRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CategoryPrePostProcessingFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CategoryPreviewFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CategoryRunValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CategoryStringEnumerationValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CategoryValidationRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationCategoryDefaultValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationCategoryMacroFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationCategoryNonPersistedAttributeRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationCategoryPrePostProcessingFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationCategoryPreviewFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationCategoryRunValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationCategoryStringEnumerationValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationCategoryValidationRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationItemDefaultValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationItemMacroFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationItemNonPersistedAttributeRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationItemPrePostProcessingFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationItemPreviewFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationItemRunValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationItemStringEnumerationValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CollaborationItemValidationRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CustomToolsFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.CustomToolsFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.DataEntryFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.DataEntryFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.DefaultValueRuleFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.DistributionFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.DistributionFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.EntryBuildFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.EntryBuildFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.EntryMacroFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.EntryPreviewFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.FunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ImportFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ItemDefaultValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ItemMacroFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ItemNonPersistedAttributeRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ItemPrePostProcessingFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ItemPreviewFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ItemRunValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ItemStringEnumerationValueRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ItemValidationRuleFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.NonPersistedAttributeRuleFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.PostCategorySaveFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.PostCollaborationCategorySaveFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.PostCollaborationItemSaveFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.PostItemSaveFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.PostSaveFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.PrePostProcessingFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ReportGenerateFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ReportGenerateFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.RichSearchReportFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.RichSearchReportFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.RunValueRuleFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ScriptingSandboxFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ScriptingSandboxFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.StringEnumerationValueRuleFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.TriggerFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.TriggerFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.ValidationRuleFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.WorkflowStepFunction
 
copyright - Static variable in interface com.ibm.pim.extensionpoints.WorkflowStepFunctionArguments
 
copyright - Static variable in interface com.ibm.pim.hierarchy.category.Category
 
copyright - Static variable in interface com.ibm.pim.hierarchy.Hierarchy
 
copyright - Static variable in interface com.ibm.pim.hierarchy.HierarchyManager
 
copyright - Static variable in interface com.ibm.pim.hierarchy.HierarchyMap
 
copyright - Static variable in interface com.ibm.pim.job.Job
 
copyright - Static variable in interface com.ibm.pim.job.JobManager
 
copyright - Static variable in interface com.ibm.pim.job.Schedule
 
copyright - Static variable in interface com.ibm.pim.job.ScheduleStatus
 
copyright - Static variable in interface com.ibm.pim.lookuptable.LookupTable
 
copyright - Static variable in interface com.ibm.pim.lookuptable.LookupTableEntry
 
copyright - Static variable in interface com.ibm.pim.lookuptable.LookupTableManager
 
copyright - Static variable in interface com.ibm.pim.organization.AccessControlGroup
 
copyright - Static variable in interface com.ibm.pim.organization.Company
 
copyright - Static variable in interface com.ibm.pim.organization.Organization
 
copyright - Static variable in interface com.ibm.pim.organization.OrganizationHierarchy
 
copyright - Static variable in interface com.ibm.pim.organization.OrganizationManager
 
copyright - Static variable in interface com.ibm.pim.organization.Performer
 
copyright - Static variable in interface com.ibm.pim.organization.Role
 
copyright - Static variable in interface com.ibm.pim.organization.User
 
copyright - Static variable in interface com.ibm.pim.search.SearchQuery
 
copyright - Static variable in interface com.ibm.pim.search.SearchResultSet
 
copyright - Static variable in interface com.ibm.pim.selection.DynamicCollaborationItemSelection
 
copyright - Static variable in interface com.ibm.pim.selection.DynamicItemSelection
 
copyright - Static variable in interface com.ibm.pim.selection.DynamicSelection
 
copyright - Static variable in interface com.ibm.pim.selection.Selection
 
copyright - Static variable in interface com.ibm.pim.selection.SelectionManager
 
copyright - Static variable in interface com.ibm.pim.selection.StaticItemSelection
 
copyright - Static variable in interface com.ibm.pim.selection.StaticSelection
 
copyright - Static variable in interface com.ibm.pim.spec.DestinationSpec
 
copyright - Static variable in interface com.ibm.pim.spec.FileSpec
 
copyright - Static variable in interface com.ibm.pim.spec.LookupSpec
 
copyright - Static variable in interface com.ibm.pim.spec.PrimarySpec
 
copyright - Static variable in interface com.ibm.pim.spec.ScriptInputSpec
 
copyright - Static variable in interface com.ibm.pim.spec.SecondarySpec
 
copyright - Static variable in interface com.ibm.pim.spec.Spec
 
copyright - Static variable in interface com.ibm.pim.spec.SpecManager
 
copyright - Static variable in interface com.ibm.pim.spec.SpecMap
 
copyright - Static variable in interface com.ibm.pim.spec.SubSpec
 
copyright - Static variable in interface com.ibm.pim.system.AdminHelper
 
copyright - Static variable in interface com.ibm.pim.system.PIMProgress
 
copyright - Static variable in interface com.ibm.pim.system.PIMScript
 
copyright - Static variable in interface com.ibm.pim.system.PIMScriptManager
 
copyright - Static variable in interface com.ibm.pim.system.PIMWriter
 
copyright - Static variable in interface com.ibm.pim.system.ScriptStatistics
 
copyright - Static variable in interface com.ibm.pim.system.UIHelper
 
copyright - Static variable in interface com.ibm.pim.userdefinedlog.UserDefinedLog
 
copyright - Static variable in interface com.ibm.pim.userdefinedlog.UserDefinedLogEntry
 
copyright - Static variable in interface com.ibm.pim.userdefinedlog.UserDefinedLogWriter
 
copyright - Static variable in interface com.ibm.pim.utils.DataSource
 
copyright - Static variable in interface com.ibm.pim.utils.Distribution
 
copyright - Static variable in interface com.ibm.pim.utils.DistributionGroup
 
copyright - Static variable in interface com.ibm.pim.utils.EnvironmentExporter
 
copyright - Static variable in interface com.ibm.pim.utils.EnvironmentImporter
 
copyright - Static variable in interface com.ibm.pim.utils.ExportList
 
copyright - Static variable in interface com.ibm.pim.utils.ExportRequisiteList
 
copyright - Static variable in interface com.ibm.pim.utils.IISIntegration
 
copyright - Static variable in interface com.ibm.pim.utils.ImportRequisiteList
 
copyright - Static variable in interface com.ibm.pim.utils.Logger
 
copyright - Static variable in interface com.ibm.pim.utils.RoutingManager
 
copyright - Static variable in interface com.ibm.pim.utils.TimezoneResolver
 
copyright - Static variable in interface com.ibm.pim.view.ScreenView
 
copyright - Static variable in interface com.ibm.pim.view.ScreenViewFilter
 
copyright - Static variable in interface com.ibm.pim.view.View
 
copyright - Static variable in interface com.ibm.pim.webservice.WebService
 
copyright - Static variable in interface com.ibm.pim.webservice.WebServiceManager
 
copyright - Static variable in interface com.ibm.pim.webservice.WebServiceTransaction
 
copyright - Static variable in interface com.ibm.pim.workflow.ExitValue
 
copyright - Static variable in interface com.ibm.pim.workflow.Workflow
 
copyright - Static variable in interface com.ibm.pim.workflow.WorkflowStep
 
copyTo(String) - Method in interface com.ibm.pim.docstore.Document
Copies the document to documentPath.
createAccessControlGroup(String, String, Role, EnumSet<Permission>) - Method in interface com.ibm.pim.organization.OrganizationManager
Creates an access control group object with the specified acg name and acg description.
createAndPersistDocument(String) - Method in interface com.ibm.pim.docstore.DocstoreManager
Creates an empty document at the specified documentPath and persists it.
createAndPersistDocument(String, AccessControlGroup) - Method in interface com.ibm.pim.docstore.DocstoreManager
Creates an empty document at the specified documentPath and sets the given access control group for the document.
createAttributeCollection(String) - Method in interface com.ibm.pim.attribute.AttributeCollectionManager
Creates an empty attribute collection with the specified name.
createAttributeDefinition(String, int) - Method in interface com.ibm.pim.spec.Spec
Create a new attribute definition under this spec.
createAttributePath(String, ArrayList<String>) - Method in interface com.ibm.pim.attribute.AttributePathHelper
Construct an attribute path from a spec name, and a list of attribute names.
createCatalog(PrimarySpec, String, Hierarchy) - Method in interface com.ibm.pim.catalog.CatalogManager
Builds a new catalog with the given spec and name and AccessControlGroup.
createCatalog(PrimarySpec, String, Hierarchy, AccessControlGroup) - Method in interface com.ibm.pim.catalog.CatalogManager
Builds a new catalog with the given spec and name.
createCategory(String, String, String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Returns a new category object.
createCategory(String, String, String, String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Returns a new category object.
createCategoryCollaborationArea(String, Workflow, Hierarchy) - Method in interface com.ibm.pim.collaboration.CollaborationAreaManager
Create a collaboration area from a category workflow for the specified hierarchy.
createCategoryImport(String, DataSource, FileSpec, Hierarchy, Map<Import.OptionalArguments, Object>) - Method in interface com.ibm.pim.job.JobManager
Creates a new hierarchy feed type import.
createCategoryImport(String, DataSource, FileSpec, CategoryCollaborationArea, String, Map<Import.OptionalArguments, Object>) - Method in interface com.ibm.pim.job.JobManager
Creates a new hierarchy feed type import into CollaborationArea.
createCategoryWorkflow(String, String, AccessControlGroup) - Method in interface com.ibm.pim.workflow.WorkflowManager
Create an empty Category Workflow with Initial, Success, Failure steps and Initial routed to Success.
createCategoryWorkflow(String, String) - Method in interface com.ibm.pim.workflow.WorkflowManager
Create an empty Category Workflow with Initial, Success, Failure steps and Initial routed to Success.
createCollaborationCategory(String, String, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Returns a new collaboration category object.
createCollaborationCategory(String, String, String, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Returns a new collaboration category object.
createCollaborationItem(String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Create a collaboration item in the current item collaboration area.
createDataSource(String, DataSource.Type) - Method in interface com.ibm.pim.utils.RoutingManager
Creates a datasource for MDMPIM
createDistribution(String, Distribution.Type) - Method in interface com.ibm.pim.utils.RoutingManager
Creates MDMPIM Distributions with a given type Returns the created Distribution Object
createDistributionGroup(String) - Method in interface com.ibm.pim.utils.RoutingManager
Creates MDMPIM DistributionGroup with a given Name Returns the created DistributionGroup Object
createDynamicCollaborationItemSelection(String, String) - Method in interface com.ibm.pim.selection.SelectionManager
Creates a DynamicCollaborationItemSelection.
createDynamicItemSelection(String, String) - Method in interface com.ibm.pim.selection.SelectionManager
Creates a DynamicItemSelection.
createEntry() - Method in interface com.ibm.pim.lookuptable.LookupTable
Creates a new LookupTableEntry.
createExitValue(String) - Method in interface com.ibm.pim.workflow.WorkflowStep
Add a new exit value, using the string passed in, for this Workflow Step.
createExitValue(ExitValue) - Method in interface com.ibm.pim.workflow.WorkflowStep
Add a new exit value, using the ExitValue object passed in, for this Workflow Step.
createExport(String, DestinationSpec, Catalog, SpecMap, Export.Type, Map<Export.OptionalArguments, Object>) - Method in interface com.ibm.pim.job.JobManager
Creates a new export.
createExportList() - Method in interface com.ibm.pim.utils.EnvironmentExporter
Returns a container(ExportList) to hold the names of PIM objects to be exported.
createFileSpec(String, FileSpec.FileType) - Method in interface com.ibm.pim.spec.SpecManager
Create a new file spec, supports setting of file type for FileSpec types.
createHierarchy(PrimarySpec, String) - Method in interface com.ibm.pim.hierarchy.HierarchyManager
Creates a new hierarchy object.
createHierarchy(PrimarySpec, String, AttributeDefinition) - Method in interface com.ibm.pim.hierarchy.HierarchyManager
Creates a new hierarchy object.
createHierarchy(PrimarySpec, String, AttributeDefinition, AccessControlGroup, AttributeDefinition) - Method in interface com.ibm.pim.hierarchy.HierarchyManager
Create a new hierarchy object.
createItem() - Method in interface com.ibm.pim.catalog.Catalog
Create a new item in the Catalog.
createItemCollaborationArea(String, Workflow, Catalog) - Method in interface com.ibm.pim.collaboration.CollaborationAreaManager
Create a collaboration area from an item workflow for the specified catalog.
createItemImport(String, DataSource, FileSpec, Catalog, Map<Import.OptionalArguments, Object>) - Method in interface com.ibm.pim.job.JobManager
Creates a new Item feed type import.
createItemImport(String, DataSource, FileSpec, ItemCollaborationArea, String, Map<Import.OptionalArguments, Object>) - Method in interface com.ibm.pim.job.JobManager
Creates a new Item feed type import into CollaborationArea.
createItemWorkflow(String, String, AccessControlGroup) - Method in interface com.ibm.pim.workflow.WorkflowManager
Create an empty Item Workflow with Initial, Success, Failure steps and Initial routed to Success.
createItemWorkflow(String, String) - Method in interface com.ibm.pim.workflow.WorkflowManager
Create an empty Item Workflow with Initial, Success, Failure steps and Initial routed to Success.
createLogEntry(Category, String) - Method in interface com.ibm.pim.userdefinedlog.CategoryUserDefinedLog
Creates a UserDefinedLogEntry for a given category.
createLogEntry(Item, String) - Method in interface com.ibm.pim.userdefinedlog.ItemUserDefinedLog
Creates a UserDefinedLogEntry for a given item.The UserDefinedLogEntry object must be persisted by calling UserDefinedLog.save() on the containing UserDefinedLog
createLogEntry(Item, Category, String) - Method in interface com.ibm.pim.userdefinedlog.ItemUserDefinedLog
Creates a UserDefinedLogEntry for a given item which belongs to the specific category passed as argument.
createLookupTable(LookupSpec, String) - Method in interface com.ibm.pim.lookuptable.LookupTableManager
Returns a new lookup table with the given spec and name
createOrganization(String, String, String) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Returns a new organization object.
createOrganization(String, String, String, String) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Returns a new organization object.
createOrganizationHierarchy(PrimarySpec, String) - Method in interface com.ibm.pim.organization.OrganizationManager
Creates a new organization hierarchy object.
createOrganizationHierarchy(PrimarySpec, String, AttributeDefinition, AccessControlGroup, AttributeDefinition) - Method in interface com.ibm.pim.organization.OrganizationManager
Create a new organization hierarchy object.
createProperty(AttributeDefinitionProperty.Name) - Method in interface com.ibm.pim.attribute.AttributeDefinition
Factory method to create a new property for this attribute
createReport(String, Document, ScriptInputSpec, Distribution) - Method in interface com.ibm.pim.job.JobManager
Creates a new report
createRole(String, String) - Method in interface com.ibm.pim.organization.OrganizationManager
Creates a role with the specified parameters.
createSchedule(Job) - Method in interface com.ibm.pim.job.JobManager
Runs the specified job immediately.
createSchedule(Job, String, Schedule.Type) - Method in interface com.ibm.pim.job.JobManager
Runs the specified job with the given schedule type, based on the current time.
createSchedule(Job, String, int) - Method in interface com.ibm.pim.job.JobManager
Runs the specified job with type of Schedule.Type.MINUTE for every time of the given interval minutes based on the current time.
createSchedule(Job, String, Schedule.Type, Date) - Method in interface com.ibm.pim.job.JobManager
Runs the specified job with the given schedule type and running time.
createSearchQuery(String) - Method in interface com.ibm.pim.context.Context
Obtain a Query object for the specified query String
createSpec(String, Spec.Type) - Method in interface com.ibm.pim.spec.SpecManager
Create a new spec
createSpecMap(String, SpecMap.Type, String, String) - Method in interface com.ibm.pim.spec.SpecManager
Create a new SpecMap
createStaticItemSelection(Catalog, Hierarchy, String) - Method in interface com.ibm.pim.selection.SelectionManager
Creates a StaticItemSelection.
createUser(String, String, String, String, boolean, String, List<Role>, Organization, boolean) - Method in interface com.ibm.pim.organization.OrganizationManager
Creates a user with the specified parameters.
createUserDefinedLog(String, boolean) - Method in interface com.ibm.pim.catalog.Catalog
Creates an ItemUserDefinedLog for this Catalog
createUserDefinedLog(String, boolean) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Creates a CategoryUserDefinedLog for this Hierarchy
createVersion(String) - Method in interface com.ibm.pim.catalog.Catalog
Create a new version of this Catalog
createVersion(String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Create a new version of this Hierarchy
createView(String) - Method in interface com.ibm.pim.catalog.Catalog
create a new empty View for this catalog
createView(String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
create a new empty View for this hierarchy
createWebService(String, String, Document, WebService.MessageStyle, Document) - Method in interface com.ibm.pim.webservice.WebServiceManager
Creates a new web service with the script that implements the service
createWebService(String, String, Document, WebService.MessageStyle, Document, boolean, boolean, boolean, boolean, boolean, boolean) - Method in interface com.ibm.pim.webservice.WebServiceManager
Creates a new web service with the script that implements the service
createWebServiceUsingJava(String, String, Document, Document, WebService.MessageStyle, String) - Method in interface com.ibm.pim.webservice.WebServiceManager
Creates a new java web service.
createWebServiceUsingJava(String, String, Document, Document, WebService.MessageStyle, String, boolean, boolean, boolean, boolean, boolean, boolean) - Method in interface com.ibm.pim.webservice.WebServiceManager
Creates a new java web service.
createZip(String) - Method in interface com.ibm.pim.utils.ImportList
Creates a zip file containing only those objects present in this import list and stores it at the specified path in the docstore.
createZip(String, boolean) - Method in interface com.ibm.pim.utils.ImportList
Creates a zip file containing only those objects present in this import list and stores it at the specified path in the docstore after checking for pre-requisites if checkRequisites is true.
customTools(CustomToolsFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.CustomToolsFunction
Execute custom tool functionality.
CustomToolsFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Custom Tools function
CustomToolsFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to CustomToolsFunction invocations.

D

DataEntryFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the function currently provided via the script extension point "Data Entry Additional Panel Script"
DataEntryFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to DataEntryFunction invocations.
DataSource - Interface in com.ibm.pim.utils
This interface defines methods for DataSource.
DataSource.Property - Enum in com.ibm.pim.utils
Datasource Property type
DataSource.Type - Enum in com.ibm.pim.utils
Datasource type
DEFAULT_CONTEXT_CLASS - Static variable in class com.ibm.pim.context.PIMContextFactory
Current designated implementation DEFAULT_CONTEXT_CLASS
DefaultValueRuleFunction - Interface in com.ibm.pim.extensionpoints
 
delete() - Method in interface com.ibm.pim.attribute.AttributeCollection
Deletes the attribute collection.
delete() - Method in interface com.ibm.pim.catalog.item.Item
Deletes the item
delete() - Method in interface com.ibm.pim.catalog.LocationDataConfiguration
delete the relationship from the catalog
delete() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Deletes the current collaboration area.
delete() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Deletes the given category.
delete() - Method in interface com.ibm.pim.collaboration.CollaborationItem
Deletes the item from the Product Information Manager.
delete() - Method in interface com.ibm.pim.docstore.Document
Deletes this document.
delete() - Method in interface com.ibm.pim.hierarchy.category.Category
Deletes the given category.
delete() - Method in interface com.ibm.pim.job.Job
Delete the job.
delete() - Method in interface com.ibm.pim.job.Schedule
Delete the job schedule.
delete() - Method in interface com.ibm.pim.lookuptable.LookupTableEntry
Removes this lookuptable entry from the lookup table
delete() - Method in interface com.ibm.pim.organization.Organization
Deletes the given organization.
delete() - Method in interface com.ibm.pim.organization.Role
Delete this role
delete() - Method in interface com.ibm.pim.selection.Selection
Deletes the selection
delete() - Method in interface com.ibm.pim.spec.Spec
Delete a spec
delete() - Method in interface com.ibm.pim.spec.SpecMap
Delete a specMap
delete() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLog
Deletes the UserDefinedLog
delete() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLogEntry
Deletes the UserDefinedLogEntry
delete() - Method in interface com.ibm.pim.utils.DataSource
Deletes the Datasource
delete() - Method in interface com.ibm.pim.utils.Distribution
Deletes the Distribution
delete() - Method in interface com.ibm.pim.utils.DistributionGroup
Deletes this distribution group Note that any distribution contained in the distribution group will not be deleted.
delete() - Method in interface com.ibm.pim.view.View
delete the view
delete() - Method in interface com.ibm.pim.webservice.WebService
Undeploys and deletes the web service.
delete() - Method in interface com.ibm.pim.workflow.Workflow
Delete this workflow
deleteAllEntries() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLog
Deletes all user defined log entries from this UserDefinedLog.If there are no entries corresponding to the category/item, the method does not delete any entries.
deleteAsynchronous() - Method in interface com.ibm.pim.catalog.Catalog
Schedules the complete catalog deletion.
deleteAsynchronous() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Schedules a delete of this hierarchy.
deleteAsynchronous() - Method in interface com.ibm.pim.lookuptable.LookupTable
Schedules the complete LookupTable deletion.
deleteAsynchronous() - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Schedules a delete of this hierarchy.
deleteCustomParameter(String) - Method in interface com.ibm.pim.catalog.Catalog
Deletes a User Defined custom parameter for this Catalog
deleteCustomParameter(String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Delete the custom parameter associated with the hierarchy.
deleteEntries(Category) - Method in interface com.ibm.pim.userdefinedlog.CategoryUserDefinedLog
Deletes the UserDefinedLogEntries corresponding to this category.
deleteEntries(Item) - Method in interface com.ibm.pim.userdefinedlog.ItemUserDefinedLog
Deletes the UserDefinedLogEntries corresponding to the item passed as the argument.
deleteEntries(Item, Category) - Method in interface com.ibm.pim.userdefinedlog.ItemUserDefinedLog
Deletes the UserDefinedLogEntries corresponding to the item which belongs to the specific category passed as argument.
DestinationSpec - Interface in com.ibm.pim.spec
Interface for the Destination Spec object
Directory - Interface in com.ibm.pim.docstore
Interface representing a directory in the docstore.
disassociateUser(User) - Method in interface com.ibm.pim.organization.Organization
Disassociate a user from this Organization.
distribution(DistributionFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.DistributionFunction
MDMPIM will invoke this method to perform a custom distribution.
Distribution - Interface in com.ibm.pim.utils
This interface defines methods for Distribution.
Distribution.Property - Enum in com.ibm.pim.utils
Distribution Property Type
Distribution.Type - Enum in com.ibm.pim.utils
Distribution Type
DistributionFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents a "Custom Distribution" implementation in java.
DistributionFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to DistributionFunction invocations.
DistributionGroup - Interface in com.ibm.pim.utils
This interface defines methods for DistributionGroup.
DocstoreManager - Interface in com.ibm.pim.docstore
Interface for the manager of docstore.
Document - Interface in com.ibm.pim.docstore
Interface for the Document object.
Document.Property - Enum in com.ibm.pim.docstore
Enumeration listing document properties
DocumentAuditLog - Interface in com.ibm.pim.docstore
This interface represents audit log of a document.
DocumentAuditLog.AccessType - Enum in com.ibm.pim.docstore
Enumeration specifying document access types.
doImport(ImportFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.ImportFunction
Perform an import.
drop(Collection<CollaborationCategory>) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Drops the specified categories from the collaboration area.
drop(Collection<CollaborationCategory>, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Drops the specified categories from the collaboration area.
drop(CollaborationCategory) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Drops the specified categories from the collaboration area.
drop(CollaborationCategory, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Drops the specified categories from the collaboration area.
drop(Collection<CollaborationItem>) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Drops the specified items from the collaboration area.
drop(Collection<CollaborationItem>, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Drops the specified items from the collaboration area, with a comment.
drop(CollaborationItem) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Drops the specified item from the collaboration area.
drop(CollaborationItem, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Drops the specified item from the collaboration area, with a comment.
duplicateItemsFound() - Method in interface com.ibm.pim.common.BatchStatistics
Returns the number of items that were duplicate
DynamicCollaborationItemSelection - Interface in com.ibm.pim.selection
Interface representing DynamicSelection on collaboration items in a CollaborationArea.
DynamicCollaborationItemSelection represents a collection of collaboration items in a collaboration area as a result of a search specified by the given query.
DynamicItemSelection - Interface in com.ibm.pim.selection
Interface representing DynamicSelection for items.
DynamicItemSelection represents a list of items based on a query.
DynamicSelection - Interface in com.ibm.pim.selection
Interface representing dynamic selection.
Dynamic Selection represents a list of items or a list of categories, based on a query.

E

entryBuild(EntryBuildFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.EntryBuildFunction
Perform Entry Build Function.
EntryBuildFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Entry Build function
EntryBuildFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to EntryBuildFunction invocations.
entryMacro(ItemMacroFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.EntryMacroFunction
Perform Entry Macro Function for Item.
entryMacro(CategoryMacroFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.EntryMacroFunction
Perform Entry Macro Function for Category.
entryMacro(CollaborationItemMacroFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.EntryMacroFunction
Perform Entry Macro Function for Collaboration Item.
entryMacro(CollaborationCategoryMacroFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.EntryMacroFunction
Perform Entry Macro Function for Collaboration Category.
EntryMacroFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Entry Macro function
entryPreview(ItemPreviewFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.EntryPreviewFunction
Perform Entry Preview Function upon item(s)
entryPreview(CollaborationItemPreviewFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.EntryPreviewFunction
Perform Entry Preview Function upon item(s) in a collaboration area
entryPreview(CategoryPreviewFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.EntryPreviewFunction
Perform Entry Preview Function upon category(s)
entryPreview(CollaborationCategoryPreviewFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.EntryPreviewFunction
Perform Entry Preview Function upon category(s) in a collabration area
EntryPreviewFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Entry Preview function
EnvironmentExporter - Interface in com.ibm.pim.utils
This interface defines methods for PIM system environment export.
EnvironmentImporter - Interface in com.ibm.pim.utils
This interface defines methods for PIM system environment import
equals(Object) - Method in interface com.ibm.pim.collection.PIMCollection
Checks that the PIMCollection appears to contains the same elements as the specified PIMCollection.
errorCount() - Method in interface com.ibm.pim.common.BatchStatistics
Returns the error count
Executable - Interface in com.ibm.pim.job
This interface defines methods for job executable.
Executable.Type - Enum in com.ibm.pim.job
This is an enum type for job executable.
execute() - Method in interface com.ibm.pim.search.SearchQuery
Executes the Query and returns the SearchResultSet
executeNonPersistedScript() - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Execute non-persisted script for all attributes in the item to populate their values.
ExitValue - Interface in com.ibm.pim.workflow
An ExitValue is an object representation of an Exit Value on a particular WorkflowStep.
Export - Interface in com.ibm.pim.job
Interface that represents the Export jobs
export(ExportList, String) - Method in interface com.ibm.pim.utils.EnvironmentExporter
Exports the PIM objects specified in the ExportList in zip format and stores the file at the docstore file path specified.
export(ExportList, String, boolean) - Method in interface com.ibm.pim.utils.EnvironmentExporter
Exports the PIM objects specified in the ExportList in zip format and stores the file at the docstore file path specified.
Export.ContentDiffType - Enum in com.ibm.pim.job
Content difference types, relevant only when content diff export type is selected as export type
Export.OptionalArguments - Enum in com.ibm.pim.job
Set of optional arguments that can be passed while creating an export.
Export.Type - Enum in com.ibm.pim.job
Export types
exportAll(String) - Method in interface com.ibm.pim.utils.EnvironmentExporter
Exports all the objects in the company in CREATE_OR_UPDATE mode
exportAttributeCollectionMetadata(Collection<String>) - Method in interface com.ibm.pim.utils.IISIntegration
This method takes an Collection of String representing the Attribute Collection names as input parameter and exports the metadata(of Attribute Collection) in XML Schema format in a XSD file and uploads the file to the docstore for each Attribute Collection.
exportBusinessGlossary(Collection<String>) - Method in interface com.ibm.pim.utils.IISIntegration
This method takes a Collection of String representing the Spec Names as the input parameter and exports the metadata(spec) description in the Business Glossary format in a XML file and uploads the file to the docstore for each spec.
ExportList - Interface in com.ibm.pim.utils
An interface representing an object that holds the list of objects to be exported from a company.
ExportList.ActionMode - Enum in com.ibm.pim.utils
Enumeration of action modes for environment export and import tool.
ExportList.Type - Enum in com.ibm.pim.utils
Enumeration of object types for use by environment export and import tool.
ExportRequisiteList - Interface in com.ibm.pim.utils
Interface representing an object that holds requisite objects for objects in an export list.
ExtendedAttributeChanges - Interface in com.ibm.pim.attribute
 
ExtendedAttributeOwner - Interface in com.ibm.pim.attribute
 
ExtendedValidationErrors - Interface in com.ibm.pim.common
 

F

failedValidation() - Method in interface com.ibm.pim.common.BatchStatistics
Returns the number of items that failed validation
FileSpec - Interface in com.ibm.pim.spec
Interface for the File Spec object
FileSpec.FileType - Enum in com.ibm.pim.spec
File types
Fixit - Interface in com.ibm.pim.workflow
Fixit is a special kind of Workflow Step which does not have all the same functionality of a WorkflowStep.
flushBatch() - Method in interface com.ibm.pim.common.Batchable
This is the method where the implementing class sends the queued up objects to the data store.
flushScriptCache() - Method in interface com.ibm.pim.system.AdminHelper
Flushes the script cache
FunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments common to all FunctionArguments interfaces.

G

getAccessControlGroup() - Method in interface com.ibm.pim.catalog.Catalog
Returns the Access Control Group for this catalog
getAccessControlGroup() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the access control group on the current collaboration area.
getAccessControlGroup() - Method in interface com.ibm.pim.docstore.Document
Fetches the access control group for this document.
getAccessControlGroup() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Returns the Access Control Group for this hierarchy
getAccessControlGroup() - Method in interface com.ibm.pim.job.Import
Returns the ACG used for this import
getAccessControlGroup() - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Returns the Access Control Group for this hierarchy
getAccessControlGroup(String) - Method in interface com.ibm.pim.organization.OrganizationManager
Returns an access control group object for the specified acg name
getAccessControlGroup() - Method in interface com.ibm.pim.selection.Selection
Fetches the access control group for the selection
getAccessControlGroup() - Method in interface com.ibm.pim.workflow.Workflow
Get the access control group of the workflow.
getAccessControlGroups() - Method in interface com.ibm.pim.organization.Company
Returns all access control groups in the context of this company.
getAccessControlGroups() - Method in interface com.ibm.pim.organization.Role
Provides a collection of Access Control Groups applicable to this role
getAccessedDate() - Method in interface com.ibm.pim.docstore.DocumentAuditLog
Fetches the date and time at which this document was accessed.
getAccessibleSteps(Performer) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Get the steps accessible by the given performer.
getAccessType() - Method in interface com.ibm.pim.docstore.DocumentAuditLog
Specifies whether the user performed a read or a write operation on the document.
getActionModeForObject(ExportList.Type, String) - Method in interface com.ibm.pim.utils.ImportList
Returns the action mode for the PIM object of specified type and name.
getAddress() - Method in interface com.ibm.pim.organization.User
Retrieves the User's address
getAdminHelper() - Method in interface com.ibm.pim.context.Context
Returns object of AdminHelper
getAdministrators() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the collection of Administrators for the current collaboration area.
getApplicableScreenTypes() - Method in interface com.ibm.pim.catalog.CatalogManager
Get all applicable screen types that a View on a catalog can be attached to
getApplicableScreenTypes() - Method in interface com.ibm.pim.hierarchy.HierarchyManager
Returns all the screen types that a View on a hierarchy can be attached to
getApprovingUser() - Method in interface com.ibm.pim.job.Export
Returns the user approving this export
getArrivalTime() - Method in interface com.ibm.pim.webservice.WebServiceTransaction
Returns the request arrival time.
getAttributeChangesComparedTo(AttributeOwner) - Method in interface com.ibm.pim.attribute.AttributeOwner
Return the difference between this and another AttributeOwner at attribute level.
getAttributeChangesComparedTo(ExtendedAttributeOwner) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Identify Attribute Changes between this and another AttributeOwner.
getAttributeChangesSinceLastSave() - Method in interface com.ibm.pim.attribute.AttributeOwner
Return the changes at the attribute level since the last time the attribute owner was saved successfully.
getAttributeChangesSinceLastSave() - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Identify Attribute Changes since the last time the AttributeOwner was saved.
getAttributeCollection(String) - Method in interface com.ibm.pim.attribute.AttributeCollectionManager
Retrieves an attribute collection by name
getAttributeCollectionForPrivilegeType(Catalog, Role.Privilege) - Method in interface com.ibm.pim.organization.Role
Fetches the attribute collections on which the role has the mentioned type of privilege for the given catalog.
getAttributeCollectionForPrivilegeType(Hierarchy, Role.Privilege) - Method in interface com.ibm.pim.organization.Role
Fetches the attribute collections on which the role has the mentioned type of privilege for the given catalog.
getAttributeCollectionManager() - Method in interface com.ibm.pim.context.Context
Gets the AttributeCollectionManager for this context
getAttributeCollectionMetadata(String) - Method in interface com.ibm.pim.utils.IISIntegration
This method returns Metadata information in a String having XML Schema format, for given AttributeCollection name .
getAttributeCollections() - Method in interface com.ibm.pim.attribute.AttributeCollectionManager
Gets all AttributeCollections available in the current context.
getAttributeCollections(AttributeDefinition) - Method in interface com.ibm.pim.attribute.AttributeCollectionManager
Returns all attribute collections that currently contain the specified AttributeDefinition.
getAttributeCollections(String) - Method in interface com.ibm.pim.attribute.AttributeCollectionManager
Gets all attribute collections that currently contain the specified AttributeDefinition, as specified by its path.
getAttributeCollections(Spec) - Method in interface com.ibm.pim.attribute.AttributeCollectionManager
Gets all attribute collections that currently contain the specified Spec as a dynamic attribute source.
getAttributeCollections() - Method in interface com.ibm.pim.catalog.LocationDataConfiguration
Retrieves inheritance Attribute Collections for this particular Configuration.
getAttributeCollections() - Method in interface com.ibm.pim.view.ScreenView
Get all attribute collections on this screen view, editable and viewable
getAttributeCollections() - Method in interface com.ibm.pim.view.ScreenViewFilter
Get the Attribute Collections for this filter
getAttributeCollections() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get all attribute collections for this step.
getAttributeCollections(ScreenType) - Method in interface com.ibm.pim.workflow.WorkflowStep
Get all attribute collections for a given screen type on this step.
getAttributeCollections(Hierarchy) - Method in interface com.ibm.pim.workflow.WorkflowStep
Get all attribute collections on the specified location hierarchy for this step.
getAttributeDefinition() - Method in interface com.ibm.pim.attribute.AttributeInstance
The attribute definition defines the template characteristics of this particular AttributeInstance
getAttributeDefinition(String) - Method in interface com.ibm.pim.spec.Spec
Return a specific AttributeDefinition by path, null if no AttributeDefinition with the given path is found.
getAttributeDefinitions() - Method in interface com.ibm.pim.spec.Spec
Returns all Attribute Definitions of this Spec at all levels, an empty collection if none are present.
getAttributeInstance(String) - Method in interface com.ibm.pim.attribute.AttributeOwner
Retrieve the attribute instance at the specified path.
getAttributeInstance() - Method in interface com.ibm.pim.common.ValidationError
Get the AttributeInstance that this validation error corresponds to.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CategoryDefaultValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CategoryNonPersistedAttributeRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CategoryRunValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CategoryStringEnumerationValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CategoryValidationRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryDefaultValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryNonPersistedAttributeRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryRunValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryStringEnumerationValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryValidationRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemDefaultValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemNonPersistedAttributeRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemRunValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemStringEnumerationValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemValidationRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.ItemDefaultValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.ItemNonPersistedAttributeRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.ItemRunValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.ItemStringEnumerationValueRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeInstance() - Method in interface com.ibm.pim.extensionpoints.ItemValidationRuleFunctionArguments
Obtains the attribute instance for this RuleFunction.
getAttributeName(String) - Method in interface com.ibm.pim.attribute.AttributePathHelper
Extract the name of the attribute identified by a path
getAttributeNames(String, boolean) - Method in interface com.ibm.pim.attribute.AttributePathHelper
Extract the attribute names from a path
getAttributePathHelper() - Method in interface com.ibm.pim.context.Context
 
getAttributes() - Method in interface com.ibm.pim.attribute.AttributeCollection
Returns all current list of attributes in this attribute collection.
getAttributes() - Method in interface com.ibm.pim.view.ScreenView
Get all viewable and editable attributes from the union of all viewable and editable attribute collections on this screen view.
getAttributes() - Method in interface com.ibm.pim.view.ScreenViewFilter
Get all the attributes present in this filter at the present time
getAttributeValue(String) - Method in interface com.ibm.pim.attribute.AttributeOwner
Retrieve the attribute value at the specified path for this item.
getAuditLog() - Method in interface com.ibm.pim.docstore.Document
Fetches the audit log for this document.
getAuthorizedUser() - Method in interface com.ibm.pim.job.Import
Returns the authorized user
getAvailableLocations(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Returns the locations this item is available in from the set of locations given by the passed in location and its descendants.
getBatchProcessingStatistics() - Method in interface com.ibm.pim.common.Batchable
This method returns the current set of statistics related to a given batching session (all actions from the call to startBatchProcessing to current point in time).
getBoolean(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as Java Boolean value.
getBuildScript() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Retrieves the script document associated with an invocation point defined by the collaboration area
getBusinessGlossary(String) - Method in interface com.ibm.pim.utils.IISIntegration
This method returns a Business Glossary XML as String for given Spec name.
getBypassApprovalWorkflow() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains the default state of the bypass approval workflow flag for this CatalogExportFunction.
getCanModifyLocationHierarchyAvailability(Hierarchy) - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the "can modify availability" flag for a particular location hierarchy on this workflow.
getCatalog(String) - Method in interface com.ibm.pim.catalog.CatalogManager
Retrieves the latest version of a specified Catalog
getCatalog(String, VersionInfo) - Method in interface com.ibm.pim.catalog.CatalogManager
Retrieves a particular version of a specified Catalog
getCatalog(View) - Method in interface com.ibm.pim.catalog.CatalogManager
Get the Catalog by which a particular view is owned
getCatalog() - Method in interface com.ibm.pim.catalog.item.Item
Returns the catalog to which this item belongs.
getCatalog() - Method in interface com.ibm.pim.catalog.LocationDataConfiguration
Retrives the Parent Catalog
getCatalog() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains the catalog being exported by this CatalogExportFunction.
getCatalog() - Method in interface com.ibm.pim.extensionpoints.CatalogPreviewFunctionArguments
Obtains the catalog being processed for this CatalogPreviewFunction.
getCatalog() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains the catalog being processed for this ImportFunction.
getCatalog() - Method in interface com.ibm.pim.extensionpoints.RichSearchReportFunctionArguments
Obtains the catalog for this RichSearchReportFunction.
getCatalog() - Method in interface com.ibm.pim.job.ItemImport
Returns the destination catalog for an item import
getCatalog(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as MDMPIM Catalog object.
getCatalog() - Method in interface com.ibm.pim.selection.DynamicItemSelection
Fetches the catalog with which this selection is associated
getCatalog() - Method in interface com.ibm.pim.selection.StaticItemSelection
Fetches the catalog with which this selection is associated
getCatalog() - Method in interface com.ibm.pim.userdefinedlog.ItemUserDefinedLog
Fetches the catalog with which this UserDefinedLog is associated.
getCatalogDelimiter() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains the catalog delimiter being processed for this ImportFunction.
getCatalogManager() - Method in interface com.ibm.pim.context.Context
Gets the CatalogManager for this context
getCatalogs() - Method in interface com.ibm.pim.catalog.CatalogManager
Retrieves all Catalogs available the current user is authorized to list.
getCategories() - Method in interface com.ibm.pim.catalog.item.Item
Returns all the categories to which this item belongs.
getCategories(Hierarchy) - Method in interface com.ibm.pim.catalog.item.Item
Returns all the categories of the Hierarchy which is passed in, to which this item belongs.
getCategories() - Method in interface com.ibm.pim.collaboration.CollaborationItem
Returns all the categories to which this item belongs.
getCategories() - Method in interface com.ibm.pim.extensionpoints.CategoryPreviewFunctionArguments
Obtains the categories for this EntryPreviewFunction.
getCategories() - Method in interface com.ibm.pim.extensionpoints.WorkflowStepFunctionArguments
Obtains the set of Category entries being processed for this WorkflowStepFunction.
getCategories() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a collection of all the Category objects in this hierarchy.
getCategories() - Method in interface com.ibm.pim.selection.StaticItemSelection
Fetches the categories present in the selection
getCategoriesAtLevel(int) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a collection of all the Category objects in this hierarchy residing at a particular level.
getCategoriesByItemSecondarySpec(SecondarySpec) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a collection of all the Category objects in this hierarchy implementing a particular secondary spec.
getCategoriesByPaths(Collection<String>) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a collection of all the Category objects in this hierarchy based upon their path names.
getCategoriesByPaths(Collection<String>, String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a collection of all the Category objects in this hierarchy based upon their path names.
getCategoriesByStandAloneSpec(SecondarySpec) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a collection of all the Category objects in this hierarchy implementing a particular standalone spec.
getCategoriesWithAttributeValue(String, Object) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a collection of all the Category objects in this hierarchy based upon a particular attribute value.
getCategory() - Method in interface com.ibm.pim.extensionpoints.CategoryDefaultValueRuleFunctionArguments
Obtains the category to be processed by this rule function.
getCategory() - Method in interface com.ibm.pim.extensionpoints.CategoryMacroFunctionArguments
Obtains the category entry being processed for this EntryMacroFunction.
getCategory() - Method in interface com.ibm.pim.extensionpoints.CategoryNonPersistedAttributeRuleFunctionArguments
Obtains the category to be processed by this rule function.
getCategory() - Method in interface com.ibm.pim.extensionpoints.CategoryPrePostProcessingFunctionArguments
Obtains the category to be processed by this pre/post function.
getCategory() - Method in interface com.ibm.pim.extensionpoints.CategoryRunValueRuleFunctionArguments
Obtains the category to be processed by this rule function.
getCategory() - Method in interface com.ibm.pim.extensionpoints.CategoryStringEnumerationValueRuleFunctionArguments
Obtains the category to be processed by this rule function.
getCategory() - Method in interface com.ibm.pim.extensionpoints.CategoryValidationRuleFunctionArguments
Obtains the category to be processed by this rule function.
getCategory() - Method in interface com.ibm.pim.extensionpoints.DataEntryFunctionArguments
Obtain the category for this DataEntryFunction.
getCategory() - Method in interface com.ibm.pim.extensionpoints.EntryBuildFunctionArguments
Obtains the category entry being processed for this EntryBuildFunction.
getCategory() - Method in interface com.ibm.pim.extensionpoints.PostCategorySaveFunctionArguments
Obtains the current category for this invocation.
getCategory(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as MDMPIM Category object.
getCategoryBuildScript() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves the script document associated with an invocation point defined by the Hierarchy
getCategoryByPath(String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a Category based upon Path name
getCategoryByPath(String, String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a Category based upon Path name
getCategoryByPrimaryKey(String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a Category based upon Primary key
getCategoryCount() - Method in interface com.ibm.pim.selection.StaticItemSelection
Fetches the count of categories present in the selection
getCategorySpecs() - Method in interface com.ibm.pim.catalog.Catalog
Return all the "ItemSecondarySpecs" applied in this catalog
getCharset() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains the charset in effect for this CatalogExportFunction.
getCharset() - Method in interface com.ibm.pim.job.Export
Returns the charset used for this export
getCharset() - Method in interface com.ibm.pim.job.Import
Returns the CharSet used for the import
getCheckedOutCategories() - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Gets the collection of all checked out categories in the current category collaboration area.
getCheckedOutCategories(List<String>) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Gets the collection of checked out categories with the specified primary keys in the current category collaboration area.
getCheckedOutCategory(String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Gets the checked out category with the specified primary key in the current category collaboration area.
getCheckedOutCategory(CategoryCollaborationArea) - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the CollaborationObject in the CollaborationArea corresponding to the given Category
getCheckedOutItem(ItemCollaborationArea) - Method in interface com.ibm.pim.catalog.item.Item
Returns the item's collaboration object in the collaboration area that the item is checked out to.
getCheckedOutItem(String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Get the checked out item with the specified primary key in the current item collaboration area.
getCheckedOutItems() - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Get a collection of all checked out items in the current item collaboration area.
getCheckedOutItems(List<String>) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Get the collection of checked out items with the specified primary keys in the current item collaboration area.
getChildren() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Returns the children of this AttributeDefinition, returns an empty collection if no children are present
getChildren() - Method in interface com.ibm.pim.attribute.AttributeInstance
This method allows retrieval of Attribute Instances within a particular occurrence of a multi-occurrence or a grouping node.
getChildren() - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
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.
getChildren() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Returns the categories immediately below this category.
getChildren(Catalog, boolean, boolean) - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Returns the categories immediately below this category.
getChildren() - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the categories immediately below this category.
getChildren(Catalog, boolean, boolean) - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the categories immediately below this category.
getChildren() - Method in interface com.ibm.pim.organization.Organization
Returns the categories immediately below this organization.
getCMSManager() - Method in interface com.ibm.pim.context.Context
Gets the CMSManager for this context
getCode() - Method in interface com.ibm.pim.organization.Company
Retrieves the company code.
getCollaborationArea(String) - Method in interface com.ibm.pim.collaboration.CollaborationAreaManager
Retrieve a collaboration area by name.
getCollaborationArea() - Method in interface com.ibm.pim.collaboration.CollaborationObject
Get the collaboration area in which this object resides.
getCollaborationArea() - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns the collaboration area for this collaboration step.
getCollaborationArea() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains the collaboration area being processed for this ImportFunction.
getCollaborationArea() - Method in interface com.ibm.pim.selection.DynamicCollaborationItemSelection
Fetches the CollaborationArea on which this selection is based
getCollaborationAreaManager() - Method in interface com.ibm.pim.context.Context
Gets the CollaborationAreaManager for this context
getCollaborationAreas() - Method in interface com.ibm.pim.catalog.Catalog
Return all collaboration areas that have this catalog as their source catalog as prescribe by: Permission.COLLABORATION_AREA_LIST
getCollaborationAreas() - Method in interface com.ibm.pim.catalog.item.Item
Returns the collaboration areas that the item is checked out to.
getCollaborationAreas() - Method in interface com.ibm.pim.collaboration.CollaborationAreaManager
Retrieve all collaboration areas available in the current context, or an empty collection if there are none.
getCollaborationAreas(Performer) - Method in interface com.ibm.pim.collaboration.CollaborationAreaManager
Retrieve all collaboration areas applicable to a particular role/user, or an empty collection if there are none.
getCollaborationAreas() - Method in interface com.ibm.pim.hierarchy.category.Category
Returns all the collaboration areas that this category is checked out to If the category is not checked out to any collaboration areas, an empty Collection will be returned.
getCollaborationAreas() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieve the collaboration areas associated with this hierarchy.
getCollaborationAreas() - Method in interface com.ibm.pim.workflow.Workflow
Get a collection of Collaboration areas that use this workflow
getCollaborationAreasWithNoACGFilter() - Method in interface com.ibm.pim.collaboration.CollaborationAreaManager
Retrieve all collaboration areas available in the current context, or an empty collection if there are none.
getCollaborationCategories() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPreviewFunctionArguments
Obtains the collaboration categories for this EntryPreviewFunction.
getCollaborationCategory() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryDefaultValueRuleFunctionArguments
Obtains the category to be processed by this rule function.
getCollaborationCategory() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryMacroFunctionArguments
Obtains the category entry being processed for this EntryMacroFunction.
getCollaborationCategory() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryNonPersistedAttributeRuleFunctionArguments
Obtains the category to be processed by this rule function.
getCollaborationCategory() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPrePostProcessingFunctionArguments
Obtains the category to be processed by this pre/post function.
getCollaborationCategory() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryRunValueRuleFunctionArguments
Obtains the category to be processed by this rule function.
getCollaborationCategory() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryStringEnumerationValueRuleFunctionArguments
Obtains the category to be processed by this rule function.
getCollaborationCategory() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryValidationRuleFunctionArguments
Obtains the category to be processed by this rule function.
getCollaborationCategory() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationCategorySaveFunctionArguments
Obtains the current category for this invocation.
getCollaborationEntryURL(CollaborationStep, Category) - Method in interface com.ibm.pim.system.UIHelper
Returns a String object representing the URL which can be used to display the category in the collaborationStep
getCollaborationEntryURL(CollaborationStep, Item) - Method in interface com.ibm.pim.system.UIHelper
Returns a String object representing the URL which can be used to display the item in the collaborationStep
getCollaborationHistory() - Method in interface com.ibm.pim.collaboration.CollaborationObject
Get the collaboration area history of this object.
getCollaborationHistory(Date, Date) - Method in interface com.ibm.pim.collaboration.CollaborationObject
Get the collaboration area history of this object between two dates.
getCollaborationItem() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemDefaultValueRuleFunctionArguments
Obtains the item to be processed by this rule function.
getCollaborationItem() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemMacroFunctionArguments
Obtains the item entry being processed for this EntrymacroFunction.
getCollaborationItem() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemNonPersistedAttributeRuleFunctionArguments
Obtains the item to be processed by this rule function.
getCollaborationItem() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPrePostProcessingFunctionArguments
Obtains the item to be processed by this pre/post function.
getCollaborationItem() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemRunValueRuleFunctionArguments
Obtains the item to be processed by this rule function.
getCollaborationItem() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemStringEnumerationValueRuleFunctionArguments
Obtains the item to be processed by this rule function.
getCollaborationItem() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemValidationRuleFunctionArguments
Obtains the item to be processed by this rule function.
getCollaborationItem() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationItemSaveFunctionArguments
Obtains the current item for this invocation.
getCollaborationItems() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPreviewFunctionArguments
Obtains the collaboration items for this EntryPreviewFunction.
getCollaborationItems() - Method in interface com.ibm.pim.selection.DynamicCollaborationItemSelection
Fetches a collection of CollaborationItem objects in the selection As prescribed via Permission.SELECTION_MEMBERS_VIEW_ITEMS
getCollaborationObjectsDetailAsXML(List<CollaborationItem>, List<AttributeDefinition>) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns an XML representation of workflow step entries for the given Collaboration step.
getCollaborationObjectsDetailAsXML(List<CollaborationItem>, List<AttributeDefinition>, String) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns an XML representation of workflow step entries for the given Collaboration step, with specified date formatting.
getCollaborationStep() - Method in interface com.ibm.pim.collaboration.CollaborationHistoryEvent
Get the collaboration step at which the event happened.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryDefaultValueRuleFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryMacroFunctionArguments
Obtains the collaboration step for this EntryMacroFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryNonPersistedAttributeRuleFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPrePostProcessingFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPreviewFunctionArguments
Obtains the collaboration step for this Entry Preview Function.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryRunValueRuleFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryStringEnumerationValueRuleFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemDefaultValueRuleFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemMacroFunctionArguments
Obtains the collaboration step for this EntryMacroFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemNonPersistedAttributeRuleFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPrePostProcessingFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPreviewFunctionArguments
Obtains the collaboration step for this Entry Preview Function.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemRunValueRuleFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemStringEnumerationValueRuleFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationCategorySaveFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationItemSaveFunctionArguments
Obtains the collaboration step for this RuleFunction.
getCollaborationStep() - Method in interface com.ibm.pim.extensionpoints.WorkflowStepFunctionArguments
Obtains the collaboration step relevant to the entries being processed within this invocation.
getCollaborationStepURL(CollaborationStep) - Method in interface com.ibm.pim.system.UIHelper
Returns a String object representing the URL which can be used to render the Collaboration Area Step screen which displays all the items or categories in the collaborationStep
getColumnTypes() - Method in interface com.ibm.pim.search.SearchQuery
Returns the list of column types associated with the desired result set of the query.
getComment() - Method in interface com.ibm.pim.collaboration.CollaborationHistoryEvent
Get the comment, which describes more about the event.
getCompany() - Method in interface com.ibm.pim.organization.User
Returns the company associated with this User.
getContent() - Method in interface com.ibm.pim.docstore.Document
Fetches the content of this document object as a String
getContent(OutputStream) - Method in interface com.ibm.pim.docstore.Document
Fetches the content of this document as an OutputStream.
getContent(DataEntryFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.DataEntryFunction
This method will be invoked by WPC.
getContentLength() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains the content length being processed for this ImportFunction.
getContentReader() - Method in interface com.ibm.pim.docstore.Document
Fetches the content of the document in a Reader
getContentReader(CharSet) - Method in interface com.ibm.pim.docstore.Document
Fetches the content of the document in a Reader using the encoding passed as the argument
getContents() - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns all the collaboration objects in this collaboration step.
getContents(Selection) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns the collaboration objects in this collaboration step that are related to the given selection.
getContentsByAttributeValue(String, Object) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns all the collaboration objects in this step whose attribute at the specified path contains the specified attribute value.
getContentsByAttributeValue(AttributeDefinition, Object) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns all the collaboration objects in this step whose attribute at the specified attribute definition contains the specified attribute value.
getContext(String, String, String) - Static method in class com.ibm.pim.context.PIMContextFactory
Instantiate a new API Context Object based upon username, password and company code.
getContext() - Static method in class com.ibm.pim.context.PIMWebServicesContextFactory
Instantiate a new API Context Object based on the current web service message context.
getCount() - Method in interface com.ibm.pim.selection.Selection
Returns the number of items/categories in a selection
getCreator() - Method in interface com.ibm.pim.job.Job
Gets the creator of the job.
getCreator() - Method in interface com.ibm.pim.job.Schedule
Gets the creator of the schedule.
getCurrencies() - Method in interface com.ibm.pim.context.Context
Gets all the currencies supported by the system.
getCurrencies() - Method in interface com.ibm.pim.organization.Company
Returns all Currencies in the context of this company.
getCurrentContext() - Static method in class com.ibm.pim.context.PIMContextFactory
Return the current context
getCurrentContextInternal() - Static method in class com.ibm.pim.context.PIMContextFactory
Get current context.
getCurrentUser() - Method in interface com.ibm.pim.context.Context
Returns the currently authenticated User object.
getCustomParameter(String) - Method in interface com.ibm.pim.extensionpoints.FunctionArguments
Return the value of the parameter named key.
getCustomParameterNames() - Method in interface com.ibm.pim.catalog.Catalog
Retrieves a list of user defined custom parameters present in this Catalog
getCustomParameterNames() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a list of user defined custom parameters present in this Hierarchy
getCustomParameterValues(String) - Method in interface com.ibm.pim.catalog.Catalog
Retrieves a User Defined custom parameter for this Catalog
getCustomParameterValues(String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves the values of the given User Defined custom parameter for this Hierarchy
getDataSource(String) - Method in interface com.ibm.pim.utils.RoutingManager
Returns DataSource with the given name
getDataSources() - Method in interface com.ibm.pim.utils.RoutingManager
Retrieve a collection of all the DataSources
getDate() - Method in interface com.ibm.pim.collaboration.CollaborationHistoryEvent
Get the date and time at which the event happened.
getDate(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as Java Date value.
getDate() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLogEntry
Fetches the date and time at which this UserDefinedLogEntry was created or last updated.
getDefaultAccessControlGroup() - Method in interface com.ibm.pim.organization.Company
Retrieves the default AccessControlGroup for this company
getDefaultAttributeCollection(Spec) - Method in interface com.ibm.pim.organization.Company
Retrieves the default Attribute Collection for the given spec
getDefaultExitValue() - Method in interface com.ibm.pim.collaboration.CollaborationStepTransitionConfiguration
Gets the exit value on which the collaboration objects are expected to move out (that is, the exit value they were originally assigned).
getDefaultLocale() - Method in interface com.ibm.pim.organization.Company
Retrieves the default Locale for this company
getDefaultLogger() - Method in interface com.ibm.pim.context.Context
Returns an instance of root Logger as defined in configuration file /etc/default/api_log.xml
getDefaultLookupTableHierarchy() - Method in interface com.ibm.pim.organization.Company
Retrieves the default Lookup Table hierarchy for this company
getDefaultOrganizationHierarchy() - Method in interface com.ibm.pim.organization.Company
Retrieves the default Organization Hierarchy for this company
getDefaultSpec() - Method in interface com.ibm.pim.organization.Company
Retrieves the default Spec for this company
getDefaultStepScriptPath() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the default script path for this Workflow Step's Step Scripts
getDeletedAttributes() - Method in interface com.ibm.pim.attribute.AttributeChanges
 
getDeletedAttributes(boolean) - Method in interface com.ibm.pim.attribute.AttributeChanges
Returns a List of attributes that were present in A but are no longer present in B
getDeletedLocationAttributes(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeChanges
Return a List of attributes that were present in A but are no longer present in B.
getDeletedLocationAttributes(Category, boolean) - Method in interface com.ibm.pim.attribute.ExtendedAttributeChanges
Return a List of attributes that were present in A but are no longer present in B.
getDeleteWhenEmpty() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the flag 'Delete when Empty' flag for the current collaboration area.
getDescendents() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Returns all the descendants of this category.
getDescendents() - Method in interface com.ibm.pim.hierarchy.category.Category
Returns all the descendants of this category.
getDescendents() - Method in interface com.ibm.pim.organization.Organization
Returns all the descendents of this organization.
getDescription() - Method in interface com.ibm.pim.attribute.AttributeCollection
Returns the description of this attribute collection.
getDescription() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the description for the current collaboration area.
getDescription() - Method in interface com.ibm.pim.job.Job
Gets job description.
getDescription() - Method in interface com.ibm.pim.organization.AccessControlGroup
Retrieves the description applied to this access control group
getDescription() - Method in interface com.ibm.pim.organization.Role
The textual description of this role
getDescription() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLog
Fetches the description of this user defined log.
getDescription() - Method in interface com.ibm.pim.webservice.WebService
Returns the description of the web service.
getDescription() - Method in interface com.ibm.pim.workflow.Workflow
Get the description of the Workflow.
getDescription() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the step name description.
getDestinationAttributeDefinition() - Method in interface com.ibm.pim.spec.SpecMapEntry
Return the destination AttributeDefinition in the spec map entry
getDestinationCatalog() - Method in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunctionArguments
Obtains the destination catalog being processed for this CatalogToCatalogExportFunction.
getDestinationCategories(Category) - Method in interface com.ibm.pim.hierarchy.HierarchyMap
Returns a collection of destination categories the given source category is mapped to in this hierarchy map.
getDestinationHierarchy() - Method in interface com.ibm.pim.hierarchy.HierarchyMap
Returns the destination hierarchy.
getDestinationObjectName() - Method in interface com.ibm.pim.spec.SpecMap
Returns the name of the destination object in the specMap
getDestinationSpec() - Method in interface com.ibm.pim.job.Export
Returns the destination spec associated to this export
getDifferences() - Method in interface com.ibm.pim.collaboration.CollaborationHistoryEvent
Get the differences between the item or category attributes before and after the event.
getDiffStatus() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains the diff status being processed for this CatalogExportFunction.
getDirectory(String) - Method in interface com.ibm.pim.docstore.DocstoreManager
Fetches the directory at the given directoryPath.
getDisplayAttribute() - Method in interface com.ibm.pim.catalog.Catalog
Retrieves the Catalog display attribute
getDisplayAttribute() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Returns the display attribute for this hierarchy
getDisplayAttribute() - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Returns the display attribute for this hierarchy
getDisplayName() - Method in interface com.ibm.pim.catalog.item.Item
Returns the display name.
getDisplayName() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Returns the name of this Category object
getDisplayName() - Method in interface com.ibm.pim.collaboration.CollaborationItem
Returns the display name.
getDisplayName() - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the name of this Category object
getDisplayName() - Method in interface com.ibm.pim.organization.Organization
Returns the name of this Category object
getDisplayValue() - Method in interface com.ibm.pim.attribute.AttributeInstance
Returns the string for displaying the item attribute specified by attribute object.
getDistribution() - Method in interface com.ibm.pim.job.Report
Fetches the distribution used with this report
getDistribution(String) - Method in interface com.ibm.pim.utils.RoutingManager
Returns Distribution with the given name
getDistributionGroup(String) - Method in interface com.ibm.pim.utils.RoutingManager
Returns DistributionGroup with the given name
getDistributionGroups() - Method in interface com.ibm.pim.job.Export
Returns the distribution groups used for this export
getDistributionGroups() - Method in interface com.ibm.pim.utils.RoutingManager
Retrieve a collection of all the DistributionGroups
getDistributions() - Method in interface com.ibm.pim.job.Export
Returns the distribution used for this export
getDistributions() - Method in interface com.ibm.pim.utils.DistributionGroup
Returns the collection of all distributions in this distribution group
getDistributions() - Method in interface com.ibm.pim.utils.RoutingManager
Retrieve a collection of all the Distributions
getDocName() - Method in interface com.ibm.pim.extensionpoints.RichSearchReportFunctionArguments
Obtains the document path within the docstore where the output from this rich search result is expected to be created.
getDocstoreDataDoc() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains the data document from the docstore being processed for this ImportFunction.
getDocstoreManager() - Method in interface com.ibm.pim.context.Context
Gets the DocstoreManager for this context
getDocument(String) - Method in interface com.ibm.pim.docstore.Directory
Fetches the document with the given name found under this directory.
getDocument(String, boolean) - Method in interface com.ibm.pim.docstore.Directory
Fetches the document with the given name found under this directory.
getDocument(String) - Method in interface com.ibm.pim.docstore.DocstoreManager
Fetches the document which exists at the given documentPath.
getDocument(String, boolean) - Method in interface com.ibm.pim.docstore.DocstoreManager
Fetches the document which exists at the given documentPath.
getDocument() - Method in interface com.ibm.pim.docstore.DocumentAuditLog
Fetches the document to which the log belongs
getDocuments() - Method in interface com.ibm.pim.docstore.Directory
Fetches a collection of all the documents on which the user has view permission in this directory
getDocuments() - Method in interface com.ibm.pim.extensionpoints.DistributionFunctionArguments
Obtains the documents to be distributed.
getDouble(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as Java double value.
getDuplicateItemsFoundCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of duplicate items found.
getEditableAttributeCollections() - Method in interface com.ibm.pim.view.ScreenView
Get the editable attribute collections for this screen view
getEditableAttributeCollections() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the editable (but not required) attribute collections for this step.
getEditableAttributeCollections(ScreenType) - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the editable (but not required) attribute collections for a given screen type on this step.
getEditableAttributeCollections(Hierarchy) - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the editable (but not required) attribute collections on the specified location hierarchy for this step.
getEditableAttributes() - Method in interface com.ibm.pim.view.ScreenView
Get all editable attributes from the editable attribute collections on this screen view at the present time.
getEmail() - Method in interface com.ibm.pim.organization.User
Retrieves the User's email address
getEnabled() - Method in interface com.ibm.pim.job.Schedule
Indicates if the schedule is enabled or not.
getEncodedFormFromOffset(int) - Method in interface com.ibm.pim.utils.TimezoneResolver
Accepts an integer value, representing an offset in minutes past GMT, and returns an encoded timezone (if one exists) that represents that offset.
getEncodedFormFromTimezoneString(String) - Method in interface com.ibm.pim.utils.TimezoneResolver
Accepts a textual representation of a timezone, and returns an appropriate encoded timezone (if one exists) Where there are multiple possible matches for a timezone string, this method will return the first match found.
getEncodedTimezoneStrings() - Method in interface com.ibm.pim.utils.TimezoneResolver
Retrieve an array of all encoded timezone strings, representing every timezone.
getEndTime() - Method in interface com.ibm.pim.job.ScheduleStatus
Gets the time at which the schedule exits this status.
getEndVersion() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains the end version for this export.
getEntranceDate() - Method in interface com.ibm.pim.collaboration.CollaborationObject
Get the most recent date this collaboration object was either checked out into its collaboration area or moved from another collaboration area into this one.
getEntranceNotificationAddresses() - Method in interface com.ibm.pim.workflow.WorkflowStep
Fetch a list of email addresses which will be notified when items/categories enter this Workflow Step.
getEntries() - Method in interface com.ibm.pim.spec.SpecMap
Return the mappings between source AttributeDefinitions and destination AttributeDefinitions in the specMap.
getEnvironmentExporter() - Method in interface com.ibm.pim.context.Context
Gets the EnvironmentExporter for this context
getEnvironmentImporter() - Method in interface com.ibm.pim.context.Context
Gets the EnvironmentImporter for this context
getErrorCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of errors during the script execution.
getErrorLineCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of error lines.
getErrors() - Method in interface com.ibm.pim.common.ValidationErrors
Returns the list of validation errors on the source.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains access to the writer for error output created by this CatalogExportFunction.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CatalogPreviewFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CategoryDefaultValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CategoryMacroFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CategoryNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CategoryPrePostProcessingFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CategoryPreviewFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CategoryRunValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CategoryStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CategoryValidationRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryDefaultValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryMacroFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPrePostProcessingFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPreviewFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryRunValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryValidationRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemDefaultValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemMacroFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPrePostProcessingFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPreviewFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemRunValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemValidationRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.CustomToolsFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.DistributionFunctionArguments
Obtains access to the writer for error output created by this DistributionFunction.
getErrors() - Method in interface com.ibm.pim.extensionpoints.EntryBuildFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains access to the writer for error output created by this ImportFunction.
getErrors() - Method in interface com.ibm.pim.extensionpoints.ItemDefaultValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.ItemMacroFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.ItemNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.ItemPrePostProcessingFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.ItemPreviewFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.ItemRunValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.ItemStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.ItemValidationRuleFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.PostCategorySaveFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationCategorySaveFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationItemSaveFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.PostItemSaveFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrors() - Method in interface com.ibm.pim.extensionpoints.ScriptingSandboxFunctionArguments
Obtains access to the writer for error output created by this invocation.
getErrorsForLocation(Category) - Method in interface com.ibm.pim.common.ExtendedValidationErrors
Returns the list of validation errors on the source for a given location.
getExecutable() - Method in interface com.ibm.pim.job.Job
Retrieves the job executable object.
getExitValue() - Method in interface com.ibm.pim.collaboration.CollaborationHistoryEvent
Get the exit value associated with the event.
getExitValue(CollaborationObject) - Method in interface com.ibm.pim.collaboration.CollaborationStepTransitionConfiguration
Gets the current exit value for the specified collaboration object.
getExitValue(String) - Method in interface com.ibm.pim.workflow.WorkflowStep
Fetch an ExitValue object from this Workflow Step, identified by the String passed in.
getExitValueForItem() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPrePostProcessingFunctionArguments
Obtains the exitValue for a workflow item, It gives info abput which button has been clicked when workflow item was moved to another step.
getExitValueForItem() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationItemSaveFunctionArguments
Obtains the exitValue for a workflow item, It gives info abput which button has been clicked when workflow item was moved to another step.
getExitValues() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get all the possible exit values for items/categories leaving this Workflow Step.
getExport(String) - Method in interface com.ibm.pim.job.JobManager
Fetches the export with the specified name
getExports() - Method in interface com.ibm.pim.job.JobManager
Fetches all the exports.
getFailedValidationCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of failed validations.
getFailureStep() - Method in interface com.ibm.pim.workflow.Workflow
Get the Failure Step of this workflow.
getFax() - Method in interface com.ibm.pim.organization.User
Retrieves the User's facsimile number
getFileSpec() - Method in interface com.ibm.pim.job.ItemImport
Fetches the FileSpec associated to this import
getFileType() - Method in interface com.ibm.pim.spec.FileSpec
Get the fileType associated to this File Spec
getFilter(String) - Method in interface com.ibm.pim.view.ScreenView
Retrieve a filter on this screen view by name
getFilters() - Method in interface com.ibm.pim.view.ScreenView
Get all view filters currently set against this screen view
getFirstName() - Method in interface com.ibm.pim.organization.User
Retrieves the User's first name
getFixit() - Method in interface com.ibm.pim.workflow.Workflow
Get Fixit for this Workflow
getFloat(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as Java Float value.
getFullPaths(boolean) - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Returns the full name paths of this Category.
getFullPaths(String, boolean) - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Returns the full name paths of this Category.
getFullPaths(boolean) - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the full name paths of this Category.
getFullPaths(String, boolean) - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the full name paths of this Category.
getFullPaths(boolean) - Method in interface com.ibm.pim.organization.Organization
Returns the full name paths of this Organization.
getFullPaths(String, boolean) - Method in interface com.ibm.pim.organization.Organization
Returns the full name paths of this Organization.
getHierarchies() - Method in interface com.ibm.pim.hierarchy.HierarchyManager
Retrieves all Hierarchies current user is authorized to As prescribed via Permission.HIERARCHY_LIST
getHierarchiesForRecategorization() - Method in interface com.ibm.pim.workflow.Workflow
Get the current hierarchies in use when recategorization items/categories from within collaboration areas based on this workflow.
getHierarchy() - Method in interface com.ibm.pim.catalog.LocationDataConfiguration
Retrieves the Hierarchy for this particular Configuration
getHierarchy() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains the hierarchy for the catalog of this CatalogExportFunction.
getHierarchy() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains the category tree being processed for this ImportFunction.
getHierarchy() - Method in interface com.ibm.pim.extensionpoints.RichSearchReportFunctionArguments
Obtains the hierarchy for this RichSearchReportFunction.
getHierarchy() - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the Hierarchy object containing this Category object.
getHierarchy(String) - Method in interface com.ibm.pim.hierarchy.HierarchyManager
Retrieves a specific hierarchy by name.
getHierarchy(String, VersionInfo) - Method in interface com.ibm.pim.hierarchy.HierarchyManager
Retrieves a particular version of a specified Hierarchy
getHierarchy(View) - Method in interface com.ibm.pim.hierarchy.HierarchyManager
Get the Hierarchy by which a particular view is owned
getHierarchy() - Method in interface com.ibm.pim.job.CategoryImport
Returns the destination hierarchy for an category import
getHierarchy() - Method in interface com.ibm.pim.job.Export
Returns the destination hierarchy for an category export
getHierarchy() - Method in interface com.ibm.pim.organization.Organization
Returns the OrganiztionHierarchy object containing this Organization object.
getHierarchy(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as MDMPIM Hierarchy object.
getHierarchy() - Method in interface com.ibm.pim.selection.StaticItemSelection
Fetches the hierarchy used with the selection
getHierarchy() - Method in interface com.ibm.pim.userdefinedlog.CategoryUserDefinedLog
Fetches the hierarchy with which this UserDefinedLog is associated.
getHierarchyManager() - Method in interface com.ibm.pim.context.Context
Gets the HierarchyManager for this context
getHierarchyMap(Hierarchy, Hierarchy) - Method in interface com.ibm.pim.hierarchy.HierarchyManager
Returns the hierarchy map between the two given hierarchies.
getHierarchyMaps() - Method in interface com.ibm.pim.utils.ImportList
Fetches the names of all hierarchy maps as a list of HashMap.
getHistory() - Method in interface com.ibm.pim.job.Schedule
Gets all statuses that the schedule went through, including the latest status.
getIISIntegration() - Method in interface com.ibm.pim.context.Context
Returns object of IISIntegration
getImplementationClassName() - Method in interface com.ibm.pim.webservice.WebService
Returns the implementation class name for the webservice.
getImplementationScript() - Method in interface com.ibm.pim.webservice.WebService
Returns the Document object represents the implementation script for the web service.
getImport(String) - Method in interface com.ibm.pim.job.JobManager
Fetches the import with the specified name
getImportList(Document) - Method in interface com.ibm.pim.utils.EnvironmentImporter
Gets the list of PIM objects in a zip file in the docstore.
getImportList(String) - Method in interface com.ibm.pim.utils.EnvironmentImporter
Gets the list of PIM objects in a zip file present at the specified documentPath.
getImports() - Method in interface com.ibm.pim.job.JobManager
Fetches all the imports.
getInheritedChildren() - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
Get the inherited children which contains multi-occurrence children that apply if the "own" multi-occurrence attribute instance has no children.
getInheritedValue() - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
Returns the inherited value for this attribute, which provides both the inherited value and where it came from.
getInitialStep() - Method in interface com.ibm.pim.workflow.Workflow
Get the Initial Step of this workflow.
getInput() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains the input stream being processed for this ImportFunction.
getInput() - Method in interface com.ibm.pim.extensionpoints.ScriptingSandboxFunctionArguments
Obtains access to the input stream supplied for this invocation.
getInputParameterValue(String) - Method in interface com.ibm.pim.job.Report
Fetches the value for a report parameter
getInputs() - Method in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunctionArguments
Obtains the inputs for this CatalogToCatalogExportFunction .
getInputs() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains the input arguments, if defined
getInputs() - Method in interface com.ibm.pim.extensionpoints.ReportGenerateFunctionArguments
Obtains the inputs held in the docstore for this ReportGenerateFunction.
getInt(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as a Java int value.
getItem() - Method in interface com.ibm.pim.extensionpoints.DataEntryFunctionArguments
Obtains item for this DataEntryFunction.
getItem() - Method in interface com.ibm.pim.extensionpoints.EntryBuildFunctionArguments
Obtains the item entry being processed for this EntryBuildFunction.
getItem() - Method in interface com.ibm.pim.extensionpoints.ItemDefaultValueRuleFunctionArguments
Obtains the item to be processed by this rule function.
getItem() - Method in interface com.ibm.pim.extensionpoints.ItemMacroFunctionArguments
Obtains the item entry being processed for this EntrymacroFunction.
getItem() - Method in interface com.ibm.pim.extensionpoints.ItemNonPersistedAttributeRuleFunctionArguments
Obtains the item to be processed by this rule function.
getItem() - Method in interface com.ibm.pim.extensionpoints.ItemPrePostProcessingFunctionArguments
Obtains the item to be processed by this pre/post function.
getItem() - Method in interface com.ibm.pim.extensionpoints.ItemRunValueRuleFunctionArguments
Obtains the item to be processed by this rule function.
getItem() - Method in interface com.ibm.pim.extensionpoints.ItemStringEnumerationValueRuleFunctionArguments
Obtains the item to be processed by this rule function.
getItem() - Method in interface com.ibm.pim.extensionpoints.ItemValidationRuleFunctionArguments
Obtains the item to be processed by this rule function.
getItem() - Method in interface com.ibm.pim.extensionpoints.PostItemSaveFunctionArguments
Obtains the current item for this invocation.
getItem(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as MDMPIM Item object.
getItemBuildScript() - Method in interface com.ibm.pim.catalog.Catalog
Retrieves the script document associated with an invocation point defined by the Catalog
getItemByPrimaryKey(String) - Method in interface com.ibm.pim.catalog.Catalog
Retrieve an Item within the catalog using the Item's primary key as a String
getItemCategoryMappingAddedCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of item category mapping added.
getItemListURL(Catalog, Category) - Method in interface com.ibm.pim.system.UIHelper
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.
getItems() - Method in interface com.ibm.pim.catalog.Catalog
Retrieve a collection of all of the Items within this Catalog
getItems() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains the items being processed for this CatalogExportFunction.
getItems() - Method in interface com.ibm.pim.extensionpoints.CatalogPreviewFunctionArguments
Obtains the items being processed for this CatalogPreviewFunction.
getItems() - Method in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunctionArguments
Obtains the items being processed for this CatalogExportFunction.
getItems() - Method in interface com.ibm.pim.extensionpoints.ItemPreviewFunctionArguments
Obtains the items for this EntryPreviewFunction.
getItems() - Method in interface com.ibm.pim.extensionpoints.WorkflowStepFunctionArguments
Obtains the set of Item entries being processed for this WorkflowStepFunction.
getItems(Catalog) - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the items associated with this category in the given catalog.
getItems(Catalog, boolean) - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the items associated with this category in the given catalog.
getItems() - Method in interface com.ibm.pim.selection.DynamicItemSelection
Fetches the items in the selection
getItems() - Method in interface com.ibm.pim.selection.StaticItemSelection
Fetches the items in the selection
getItemsAddedCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of items added during the script execution.
getItemsAlreadyCheckedOutCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of items already checked out.
getItemsByPrimaryKeys(List<String>) - Method in interface com.ibm.pim.catalog.Catalog
Returns a collection of items from this catalog described by their primary keys
getItemsCheckedOutCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of items checkd out.
getItemsDeletedCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of items deleted during the script execution.
getItemSecondarySpecs() - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the item secondary specs associated with this category.
getItemSecondarySpecs(Catalog) - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the item secondary specs associated with this category applied to items in the given catalog.
getItemSelection() - Method in interface com.ibm.pim.job.Export
Returns the item selection used for this export, may return null if entire catalog was used.
getItemsModifiedCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of items modified during the script execution.
getItemsNotFoundCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of items not found.
getItemsProcessedCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Return the number of items processed during the script execution.
getItemsWithAttributeValue(String, Object) - Method in interface com.ibm.pim.catalog.Catalog
Returns a collection of items from this catalog where the specified attribute instance has the specified value
getJob(String) - Method in interface com.ibm.pim.job.JobManager
Retrieves the detail information about the job.
getJob() - Method in interface com.ibm.pim.job.Schedule
Get the job to be scheduled.
getJobManager() - Method in interface com.ibm.pim.context.Context
Obtain a new JobManager object.
getJobs() - Method in interface com.ibm.pim.job.JobManager
Gets all jobs in the system.
getKey() - Method in interface com.ibm.pim.lookuptable.LookupTableEntry
Returns the key that for the item values in this LookupTableEntry
getLastModifiedTimeMillis() - Method in interface com.ibm.pim.attribute.AttributeOwner
Get the last modified time in milliseconds for the given attribute
getLastModifiedTimestamp() - Method in interface com.ibm.pim.docstore.Document
Fetches the date and time at which this document was last modified.
getLastName() - Method in interface com.ibm.pim.organization.User
Retrieves the User's last name
getLastRunSchedule() - Method in interface com.ibm.pim.job.Job
Get the last run schedule.
getLatestComment() - Method in interface com.ibm.pim.collaboration.CollaborationObject
Get the most recent comment for this collaboration object (for any event).
getLatestCompletedStatus() - Method in interface com.ibm.pim.job.Schedule
Gets the completed status of last run schedule.
getLatestRunCompletionPercentage() - Method in interface com.ibm.pim.job.Schedule
Gets the completion percentage of the specified job schedule and return percent complete as integer number if the job is currently running, -1 otherwise.
getLdapEntryDn() - Method in interface com.ibm.pim.organization.User
Retrieves the LDAP Distinguished name if assigned to this user
getLdapServerUrl() - Method in interface com.ibm.pim.organization.User
Retrieves the LDAP Server URL used to authenticate this user
getLevels() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Returns the levels of this category in an array of Integers.
getLevels() - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the levels of this category in an array of Integers.
getLevels() - Method in interface com.ibm.pim.organization.Organization
Returns the levels of this organization in an array of Integers.
getLinesProcessedCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Return the number of lines processed during the script execution.
getLinkedItem() - Method in interface com.ibm.pim.attribute.AttributeInstance
If the attribute instance is a link attribute, this will return an item object only if the item with that primary key exists else it will return null.
getLinkedItems() - Method in interface com.ibm.pim.catalog.item.Item
Retrieves all of the Items that are linked to this item's primary key.
getLocaleRestrictions() - Method in interface com.ibm.pim.attribute.AttributeCollection
Returns the locales to which this attribute collection is restricted.
getLocales() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Get locales for this attribute, if it is localized; returns empty collection otherwise.
getLocales() - Method in interface com.ibm.pim.context.Context
Gets all the locales supported by the system.
getLocales() - Method in interface com.ibm.pim.organization.Company
Retrieves all Locales available to this company
getLocales() - Method in interface com.ibm.pim.organization.Role
The Locales applied to this role
getLocales(Catalog) - Method in interface com.ibm.pim.organization.Role
Retrieve the Locales applied to this role for a specific catalog
getLocales(Hierarchy) - Method in interface com.ibm.pim.organization.Role
Retrieve the Locales applied to this role for a specific hierarchy
getLocales() - Method in interface com.ibm.pim.spec.Spec
Returns all associated Locales if this Spec is localized
getLocalized(Locale) - Method in interface com.ibm.pim.attribute.AttributeDefinition
Get the localized attribute, according to the locale passed in
getLocalizedName() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Returns the localized name for this AttributeDefinition, based on currently selected Locale for Item and Category data display.
getLocalizedNameforLocale(Locale) - Method in interface com.ibm.pim.attribute.AttributeDefinition
Returns Localized Name for particular Locale.
getLocalizedNames() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Returns all localized names for each of the selected Locale for the spec.
getLocation() - Method in interface com.ibm.pim.attribute.InheritedValue
Information on what location the inherited value came from
getLocation() - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
Returns the LocationData object this LocationDataAttributeInstance belongs to.
getLocationAttributeInstance(Category, String) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Retrieve the attribute instance at the specified path
getLocationAttributeValue(Category, String) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Retrieve the attribute value at the specified path for this entry at this location.
getLocationDataConfigurations() - Method in interface com.ibm.pim.catalog.Catalog
Retrieves all location specific data for the current catalog.
getLocationHierarchies() - Method in interface com.ibm.pim.catalog.Catalog
Returns a collection of location hierarchies applicable to this Catalog.
getLocationHierarchies() - Method in interface com.ibm.pim.catalog.item.Item
Returns all the location hierarchies which are available on this catalog for this item, regardless of whether it has stored any data in them.
getLocationHierarchies() - Method in interface com.ibm.pim.collaboration.CollaborationItem
Returns all the location hierarchies which are available on this catalog for this item, regardless of whether it has stored any data in them.
getLocationHierarchiesWithCanModifyAvailabilitySettings() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the location hierarchies which have "can modify availability" settings for this workflow (This will affect whether user can modify availability of locations within those hierarchies, for items within the collaboration area based on this workflow)
getLocationsAddedAsAvailable(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeChanges
Return a List of all available locations in B that were not marked available in A
getLocationsChangedNotToHaveData(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeChanges
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
getLocationsChangedToHaveData(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeChanges
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
getLocationsHavingChangedData(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeChanges
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.
getLocationsHavingData(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Identifies the locations this item has location specific data for from the set of locations given by the passed in location and its descendants.
getLocationsRemovedAsAvailable(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeChanges
Return a List of all available locations in A that are no longer marked available in B
getLocationsWithErrors() - Method in interface com.ibm.pim.common.ExtendedValidationErrors
Returns a collection of locations associated with the source that have validation errors.
getLogEntries(Category) - Method in interface com.ibm.pim.userdefinedlog.CategoryUserDefinedLog
Fetches the UserDefinedLogEntry objects corresponding to the category passed in.
getLogEntries(Item) - Method in interface com.ibm.pim.userdefinedlog.ItemUserDefinedLog
Retrieves all UserDefinedLogEntry objects associated with a specific item
getLogEntries(Item, Category) - Method in interface com.ibm.pim.userdefinedlog.ItemUserDefinedLog
Retrieves all UserDefinedLogEntry objects associated with the item which belongs to the specific category passed as argument.
getLogEntries() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLog
Retrieves all UserDefinedLogEntry objects associated with this UserDefinedLog
getLogger(String) - Method in interface com.ibm.pim.context.Context
Returns an instance of Logger as defined in configuration file /etc/default/api_log.xml
getLong(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as Java long value.
getLookupTable(String) - Method in interface com.ibm.pim.lookuptable.LookupTableManager
Retrieves the latest version of specific LookupTable by name.
getLookupTable(String, VersionInfo) - Method in interface com.ibm.pim.lookuptable.LookupTableManager
Retrieves a particular version of a specified LookupTable
getLookupTableEntries() - Method in interface com.ibm.pim.lookuptable.LookupTable
Retrieves all the LookupTableEntries for this LookupTable
getLookupTableEntry(String) - Method in interface com.ibm.pim.lookuptable.LookupTable
Retrieve a LookupTableEntry identified by the given key
getLookupTableManager() - Method in interface com.ibm.pim.context.Context
Gets the LookupTableManager for this context
getLookupTables() - Method in interface com.ibm.pim.lookuptable.LookupTableManager
Retrieves all LookupTables available in the current context
getManagerName() - Method in interface com.ibm.pim.common.Manager
Returns the name of this Manager
getMaxOccurrence() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Returns the value of the MAX_OCCURRENCE attribute of this AttributeDefinition
getMessage() - Method in interface com.ibm.pim.common.ValidationError
Get the message for this Validation Error
getMinOccurrence() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Returns the value of the MIN_OCCURRENCE attribute of this AttributeDefinition
getModifiedAttributesWithNewData() - Method in interface com.ibm.pim.attribute.AttributeChanges
 
getModifiedAttributesWithOldData() - Method in interface com.ibm.pim.attribute.AttributeChanges
 
getModifiedLocationAttributesWithNewData(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeChanges
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.
getModifiedLocationAttributesWithOldData(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeChanges
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.
getName() - Method in interface com.ibm.pim.attribute.AttributeCollection
Returns the name of this attribute collection.
getName() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Returns the name of the AttributeDefinition.
getName() - Method in interface com.ibm.pim.attribute.AttributeDefinitionProperty
Returns the type of this AttributeDefinitionProperty
getName() - Method in interface com.ibm.pim.catalog.Catalog
Retrieves the Catalog name
getName() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the name for the current collaboration area.
getName() - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns the name of this collaboration step.
getName() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves the name of this hierarchy.
getName() - Method in interface com.ibm.pim.job.Executable
Gets the description of the executable.
getName() - Method in interface com.ibm.pim.job.Schedule
Gets schedule name.
getName() - Method in interface com.ibm.pim.job.UserJob
Fetches the name of the user job
getName() - Method in interface com.ibm.pim.lookuptable.LookupTable
Retrieves the LookupTable name
getName() - Method in interface com.ibm.pim.organization.AccessControlGroup
Retrieves the name applied to this access control group
getName() - Method in interface com.ibm.pim.organization.Company
Retrieves the company name.
getName() - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Retrieves the name of this hierarchy.
getName() - Method in interface com.ibm.pim.organization.Role
The name given to this role
getName() - Method in interface com.ibm.pim.selection.Selection
Fetches the name of the selection
getName() - Method in interface com.ibm.pim.spec.Spec
Returns the Spec Name
getName() - Method in interface com.ibm.pim.spec.SpecMap
Returns the name of the SpecMap
getName() - Method in interface com.ibm.pim.system.PIMWriter
Returns the name of the writer.
getName() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLog
Returns the name for this UserDefinedLog
getName() - Method in interface com.ibm.pim.utils.DataSource
Returns the name of this datasource
getName() - Method in interface com.ibm.pim.utils.Distribution
Returns the name of this distribution
getName() - Method in interface com.ibm.pim.utils.DistributionGroup
Retrieves the name of this distribution
getName() - Method in interface com.ibm.pim.view.ScreenViewFilter
Get the name of the view filter
getName() - Method in interface com.ibm.pim.view.View
retrieve the name of the view
getName() - Method in interface com.ibm.pim.webservice.WebService
Returns the name of the webservice.
getName() - Method in interface com.ibm.pim.workflow.Workflow
Get the name of the Workflow.
getName() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the step name.
getNewlyAddedAttributes() - Method in interface com.ibm.pim.attribute.AttributeChanges
 
getNewlyAddedAttributes(boolean) - Method in interface com.ibm.pim.attribute.AttributeChanges
Returns a List of attributes that were not present in A but are present in B
getNewlyAddedLocationAttributes(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeChanges
Return a List of attributes that were not present in A but present in B.
getNewlyAddedLocationAttributes(Category, boolean) - Method in interface com.ibm.pim.attribute.ExtendedAttributeChanges
Return a List of attributes that were not present in A but present in B.
getNextRunningTime() - Method in interface com.ibm.pim.job.Schedule
Gets the next running time of a job schedule.
getNextSteps() - Method in interface com.ibm.pim.workflow.WorkflowStep
Fetch a collection of all next Workflow Steps for this Workflow Step, irrespective of exit value.
getNextSteps(ExitValue) - Method in interface com.ibm.pim.workflow.WorkflowStep
Fetch the next Workflow Steps, for the specified ExitValue on this step
getNextSteps(String) - Method in interface com.ibm.pim.workflow.WorkflowStep
Fetch the next WorkflowSteps for the specified Exit Value on this step
getNonEmptyCollaborationAreas() - Method in interface com.ibm.pim.collaboration.CollaborationAreaManager
 
getNonEmptySteps() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the list of all non-empty steps in the current collaboration area.
getNonInheritedChildren() - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
This method is exactly like getChildren, except that inherited children are ignored.
getNonInheritedValue() - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
Returns the "own" value for this attribute.
getNumberOfCheckedOutCategories() - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Gets the number of checked out categories in the collaboration area.
getNumberOfCheckedOutItems() - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Get the number of checked out items in the collaboration area.
getNumberOfObjects() - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns the number of collaboration objects in this collaboration step.
getObjectNames(ExportList.Type) - Method in interface com.ibm.pim.utils.ImportList
Fetches the names of all objects of the given type in the list.
getObjectTypes() - Method in interface com.ibm.pim.utils.ExportList
Returns the type of objects which were added to this ExportList.
getObjectTypes() - Method in interface com.ibm.pim.utils.ImportList
Fetches the object types in the Import list.
getOccurrenceIndex() - Method in interface com.ibm.pim.attribute.AttributeInstance
Return the index that would be used to qualify this attribute instance in a path.
getOffsetFromEncodedForm(String) - Method in interface com.ibm.pim.utils.TimezoneResolver
Accepts an encoded timezone, as retrievable via getAttribute, and returns the offset in minutes from GMT
getOptionalProperties() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Retrieve attributes of this AttributeDefinition (optional attributes only)
getOrganizationByPath(String) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Retrieves a Organization based upon Path name
getOrganizationByPath(String, String) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Retrieves a Organization based upon Path name
getOrganizationByPrimaryKey(String) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Retrieves a Organization based upon Primary key
getOrganizationHierarchies() - Method in interface com.ibm.pim.organization.OrganizationManager
Retrieves all Organization Hierarchies available in the current context As prescribed via Permission.HIERARCHY_LIST
getOrganizationHierarchy(String) - Method in interface com.ibm.pim.organization.OrganizationManager
Retrieves a specific organization hierarchy by name.
getOrganizationManager() - Method in interface com.ibm.pim.context.Context
Gets the OrganizationManager for this context
getOrganizations() - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Retrieves a collection of all the Organization objects in this hierarchy.
getOrganizations() - Method in interface com.ibm.pim.organization.User
Retrieves the Organizations the user belongs to.
getOrganizationsAtLevel(int) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Retrieves a collection of all the Organization objects in this hierarchy residing at a particular level.
getOrganizationsByPaths(Collection<String>) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Retrieves a collection of all the Organization objects in this hierarchy based upon their path names.
getOrganizationsByPaths(Collection<String>, String) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Retrieves a collection of all the Organization objects in this hierarchy based upon their path names.
getOrganizationsMappedTo() - Method in interface com.ibm.pim.catalog.item.Item
Return a collection of all Organizations this item is mapped to
getOrganizationsMappedTo() - Method in interface com.ibm.pim.hierarchy.category.Category
Return a collection of Organizations this category is mapped to
getOrganizationsWithAttributeValue(String, Object) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Retrieves a collection of all the Organization objects in this hierarchy based upon a particular attribute value.
getOriginalAttributeOwner() - Method in interface com.ibm.pim.attribute.AttributeOwner
Get the original attribute owner
getOriginalDocFolder() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains the path within the docstore where output is created as part of this CatalogExportFunction.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains access to the writer for output created by this CatalogExportFunction.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CatalogPreviewFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CategoryDefaultValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CategoryMacroFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CategoryNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CategoryPrePostProcessingFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CategoryPreviewFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CategoryRunValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CategoryStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CategoryValidationRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryDefaultValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryMacroFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPrePostProcessingFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPreviewFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryRunValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryValidationRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemDefaultValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemMacroFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPrePostProcessingFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPreviewFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemRunValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemValidationRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.CustomToolsFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.DistributionFunctionArguments
Obtains access to the writer for output created by this DistributionFunction.
getOutput() - Method in interface com.ibm.pim.extensionpoints.EntryBuildFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains access to the writer for output created by this ImportFunction.
getOutput() - Method in interface com.ibm.pim.extensionpoints.ItemDefaultValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.ItemMacroFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.ItemNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.ItemPrePostProcessingFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.ItemPreviewFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.ItemRunValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.ItemStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.ItemValidationRuleFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.PostCategorySaveFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationCategorySaveFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationItemSaveFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.PostItemSaveFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.ReportGenerateFunctionArguments
Obtains access to the writer for output created by this CatalogExportFunction.
getOutput() - Method in interface com.ibm.pim.extensionpoints.ScriptingSandboxFunctionArguments
Obtains access to the writer for output created by this invocation.
getOutput() - Method in interface com.ibm.pim.extensionpoints.TriggerFunctionArguments
Obtains access to the writer for output created by this invocation.
getOwner() - Method in interface com.ibm.pim.attribute.AttributeInstance
Return the AttributeOwner associated with this AttributeInstance.
getOwner() - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
Same as super.getOwner(), except returns a more specific type.
getParameterNames() - Method in interface com.ibm.pim.job.Job
Gets the names of all parameters for the job.
getParameterNames() - Method in interface com.ibm.pim.job.Schedule
Gets the names of all parameters for the job schedule.
getParameterValue(String) - Method in interface com.ibm.pim.job.Job
Gets the value for the specified parameter.
getParameterValue(String) - Method in interface com.ibm.pim.job.Schedule
Gets the value for the specific parameter.
getParent() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Return the parent AttributeDefinition of this AttributeDefinition, if applicable
getParent() - Method in interface com.ibm.pim.attribute.AttributeInstance
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.
getParent() - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
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.
getParent() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Returns this category's parent.
getParent() - Method in interface com.ibm.pim.hierarchy.category.Category
Returns this category's parent.
getParent() - Method in interface com.ibm.pim.organization.Organization
Returns this organization's parent.
getParents() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Returns the parent categories of the given Category.
getParents() - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the parent categories of the given Category.
getParents() - Method in interface com.ibm.pim.organization.Organization
Returns the parent categories of the given Organization.
getPath() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Returns the complete path of this AttributeDefinition in the format SpecName/AttributeDefinitionName
getPath() - Method in interface com.ibm.pim.attribute.AttributeInstance
Return the path for this AttributeInstance, like /MySpec/MyMultiGrouping#1/MyStringAttribute.
getPath() - Method in interface com.ibm.pim.docstore.Directory
Fetches the path of this directory in the docstore.
getPath() - Method in interface com.ibm.pim.docstore.Document
Fetches the path of the document in the docstore.
getPathAttribute() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Returns the path attribute for this hierarchy
getPathAttribute() - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Returns the path attribute for this hierarchy
getPerformers() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the collection of all performers for this Workflow Step.
getPermissionList(Role) - Method in interface com.ibm.pim.organization.AccessControlGroup
Identifies the permissions set on for this Access Control Group
getPermissionList(AccessControlGroup) - Method in interface com.ibm.pim.organization.Role
Fetches the Permissions granted to this role as part of the given access control group.
getPhone() - Method in interface com.ibm.pim.organization.User
Retrieves the User's phone number
getPIMScript(String) - Method in interface com.ibm.pim.system.PIMScriptManager
Fetches the PIMScript with given path from the PIM system or file system.
getPIMScriptManager() - Method in interface com.ibm.pim.context.Context
Gets the PIMScriptManager for this context
getPossibleValues() - Method in interface com.ibm.pim.attribute.AttributeInstance
For applicable attribute types, retrieve all possible values (e.g.
getPostSaveScript() - Method in interface com.ibm.pim.catalog.Catalog
Retrieves the script document associated with an invocation point defined by the Catalog
getPostSaveScript() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Retrieves the script document associated with an invocation point defined by the Collaboration area.
getPostSaveScript() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves the script document associated with an invocation point defined by the Hierarchy
getPostScript() - Method in interface com.ibm.pim.catalog.Catalog
Retrieves the script document associated with an invocation point defined by the Catalog
getPostScript() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Retrieves the script document associated with an invocation point defined by the collaboration area.
getPostScript() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves the script document associated with an invocation point defined by the Hierarchy
getPreScript() - Method in interface com.ibm.pim.catalog.Catalog
Retrieves the script document associated with an invocation point defined by the Catalog
getPreScript() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Retrieves the script document associated with an invocation point defined by the collaboration area
getPreScript() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves the script document associated with an invocation point defined by the Hierarchy
getPrimaryHierarchy() - Method in interface com.ibm.pim.catalog.Catalog
Retrieve the primary Hierarchy associated with this Catalog
getPrimaryKey() - Method in interface com.ibm.pim.catalog.item.Item
Returns the primary key.
getPrimaryKey() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Return the primary key of this Category
getPrimaryKey() - Method in interface com.ibm.pim.collaboration.CollaborationHistoryEvent
Get the primary key of the item or category involved in the event.
getPrimaryKey() - Method in interface com.ibm.pim.collaboration.CollaborationItem
Returns the primary key.
getPrimaryKey() - Method in interface com.ibm.pim.hierarchy.category.Category
Return the primary key of this Category
getPrimaryKeyAttributeDefinition() - Method in interface com.ibm.pim.spec.LookupSpec
Returns the primary key AttributeDefinition for this LookupSpec
getPrimaryKeyAttributeDefinition() - Method in interface com.ibm.pim.spec.PrimarySpec
Returns the primary key AttributeDefinition for this PrimarySpec
getPrimarySpec() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves the Primary spec for this hierarchy.
getPrimarySpec() - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Retrieves the Primary spec for this hierarchy.
getProcessingOptions() - Method in interface com.ibm.pim.catalog.Catalog
Provide temporary ways to change the default behavior for performance reasons.
getProcessingOptions() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Provide temporary ways to change the default behavior for performance reasons.
getProcessingOptions() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Provide temporary ways to change the default behavior for performance reasons.
getProgress() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtain the instance of WPCProgress that may be used to report progress to WPC during the execution of this CatalogExportFunction.
getProgress() - Method in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunctionArguments
Obtain the instance of WPCProgress that may be used to report progress to WPC during the execution of this CatalogToCatalogExportFunction.
getProgress() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtain the instance of WPCProgress that may be used to report progress to WPC during the execution of this ImportFunction.
getProgress() - Method in interface com.ibm.pim.extensionpoints.ReportGenerateFunctionArguments
Obtains a WPCProgress object that can be used to report execution progress for this invocation.
getProgress() - Method in interface com.ibm.pim.system.PIMProgress
Returns the progress.
getProperties() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Retrieve attributes of this AttributeDefinition (both required and optional attributes)
getProperties() - Method in interface com.ibm.pim.system.PIMWriter
Returns the properties of the writer.
getProperty(AttributeDefinitionProperty.Name) - Method in interface com.ibm.pim.attribute.AttributeDefinition
Get a property of this attribute
getProperty(Document.Property) - Method in interface com.ibm.pim.docstore.Document
Fetches the value of the property given by property name
getProperty(String) - Method in interface com.ibm.pim.docstore.Document
Fetches the value of the property given by propertyName
getProperty(DataSource.Property) - Method in interface com.ibm.pim.utils.DataSource
Retrieves the properties of this datasource
getProperty(Distribution.Property) - Method in interface com.ibm.pim.utils.Distribution
Retrieves the properties of this distribution
getPropertyNames() - Method in interface com.ibm.pim.docstore.Document
Returns a collection of names of properties of this document.
getQuery() - Method in interface com.ibm.pim.selection.DynamicSelection
Fetches the query for this dynamic selection
getRealPath() - Method in interface com.ibm.pim.docstore.Document
Returns the path of the document in the file system, if the document is present in the file system.
getRecurring() - Method in interface com.ibm.pim.job.Job
Indicates if the job can be recurring.
getRelatedItems(Catalog, boolean) - Method in interface com.ibm.pim.catalog.item.Item
Retrieves all of the Items that this item is connected to via a relationship link on other items.
getReport(String) - Method in interface com.ibm.pim.job.JobManager
Fetches the report with the specified name
getReports() - Method in interface com.ibm.pim.job.JobManager
Fetches all the reports.
getReportSet() - Method in interface com.ibm.pim.extensionpoints.RichSearchReportFunctionArguments
Obtains the set for this report.
getRequest() - Method in interface com.ibm.pim.extensionpoints.CustomToolsFunctionArguments
Obtains HTTP request being processed for this CustomToolsFunction.
getRequest() - Method in interface com.ibm.pim.extensionpoints.TriggerFunctionArguments
Obtains HTTP request being processed for this TriggerFunction.
getRequestDocument() - Method in interface com.ibm.pim.webservice.WebServiceTransaction
Returns Document which represents the inbound message.
getRequiredAttributeCollections() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the required & editable attribute collections for this step.
getRequiredAttributeCollections(ScreenType) - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the required & editable attribute collections for a given screen type on this step.
getRequiredAttributeCollections(Hierarchy) - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the required & editable attribute collections on the specified location hierarchy for this step.
getRequiredProperties() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Retrieve attributes of this AttributeDefinition (required attributes only)
getRequisiteObjects(ExportList.Type) - Method in interface com.ibm.pim.utils.ExportRequisiteList
Fetches all the requisite objects of a given type.
getRequisiteObjects(ExportList.Type, Object, ExportList.Type) - Method in interface com.ibm.pim.utils.ExportRequisiteList
Fetches all the objects of the given type which the object in the export list requires for successful creation.
getRequisiteObjects(ExportList.Type) - Method in interface com.ibm.pim.utils.ImportRequisiteList
Fetches all the requisite objects of a given type.
getRequisiteObjectsForHierarchyMap(String, String, ExportList.Type) - Method in interface com.ibm.pim.utils.ImportRequisiteList
Fetches all the objects of the given type which the object in the import list requires for successful creation.
getRequisiteObjectsForObjectByType(ExportList.Type, String, ExportList.Type) - Method in interface com.ibm.pim.utils.ImportRequisiteList
Fetches all the objects of the given type which the object in the import list requires for successful creation.
getRequisites() - Method in interface com.ibm.pim.utils.ExportList
Returns the objects that the objects in this export list are dependent on.
getRequisites() - Method in interface com.ibm.pim.utils.ImportList
Fetches the names of objects that the objects in this export list are dependent on.
getRequisiteTypes() - Method in interface com.ibm.pim.utils.ExportRequisiteList
Fetches all the requisite types for objects in the ExportList corresponding to this requisite list.
getRequisiteTypes(ExportList.Type, Object) - Method in interface com.ibm.pim.utils.ExportRequisiteList
Fetches the types of requisite objects for the given object.
getRequisiteTypes() - Method in interface com.ibm.pim.utils.ImportRequisiteList
Fetches all the requisite types for objects in the ImportList corresponding to this requisite list.
getRequisiteTypesForHierarchyMap(String, String) - Method in interface com.ibm.pim.utils.ImportRequisiteList
Fetches the types of requisite objects for the given HierarchyMap.
getRequisiteTypesForObject(ExportList.Type, String) - Method in interface com.ibm.pim.utils.ImportRequisiteList
Fetches the types of requisite objects for the given object.
getReRunPerOccurrence() - Method in interface com.ibm.pim.extensionpoints.CategoryStringEnumerationValueRuleFunctionArguments.CategoryReRunPerOccurrenceControl
Obtain the state of the 'run_rule_per_occurrence' flag
getReRunPerOccurrence() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryStringEnumerationValueRuleFunctionArguments.CollaborationCategoryReRunPerOccurrenceControl
Obtain the state of the 'run_rule_per_occurrence' flag
getReRunPerOccurrence() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemStringEnumerationValueRuleFunctionArguments.CollaborationItemReRunPerOccurrenceControl
Obtain the state of the 'run_rule_per_occurrence' flag
getReRunPerOccurrence() - Method in interface com.ibm.pim.extensionpoints.ItemStringEnumerationValueRuleFunctionArguments.ItemReRunPerOccurrenceControl
Obtain the state of the 'run_rule_per_occurrence' flag
getReRunPerOccurrenceControl() - Method in interface com.ibm.pim.extensionpoints.CategoryStringEnumerationValueRuleFunctionArguments
Obtain a control through which the re-run-per-occurence flag can be manipulated for this rule.
getReRunPerOccurrenceControl() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryStringEnumerationValueRuleFunctionArguments
Obtain a control through which the re-run-per-occurence flag can be manipulated for this rule.
getReRunPerOccurrenceControl() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemStringEnumerationValueRuleFunctionArguments
Obtain a control through which the re-run-per-occurence flag can be manipulated for this rule.
getReRunPerOccurrenceControl() - Method in interface com.ibm.pim.extensionpoints.ItemStringEnumerationValueRuleFunctionArguments
Obtain a control through which the re-run-per-occurence flag can be manipulated for this rule.
getReservedObjects() - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns all collaboration objects in this collaboration step that are reserved.
getReservedObjects(Performer) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns all collaboration objects in this collaboration step that are reserved by the specified performer
getReservedObjectsForCurrentUser() - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns all collaboration objects in this collaboration step that are reserved by the current user.
getResponse() - Method in interface com.ibm.pim.extensionpoints.CustomToolsFunctionArguments
Obtains HTTP response being processed for this CustomToolsFunction.
getResponse() - Method in interface com.ibm.pim.extensionpoints.TriggerFunctionArguments
Obtains HTTP response being processed for this TriggerFunction.
getResponseDocument() - Method in interface com.ibm.pim.webservice.WebServiceTransaction
Returns Document which represents the outbound message.
getReturnValue() - Method in interface com.ibm.pim.job.ScheduleStatus
Gets the return value being set to the status.
getRichSearchURL(Hierarchy) - Method in interface com.ibm.pim.system.UIHelper
Returns a String object representing the URL which can be used to render the Hierarchy Rich Search screen on the hierarchy.
getRichSearchURL(OrganizationHierarchy) - Method in interface com.ibm.pim.system.UIHelper
Returns a String object representing the URL which can be used to render the Hierarchy Rich Search screen on the organization hierarchy.
getRichSearchURL(Catalog) - Method in interface com.ibm.pim.system.UIHelper
Returns a String object representing the URL which can be used to render the Item Rich Search screen on the catalog.
getRichSearchURL(LookupTable) - Method in interface com.ibm.pim.system.UIHelper
Returns a String object representing the URL which can be used to render the Rich Search screen on the lookup table.
getRichSearchURL(CollaborationStep) - Method in interface com.ibm.pim.system.UIHelper
Returns a String object representing the URL which can be used to render the Rich Search screen on the collaboration step.
getRole(String) - Method in interface com.ibm.pim.organization.OrganizationManager
Retrieves a role based upon a name
getRoles() - Method in interface com.ibm.pim.organization.AccessControlGroup
Retrieve the roles associated with this AccessControlGroup
getRoles() - Method in interface com.ibm.pim.organization.Company
Returns all roles associated with the company
getRoles() - Method in interface com.ibm.pim.organization.User
Retrieves the Role objects this User is registered to
getRootAttributeDefinition() - Method in interface com.ibm.pim.spec.Spec
Returns the root attribute definition for the Spec.
The root attribute definition is a virtual root of the tree of attribute definitions belonging to the spec.
getRootAttributeInstance(Spec) - Method in interface com.ibm.pim.attribute.AttributeOwner
Return the root attribute instance for the spec.
getRootAttributeInstances() - Method in interface com.ibm.pim.attribute.AttributeOwner
Return all the root attribute instances for all specs, including primary spec, secondary spec, etc.
getRootCategory() - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Returns the root collaboration category for this Category Collaboration Area
getRootCategory() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Returns the root category for this Hierarchy
getRootDirectory() - Method in interface com.ibm.pim.docstore.DocstoreManager
Fetches the root directory of the docstore.
getRootLocationAttributeInstance(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Retrieve the root attribute instance at the specified location.
getRootOrganization() - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Returns the root organization for this Hierarchy
getRoutingManager() - Method in interface com.ibm.pim.context.Context
Gets the Routing manager for this context
getRunIndex() - Method in interface com.ibm.pim.job.ScheduleStatus
Gets the index for the run of schedule.
getSaveEvent() - Method in interface com.ibm.pim.extensionpoints.PostCategorySaveFunctionArguments
Obtains the save event for this invocation.
getSaveEvent() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationCategorySaveFunctionArguments
Obtains the save event for this invocation.
getSaveEvent() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationItemSaveFunctionArguments
Obtains the save event for this invocation.
getSaveEvent() - Method in interface com.ibm.pim.extensionpoints.PostItemSaveFunctionArguments
Obtains the save event for this invocation.
getSaveResult() - Method in interface com.ibm.pim.catalog.item.Item
Returns an enumeration of the net effect of the last save on this item.
getSaveResult() - Method in interface com.ibm.pim.collaboration.CollaborationItem
Returns an enumeration of the net effect of the last save on this item UNKNOWN, ADDED, MODIFIED, DELETED
getSaveResult() - Method in interface com.ibm.pim.hierarchy.category.Category
Returns an enumeration of the net effect of the last save on this category.
getSchedules() - Method in interface com.ibm.pim.job.Job
Gets all the schedules for the given job.
getScreenPrivileges() - Method in interface com.ibm.pim.organization.Role
Fetches the set of screen privileges granted to this user.
getScreenType() - Method in interface com.ibm.pim.view.ScreenView
get the type of screen to which this screen view corresponds
getScreenView() - Method in interface com.ibm.pim.view.ScreenViewFilter
Get the ScreenView to which this filter belongs
getScreenView(ScreenType) - Method in interface com.ibm.pim.view.View
retrieve the ScreenView for the specified ScreenType.
getScript() - Method in interface com.ibm.pim.job.UserJob
Fetches the script used with this user job
getScriptInputSpec() - Method in interface com.ibm.pim.job.Report
Fetches the input spec for this report.
getScriptStats() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains the script stats being processed for this CatalogExportFunction.
getScriptStats() - Method in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunctionArguments
Obtains the script stats being processed for this CatalogToCatalogExportFunction.
getScriptStats() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains the script stats being processed for this ImportExportFunction.
getSearchQuery() - Method in interface com.ibm.pim.search.SearchResultSet
Returns the Query object which returned this SearchResultSet.
getSecondaryHierarchies() - Method in interface com.ibm.pim.catalog.Catalog
Retrieve all secondary Hierarchies associated with this Catalog.
getSecondaryOrganizationHierarchies() - Method in interface com.ibm.pim.catalog.Catalog
Retrieve all organization Hierarchies associated as secondary hierarchies with this Catalog.
getSecondarySpecs() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Returns the secondary specs defining this category’s attributes.
getSecondarySpecs() - Method in interface com.ibm.pim.hierarchy.category.Category
Returns the secondary specs defining this category’s attributes.
getSecondVersionInfo() - Method in interface com.ibm.pim.job.Export
Returns the second version of the catalog used for this diff export.
getSelection(String) - Method in interface com.ibm.pim.selection.SelectionManager
Fetches the selection with the given selectionName
getSelectionManager() - Method in interface com.ibm.pim.context.Context
Gets the SelectionManager for this context
getSelections(Catalog) - Method in interface com.ibm.pim.selection.SelectionManager
Fetches all Selection objects defined for this catalog, for which the user has the permission Permission.SELECTION_LIST.
getSelections() - Method in interface com.ibm.pim.selection.SelectionManager
Fetches all Selection objects in this company, for which the user has the permission Permission.SELECTION_LIST.
getSemantics() - Method in interface com.ibm.pim.job.ItemImport
Returns the semantics for this import
getSingleEditURL(Item) - Method in interface com.ibm.pim.system.UIHelper
Returns a String object representing the URL which can be used to render the item on the Single Edit screen.
getSingleEditURL(Category) - Method in interface com.ibm.pim.system.UIHelper
Returns a String object representing the URL which can be used to render the category on the Single Edit screen.
getSource() - Method in interface com.ibm.pim.common.ValidationErrors
Returns the source object that this set of validation errors correspond to.
getSourceAttributeDefinition() - Method in interface com.ibm.pim.spec.SpecMapEntry
Return the source AttributeDefinition in the spec map entry
getSourceCatalog() - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Get the source catalog upon which this collaboration area is based.
getSourceCatalog() - Method in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunctionArguments
Obtains the source catalog being processed for this CatalogToCatalogExportFunction.
getSourceCatalog() - Method in interface com.ibm.pim.job.Export
Returns the source catalog for an item export
getSourceCategories() - Method in interface com.ibm.pim.hierarchy.HierarchyMap
Returns a collection of source categories in the hierarchy map.
getSourceCategory() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
 
getSourceFileName() - Method in interface com.ibm.pim.job.Import
Returns the data source file name
getSourceHierarchy() - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Gets the source hierarchy upon which this collaboration area is based
getSourceHierarchy() - Method in interface com.ibm.pim.hierarchy.HierarchyMap
Returns the source hierarchy.
getSourceItem() - Method in interface com.ibm.pim.collaboration.CollaborationItem
Get the item in the source catalog corresponding to this checked out item.
getSourceObjectName() - Method in interface com.ibm.pim.spec.SpecMap
Returns the name of the source object in the specMap
getSpec() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Return the Spec to which this AttributeDefinition is associated.
getSpec() - Method in interface com.ibm.pim.catalog.Catalog
Retrieve the Primary Spec of the Items within this Catalog.
getSpec() - Method in interface com.ibm.pim.catalog.LocationDataConfiguration
Retrieves the Spec for this particular Configuration
getSpec() - Method in interface com.ibm.pim.lookuptable.LookupTable
Retrieve the Lookup Spec associated with this LookupTable
getSpec(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as MDMPIM Spec object.
getSpec(String) - Method in interface com.ibm.pim.spec.SpecManager
Retrieves a specific Spec by name, returns null if Spec with the given name doesn't exist.
getSpecManager() - Method in interface com.ibm.pim.context.Context
Gets the SpecManager for this context
getSpecMap() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains the SpecMap for this invocation.
getSpecMap() - Method in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunctionArguments
Obtains the SpecMap for this invocation.
getSpecMap() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains the SpecMap for this invocation.
getSpecMap() - Method in interface com.ibm.pim.job.Export
Fetches the SpecMap associated to this export, if this is an item export, null otherwise.
getSpecMap() - Method in interface com.ibm.pim.job.ItemImport
Fetches the SpecMap associated to this import
getSpecMap(String) - Method in interface com.ibm.pim.spec.SpecManager
Retrieves a specific SpecMap by name, returns null if SpecMap with the given name doesn't exist
getSpecMaps() - Method in interface com.ibm.pim.spec.SpecManager
Retrieves all SpecMaps available in the current context.
getSpecName(String) - Method in interface com.ibm.pim.attribute.AttributePathHelper
Extract the spec name from a path
getSpecs() - Method in interface com.ibm.pim.attribute.AttributeCollection
Get all of the specs associated with this attribute collection as dynamic sources of attributes.
getSpecs() - Method in interface com.ibm.pim.attribute.AttributeOwner
Returns all the specs in which this item participates.
getSpecs() - Method in interface com.ibm.pim.spec.SpecManager
Retrieves all Specs available in the current context.
getSpecs(Spec.Type) - Method in interface com.ibm.pim.spec.SpecManager
Retrieves all Specs available of the specified type in the current context.
getStartTime() - Method in interface com.ibm.pim.job.Schedule
Gets the start time info of a job schedule.
getStartTime() - Method in interface com.ibm.pim.job.ScheduleStatus
Gets the time at which the schedule enters this status.
getStartVersion() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains the start version for this export.
getStatusForItem(Item) - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments.CatalogExportDiffStatus
Obtains the 'diff status' for an item.
getStep(String) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the step with a specified step name on the current collaboration area.
getStep(String) - Method in interface com.ibm.pim.workflow.Workflow
Retrieve a workflow step from this workflow by name
getSteps(Performer) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Returns the list of steps upon which the specified performer is a member of the performers list
getSteps() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the list of all steps in the current collaboration area.
getSteps(WorkflowStep.Type) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the list of steps of a given step type on the current collaboration area.
getSteps() - Method in interface com.ibm.pim.collaboration.CollaborationObject
Get all the collaboration steps holding this object.
getSteps() - Method in interface com.ibm.pim.workflow.Workflow
Get all the steps in this workflow.
getStepScript() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the currently set step script path for this Workflow Step.
getString(int) - Method in interface com.ibm.pim.search.SearchResultSet
Get the value of a column in the current row as Java String value.
getStyle() - Method in interface com.ibm.pim.webservice.WebService
Returns the style for the web service.
getSubDirectories() - Method in interface com.ibm.pim.docstore.Directory
Fetches a collection of directories which are present immediately under this directory
getSuccessStep() - Method in interface com.ibm.pim.workflow.Workflow
Get the Success Step of this workflow.
getSystemWideAccessPrivileges() - Method in interface com.ibm.pim.organization.Role
Fetches the set of system wide access privileges granted to this user.
getTargetCategory() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLogEntry
Fetches the category to which this UserDefinedLogEntry is associated.
getTargetItem() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLogEntry
Fetches the item to which this UserDefinedLogEntry is associated.
getTimeout(CollaborationObject) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns the moment in time at which the specified collaboration object will timeout for this step.
getTimeoutDate() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the timeout date for the current collaboration area.
getTimeoutDate() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the timeout for this step.
getTimeoutDuration() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the timeout duration for the current collaboration area.
getTimeoutDuration() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the timeout duration.
getTimeoutNotificationAddresses() - Method in interface com.ibm.pim.workflow.WorkflowStep
Fetch a list of email addresses that will be notified as a result of timeout from this step
getTimezoneResolver() - Method in interface com.ibm.pim.context.Context
Gets a utility for processing timezone related information.
getTimezoneStringFromEncodedForm(String) - Method in interface com.ibm.pim.utils.TimezoneResolver
Accepts an encoded timezone, as retrievable via getAttribute, and returns a textual representation of it
getTimezoneStrings() - Method in interface com.ibm.pim.utils.TimezoneResolver
Retrieve an array of textual representations of every timezone
getTitle() - Method in interface com.ibm.pim.organization.User
Retrieves the User's title
getTransactions(Date, Date) - Method in interface com.ibm.pim.webservice.WebService
Returns all the transactions associated with the webservice for the specified date range.
getTransitionConfiguration() - Method in interface com.ibm.pim.extensionpoints.WorkflowStepFunctionArguments
Obtain the mapping of entries to exit values for this invocation.
getType() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Returns the type of this AttributeDefinition.
getType() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the object type of the current collaboration area.
getType() - Method in interface com.ibm.pim.collaboration.CollaborationHistoryEvent
Get the type of the collaboration history event.
getType() - Method in interface com.ibm.pim.collaboration.CollaborationObject
Get the type of this collaboration object.
getType() - Method in interface com.ibm.pim.common.ValidationError
Get the type of the validation error
getType() - Method in interface com.ibm.pim.job.Executable
Gets job executable type.
getType() - Method in interface com.ibm.pim.job.Export
Fetches the type of the export
getType() - Method in interface com.ibm.pim.job.Schedule
Gets schedule type.
getType() - Method in interface com.ibm.pim.job.ScheduleStatus
Gets the status type.
getType() - Method in interface com.ibm.pim.selection.Selection
Fetches the type of this selection
getType() - Method in interface com.ibm.pim.spec.Spec
Get the spec type
getType() - Method in interface com.ibm.pim.spec.SpecMap
Returns the type of the specMap
getType() - Method in interface com.ibm.pim.utils.DataSource
Retrieves the datasource type
getType() - Method in interface com.ibm.pim.utils.Distribution
Retrieves the distribution type
getType() - Method in interface com.ibm.pim.view.View
Return the type of this view
getType() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the type of this Workflow Step
getUIHelper() - Method in interface com.ibm.pim.context.Context
Returns object of UIHelper
getUnassignedItems(Hierarchy) - Method in interface com.ibm.pim.catalog.Catalog
Returns a collection of items from this catalog belonging to a specific hierarchy which are unassigned to a category
getURL() - Method in interface com.ibm.pim.docstore.Document
Fetches the absolute path for the document.
getURL(DataEntryFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.DataEntryFunction
This method will be invoked by WPC.
getURL() - Method in interface com.ibm.pim.webservice.WebService
Returns the URL for the webservice.
getUser() - Method in interface com.ibm.pim.collaboration.CollaborationHistoryEvent
Get the user who initiated the collaboration event.
getUser() - Method in interface com.ibm.pim.docstore.DocumentAuditLog
Fetches the user who accessed the document
getUser(String) - Method in interface com.ibm.pim.organization.OrganizationManager
Returns a specific User based upon name.
getUserDefinedAttributeCollection() - Method in interface com.ibm.pim.catalog.Catalog
Retrieves the User Defined Core Attribute Collection for this Catalog
getUserDefinedAttributeCollection() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Retrieves the User Defined Core Attribute Collection for this collaboration area
getUserDefinedAttributeCollection() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves the User Defined Core Attribute Collection for this hierarchy
getUserDefinedAttributeCollection() - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Retrieves the User Defined Core Attribute Collection for this hierarchy
getUserDefinedLog(String) - Method in interface com.ibm.pim.catalog.Catalog
Retrieves a specific ItemUserDefinedLog associated with this catalog with a specified name
getUserDefinedLog(String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves a specific CategoryUserDefinedLog associated with this hierarchy with the specified name
getUserDefinedLogs() - Method in interface com.ibm.pim.catalog.Catalog
Retrieves all ItemUserDefinedLog available in the current context for this Catalog
getUserDefinedLogs() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieves all CategoryUserDefinedLogs available in the current context for this Hierarchy
getUserName() - Method in interface com.ibm.pim.organization.User
Retrieves the User's name
getUsers() - Method in interface com.ibm.pim.organization.Company
Returns all users in the context of this company
getUsers() - Method in interface com.ibm.pim.organization.Organization
Returns a collection of users belonging to this Organization
getUsers() - Method in interface com.ibm.pim.organization.Role
Identifies the Users applied to the Role
getUserSettingValue(UserSetting) - Method in interface com.ibm.pim.organization.User
Fetches the value of a user setting as a String
getUserWhoReserved(CollaborationObject) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns the user to whom the specified collaboration object is reserved.
getValidationErrors() - Method in interface com.ibm.pim.extensionpoints.CategoryPrePostProcessingFunctionArguments
Obtains the validation errors for this category.
getValidationErrors() - Method in interface com.ibm.pim.extensionpoints.CategoryRunValueRuleFunctionArguments
Obtains the validation errors for this category.
getValidationErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPrePostProcessingFunctionArguments
Obtains the validation errors for this category.
getValidationErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryRunValueRuleFunctionArguments
Obtains the validation errors for this category.
getValidationErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPrePostProcessingFunctionArguments
Obtains the validation errors for this item.
getValidationErrors() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemRunValueRuleFunctionArguments
Obtains the validation errors for this item.
getValidationErrors() - Method in interface com.ibm.pim.extensionpoints.ItemPrePostProcessingFunctionArguments
Obtains the validation errors for this item.
getValidationErrors() - Method in interface com.ibm.pim.extensionpoints.ItemRunValueRuleFunctionArguments
Obtains the validation errors for this item.
getValue() - Method in interface com.ibm.pim.attribute.AttributeDefinitionProperty
Returns the String value of this AttributeDefinition property.
getValue() - Method in interface com.ibm.pim.attribute.AttributeInstance
Get the current value of this attribute instance
getValue() - Method in interface com.ibm.pim.attribute.InheritedValue
Used to get the value that is being inherited
getValue() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLogEntry
Returns the string description stored in this log entry
getValues() - Method in interface com.ibm.pim.attribute.AttributeDefinitionProperty
Returns a java.util.Collection containing the String values of this AttributeDefinition property.
getValues() - Method in interface com.ibm.pim.lookuptable.LookupTableEntry
Returns all the item values in this LookupTableEntry
getVersionDate() - Method in interface com.ibm.pim.common.VersionInfo
Retrieve the version creation date
getVersionInfo() - Method in interface com.ibm.pim.catalog.Catalog
Retrieves version information for this Catalog
getVersionInfo(String) - Method in interface com.ibm.pim.catalog.CatalogManager
Retrieves all Version Information for a catalog
getVersionInfo(String, String) - Method in interface com.ibm.pim.catalog.CatalogManager
Retrieves Version Information for a particular version of a catalog
getVersionInfo(String, String) - Method in interface com.ibm.pim.hierarchy.HierarchyManager
Retrieves the list of Version Information objects for the given hierarchy with the given version name.
getVersionInfo(String) - Method in interface com.ibm.pim.hierarchy.HierarchyManager
Retrieves all Version Information for a hierarchy
getVersionInfo() - Method in interface com.ibm.pim.job.Export
Returns the version of the catalog used for export
getVersionInfo() - Method in interface com.ibm.pim.lookuptable.LookupTable
Retrieves version information for this LookupTable
getVersionInfo(String) - Method in interface com.ibm.pim.lookuptable.LookupTableManager
Retrieves all Version Information for a LookupTable
getVersionInfo(String, String) - Method in interface com.ibm.pim.lookuptable.LookupTableManager
Retrieves Version Information for a particular version of a LookupTable
getVersionName() - Method in interface com.ibm.pim.common.VersionInfo
Retrieve the name associated with a version
getVersionType() - Method in interface com.ibm.pim.common.VersionInfo
Retrieve the type of version
getView(String) - Method in interface com.ibm.pim.catalog.Catalog
retrieve a View on this catalog by name
getView(String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
retrieve a View on this hierarchy by name
getView() - Method in interface com.ibm.pim.view.ScreenView
Get the View to which this ScreenView belongs
getViewableAttributeCollections() - Method in interface com.ibm.pim.view.ScreenView
Get the viewable attribute collections for this screen view
getViewableAttributeCollections() - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the viewable attribute collections for this step.
getViewableAttributeCollections(ScreenType) - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the viewable attribute collections for a given screen type on this step.
getViewableAttributeCollections(Hierarchy) - Method in interface com.ibm.pim.workflow.WorkflowStep
Get the viewable attribute collections on the specified location hierarchy for this step.
getViewableAttributes() - Method in interface com.ibm.pim.view.ScreenView
Get all viewable attributes from the union of all viewable attribute collections on this screen view at the present time.
getViewName() - Method in interface com.ibm.pim.extensionpoints.CategoryPreviewFunctionArguments
Obtains the view name being processed for this Entry Preview Function.
getViewName() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPreviewFunctionArguments
Obtains the view name being processed for this Entry Preview Function.
getViewName() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPreviewFunctionArguments
Obtains the view name being processed for this Entry Preview Function.
getViewName() - Method in interface com.ibm.pim.extensionpoints.ItemPreviewFunctionArguments
Obtains the view name being processed for this Entry Preview Function.
getViewName() - Method in interface com.ibm.pim.extensionpoints.RichSearchReportFunctionArguments
Obtains the view name for this invocation.
getViews() - Method in interface com.ibm.pim.catalog.Catalog
Retrieve all Views on this catalog.
getViews() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Retrieve all Views on this hierarchy.
getWarningCount() - Method in interface com.ibm.pim.system.ScriptStatistics
Returns the number of warnings during the script execution.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CatalogExportFunctionArguments
Obtains access to the writer for warning output created by this CatalogExportFunction.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CatalogPreviewFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CatalogToCatalogExportFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CategoryDefaultValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CategoryMacroFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CategoryNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CategoryPrePostProcessingFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CategoryPreviewFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CategoryRunValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CategoryStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CategoryValidationRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryDefaultValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryMacroFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPrePostProcessingFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryPreviewFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryRunValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryValidationRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemDefaultValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemMacroFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPrePostProcessingFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemPreviewFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemRunValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CollaborationItemValidationRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.CustomToolsFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.DistributionFunctionArguments
Obtains access to the writer for warning output created by this DistributionFunction.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.EntryBuildFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains access to the writer for warning output created by this ImportFunction.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.ItemDefaultValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.ItemMacroFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.ItemNonPersistedAttributeRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.ItemPrePostProcessingFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.ItemPreviewFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.ItemRunValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.ItemStringEnumerationValueRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.ItemValidationRuleFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.PostCategorySaveFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationCategorySaveFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.PostCollaborationItemSaveFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.PostItemSaveFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWarnings() - Method in interface com.ibm.pim.extensionpoints.ScriptingSandboxFunctionArguments
Obtains access to the writer for warning output created by this invocation.
getWebService(String) - Method in interface com.ibm.pim.webservice.WebServiceManager
Returns the web service with the given name.
getWebServiceManager() - Method in interface com.ibm.pim.context.Context
Gets the WebServiceManager for this context
getWebServices() - Method in interface com.ibm.pim.webservice.WebServiceManager
Retrieves all web services available in the current context
getWorkflow() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Gets the workflow associated with the current collaboration area.
getWorkflow() - Method in interface com.ibm.pim.workflow.NestedWorkflowStep
Get the nested workflow from this step.
getWorkflow(String) - Method in interface com.ibm.pim.workflow.WorkflowManager
Retrieve a workflow by name
getWorkflowManager() - Method in interface com.ibm.pim.context.Context
Gets the WorkflowManager for this context
getWorkflows() - Method in interface com.ibm.pim.workflow.WorkflowManager
Retrieve all Workflows available in the current context (ie those Workflows which the current user/role is allowed to administrate).
getWorkflowStep() - Method in interface com.ibm.pim.collaboration.CollaborationStep
Returns the workflow step for this collaboration step.
getWorkflowStep() - Method in interface com.ibm.pim.workflow.ExitValue
get the WorkflowStep to which this exit value belongs
getWorkflowStepPath() - Method in interface com.ibm.pim.extensionpoints.ImportFunctionArguments
Obtains the workflow step path being processed for this ImportFunction.
getWorkflowStepsXMLByAttributeValue(AttributeDefinition, Object) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Returns xml representation of workflow steps accessible by the user.
getWorkflowStepsXMLByAttributeValue(AttributeDefinition, Object, Role) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Returns xml representation of workflow steps accessible by the given role.
getWriter() - Method in interface com.ibm.pim.system.PIMWriter
Returns an instance of java.io.Writer.
getWsddDocument() - Method in interface com.ibm.pim.webservice.WebService
Returns document object which represents the WSDD for the web service.
getWsdlDocument() - Method in interface com.ibm.pim.webservice.WebService
Returns document object which represents the WSDL for the web service.
getWsdlURL() - Method in interface com.ibm.pim.webservice.WebService
Returns the WSDL URL for the web service.
getXMLRepresentation(Spec, boolean, boolean, Collection<Locale>, Collection<AttributeCollection>) - Method in interface com.ibm.pim.catalog.item.Item
Returns the XML Representation for the particular item.
getXMLRepresentation(Spec, boolean, boolean, Collection<Locale>, Collection<AttributeCollection>, String) - Method in interface com.ibm.pim.catalog.item.Item
Returns the XML Representation for the particular item.
grantPermissions(Role, Set<Permission>) - Method in interface com.ibm.pim.organization.AccessControlGroup
Grants the given set of permissions to this role.
grantPermissions(AccessControlGroup, Set<Permission>) - Method in interface com.ibm.pim.organization.Role
Grants the given set of permissions to this role as part of the given access control group.
grantScreenPrivileges(Set<ScreenPrivilege>) - Method in interface com.ibm.pim.organization.Role
Grants the given screen privileges
grantSystemWideAccessPrivileges(Set<SystemWideAccessPrivilege>) - Method in interface com.ibm.pim.organization.Role
Grants the given system wide access privileges

H

hasChildren() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Determines if the given category has any children.
hasChildren() - Method in interface com.ibm.pim.hierarchy.category.Category
Determines if the given category has any children.
hasChildren() - Method in interface com.ibm.pim.organization.Organization
Determines if the given organization has any children.
hasExitValue(String) - Method in interface com.ibm.pim.workflow.WorkflowStep
Check if this Workflow Step has an exit value identified by the String passed in.
hasExitValue(ExitValue) - Method in interface com.ibm.pim.workflow.WorkflowStep
Check if this Workflow Step has an exit value identified by the ExitValue object passed in.
hashCode() - Method in interface com.ibm.pim.collection.PIMCollection
A shallow hashcode method which only looks at the elements in this collection.
hasInheritedValue() - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
Identifies if this locationdata attribute has a non null inherited value.
hasNonInheritedValue() - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
Identifies if this locationdata attribute has a non null, non inherited value.
hasSubSpec() - Method in interface com.ibm.pim.spec.PrimarySpec
Returns true if this primary spec has a subspec
hasSubSpec() - Method in interface com.ibm.pim.spec.SecondarySpec
Returns true if this primary spec has a subspec
Hierarchy - Interface in com.ibm.pim.hierarchy
Interface for the Hierarchy object representing a Hierarchy of categories.
HierarchyManager - Interface in com.ibm.pim.hierarchy
Interface for the Manager of Hierarchy objects.
HierarchyMap - Interface in com.ibm.pim.hierarchy
Mapping can be established between categories belonging to two hierarchies.

I

IISIntegration - Interface in com.ibm.pim.utils
This interfaces defines methods for integration with IIS
Import - Interface in com.ibm.pim.job
Interface that represents Import jobs.
Import.OptionalArguments - Enum in com.ibm.pim.job
Set of optional arguments that can be passed while creating an import.
importEnvironment(Document) - Method in interface com.ibm.pim.utils.EnvironmentImporter
Imports a document in zip format into the company.
importEnvironment(String) - Method in interface com.ibm.pim.utils.EnvironmentImporter
Imports a zip file in the file system into the company.
ImportFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Import function
ImportFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to ImportFunction invocations.
ImportList - Interface in com.ibm.pim.utils
An interface representing an object that holds name, type and action mode of objects present in a zip file obtained from the environment export tool.
ImportRequisiteList - Interface in com.ibm.pim.utils
Interface representing an object that holds names of requisite objects for objects in an import list.
in(WorkflowStepFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.WorkflowStepFunction
Driven by WPC on entry to a step.
incrementDuplicateItemsFoundCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
increment the number of duplicate items found value by incrementValue.
incrementErrorCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
increment the number of errors value by incrementValue.
incrementErrorLineCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
increment the number of error lines value by incrementValue.
incrementFailedValidationCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
increment the number of failed validation value by incrementValue.
incrementItemCategoryMappingAddedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
increment the number of item category mapping added value by incrementValue.
incrementItemsAddedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
increment the number of items added value by incrementValue.
incrementItemsAlreadyCheckedOutCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Increment the number of items already checked out value by incrementValue.
incrementItemsCheckedOutCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Increment the number of items checked out value by incrementValue.
incrementItemsDeletedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
increment the number of items deleted value by incrementValue.
incrementItemsModifiedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
increment the number of items modified value by incrementValue.
incrementItemsNotFoundCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Increment the number of items not found value by incrementValue.
incrementItemsProcessedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
increment the number of items processed value by incrementValue.
incrementLinesProcessedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
increment the number of lines processed value by incrementValue.
incrementWarningCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
increment the number of warnings value by incrementValue.
InheritedValue - Interface in com.ibm.pim.attribute
This class exists so that one can call LocationAttributeInstance.getInheritedValue() and know both the value that is inherited as well as where it came from (what location).
interimCheckin(Collection<CollaborationCategory>, CollaborationStep) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Temporarily publishes the current attribute values for each category in the collection of categories in the collaboration area back to the source category tree.
interimCheckin(Collection<CollaborationCategory>, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Temporarily publishes the current attribute values for each category in the collection of categories in the collaboration area back to the source category tree.
interimCheckin(Collection<CollaborationItem>, CollaborationStep) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Temporarily publish the current attribute values for each item in the collection of items in the collaboration area back to the source catalog.
interimCheckin(Collection<CollaborationItem>, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Temporarily publish the current attribute values for each item in the collection of items in the collaboration area back to the source catalog, with a comment.
inTransaction() - Method in interface com.ibm.pim.context.Context
Return true if in a transaction, or false otherwise
isAuthenticationRequired() - Method in interface com.ibm.pim.webservice.WebService
Indicates whether this web service requires an authentication.
isAutomatedStep() - Method in interface com.ibm.pim.workflow.WorkflowStep
Identifies if this Workflow Step is an automated Step (i.e.
isAvailableInLocation(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Determines if the item is available in the given location.
isAvailableInLocation(Category, boolean) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Determines if the item is available in the given location or any of it's descendants.
isCategoryCheckedOut(String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Identifies if a category is checked out
isCategoryWorkflow() - Method in interface com.ibm.pim.workflow.Workflow
Check if this is a category workflow.
isCheckedOut() - Method in interface com.ibm.pim.catalog.item.Item
Determines if the item is checked out to a collaboration area.
isCheckedOut() - Method in interface com.ibm.pim.hierarchy.category.Category
Identifies if this category is checked to one or more collaboration areas
isComparable(AttributeOwner) - Method in interface com.ibm.pim.attribute.AttributeOwner
Check if this attribute owner is comparable with the given owner.
isDeployed() - Method in interface com.ibm.pim.webservice.WebService
Indicates whether this web service is deployed.
isEmpty() - Method in interface com.ibm.pim.collection.PIMCollection
Test whether this collection is empty.
isEnabled() - Method in interface com.ibm.pim.organization.User
Identifies if the user is enabled(active) or not
isFailureStep() - Method in interface com.ibm.pim.workflow.WorkflowStep
Identifies if this Workflow Step is the Workflow's Failure Step.
isFixitStep() - Method in interface com.ibm.pim.workflow.WorkflowStep
Check if the WorkflowStep is a reference to Fixit
isGenerated() - Method in interface com.ibm.pim.attribute.AttributeCollection
Identifies whether this is a generated attribute collection
isGrouping() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Determine whether this is a Grouping AttributeDefinition
isGrouping() - Method in interface com.ibm.pim.attribute.AttributeInstance
AttributeInstance representing a directory, which is either a "grouping" or the root node for a spec.
isImportAllowed() - Method in interface com.ibm.pim.workflow.WorkflowStep
Check if Allow Import into Step is enabled for this step
isInheriting() - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
Identifies if this locationdata attribute inherits
isInitialStep() - Method in interface com.ibm.pim.workflow.WorkflowStep
Check if this Workflow Step is the Workflow's Initial Step.
isInUse() - Method in interface com.ibm.pim.workflow.Workflow
Report if the workflow is being used by any collaboration areas which are non-empty (if this is true, the workflow cannot be edited).
isItemCheckedOut(String) - Method in interface com.ibm.pim.catalog.Catalog
Identifies if an item is checked out
isItemQuery() - Method in interface com.ibm.pim.search.SearchQuery
Returns true if query is on a PIM Item.
isItemWorkflow() - Method in interface com.ibm.pim.workflow.Workflow
Check if this is an item workflow.
isJavaBased() - Method in interface com.ibm.pim.webservice.WebService
Returns true if a webservice definition within MDMPIM is java based.
isLdapEnabled() - Method in interface com.ibm.pim.organization.User
Identifies if the user is an LDAP registered user or not
isLeaf() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Determine whether this is a leaf AttributeDefinition
isLocalized() - Method in interface com.ibm.pim.spec.Spec
Identify whether this Spec is localized
isLocked() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Checks of the current collaboration area is locked.
isMultiOccurrence() - Method in interface com.ibm.pim.attribute.AttributeInstance
AttributeInstance containing N child occurrences of the same AttributeDefinition.
isNestedWorkflowStep() - Method in interface com.ibm.pim.workflow.WorkflowStep
Identifies if this Workflow Step is a Nested Workflow Step.
isOrdered() - Method in interface com.ibm.pim.catalog.Catalog
Identifies if an item within a catalog is ordered or not
isPrimaryKey() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Determine whether this is a Primary Key attribute
isRecategorizeEnabled() - Method in interface com.ibm.pim.workflow.WorkflowStep
Check if Allow Recategorization is enabled for this step
isRequestStored() - Method in interface com.ibm.pim.webservice.WebService
Indicates whether incoming messages for this web service are stored.
isReserved() - Method in interface com.ibm.pim.collaboration.CollaborationObject
Test whether this collaboration object is reserved (in any collaboration step).
isReserved(CollaborationStep) - Method in interface com.ibm.pim.collaboration.CollaborationObject
Test whether this collaboration object is reserved in a given collaboration step.
isReserveToEditEnabled() - Method in interface com.ibm.pim.workflow.WorkflowStep
Check if reserve to edit is enabled for this step
isResponseStored() - Method in interface com.ibm.pim.webservice.WebService
Indicates whether outgoing messages for this web service are stored.
isRoot() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Identifies whether this Category is the root Category of the Hierarchy it lives within
isRoot() - Method in interface com.ibm.pim.hierarchy.category.Category
Identifies whether this Category is the root Category of the Hierarchy it lives within
isRoot() - Method in interface com.ibm.pim.organization.Organization
Identifies whether this Organization is the root Organization of the OrganizationHierarchy it lives within
isRunningLog() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLog
Determine whether this log is currently running
isSingleValued() - Method in interface com.ibm.pim.attribute.AttributeDefinitionProperty
Determine whether the AttributeDefinitionProperty has single or multiple values.
isSkipRequestValidation() - Method in interface com.ibm.pim.webservice.WebService
Indicates whether the inbound message requires validation against WSDL schema.
isSkipResponseValidation() - Method in interface com.ibm.pim.webservice.WebService
Indicates whether the outbound message requires validation against WSDL schema.
isSpecRoot() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Is this attribute a spec root attribute?
isSubSpecAttribute() - Method in interface com.ibm.pim.attribute.AttributeDefinition
Determine whether this attribute is part of a SubSpec rather than a top level Spec
isSuccessStep() - Method in interface com.ibm.pim.workflow.WorkflowStep
Identifies if this Workflow Step is the Workflow's Success Step.
isValidPath(String) - Method in interface com.ibm.pim.attribute.AttributePathHelper
Determine whether the specified path is valid.
isValue() - Method in interface com.ibm.pim.attribute.AttributeInstance
AttributeInstance representing a leaf value.
Item - Interface in com.ibm.pim.catalog.item
Represents the Item object in the system.
Item.SaveResult - Enum in com.ibm.pim.catalog.item
Describes the Item Status after a Save operation
ItemCollaborationArea - Interface in com.ibm.pim.collaboration
The Java API interface ItemCollaborationArea lets you access an item collaboration area.
ItemDefaultValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
itemDeleted() - Method in interface com.ibm.pim.common.BatchStatistics
Returns the number of items that got deleted
ItemImport - Interface in com.ibm.pim.job
Interface for Item import type
ItemImport.ImportSemantics - Enum in com.ibm.pim.job
 
ItemMacroFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to EntryMacroFunction invocations.
ItemNonPersistedAttributeRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
ItemPrePostProcessingFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to PrePostProcessingFunction invocations.
ItemPreviewFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
ItemRunValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
itemsAdded() - Method in interface com.ibm.pim.common.BatchStatistics
Returns the number of items that got added
itemsAlreadyCheckedOut() - Method in interface com.ibm.pim.common.BatchStatistics
Returns the number of items that were already checked out
itemsCheckedOut() - Method in interface com.ibm.pim.common.BatchStatistics
Returns the number of items that were checked out
itemsModified() - Method in interface com.ibm.pim.common.BatchStatistics
Returns the number of items that got modified
itemsNotFound() - Method in interface com.ibm.pim.common.BatchStatistics
Returns the number of items that were not found
itemsProcessed() - Method in interface com.ibm.pim.common.BatchStatistics
Returns the number of items that got processed
ItemStringEnumerationValueRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
ItemStringEnumerationValueRuleFunctionArguments.ItemReRunPerOccurrenceControl - Interface in com.ibm.pim.extensionpoints
Interface to allow the value rule to control the rerun per occurence flag available within the corresponding script type as the variable 'run_rule_per_occurrence'
ItemUserDefinedLog - Interface in com.ibm.pim.userdefinedlog
Interface representing a UserDefinedLog object that holds log entries for items.
ItemValidationRuleFunctionArguments - Interface in com.ibm.pim.extensionpoints
 
iterator() - Method in interface com.ibm.pim.collection.PIMCollection
Get an iterator over the elements in this Collection.

J

Job - Interface in com.ibm.pim.job
This interface defines methods for scheduler job.
JobManager - Interface in com.ibm.pim.job
Interface for JobManager

L

launch(HashMap<String, Object>) - Method in interface com.ibm.pim.system.PIMScript
Executes the script.
link(Catalog, AttributeDefinition, AttributeDefinition) - Method in interface com.ibm.pim.catalog.Catalog
Links a catalog to another using source and destination attributes.
LocationAttributeInstance - Interface in com.ibm.pim.attribute
This interface represents an instance of a location specific attribute on an item.
LocationDataConfiguration - Interface in com.ibm.pim.catalog
Describes the Location Configuration in the form of a Hierarchy and SecondarySpec.
lock() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Locks the collaboration area.
logDebug(Object, Throwable) - Method in interface com.ibm.pim.utils.Logger
Log a message object with the DEBUG level including the stack trace of the Throwable t passed as parameter
logDebug(Object) - Method in interface com.ibm.pim.utils.Logger
Log the message object with the DEBUG level.
logDebug(Throwable) - Method in interface com.ibm.pim.utils.Logger
Log the stack trace of the Throwable t passed as parameter with DEBUG level.
logError(Object, Throwable) - Method in interface com.ibm.pim.utils.Logger
Log a message object with the ERROR level including the stack trace of the Throwable t passed as parameter
logError(Throwable) - Method in interface com.ibm.pim.utils.Logger
Log the stack trace of the Throwable t passed as parameter with the ERROR level.
logError(Object) - Method in interface com.ibm.pim.utils.Logger
Log the message object with the ERROR level.
Logger - Interface in com.ibm.pim.utils
This class is used by JavaAPI users to log messages onto the PIM Solution logs.
logInfo(Object, Throwable) - Method in interface com.ibm.pim.utils.Logger
Log a message object with the INFO level including the stack trace of the Throwable t passed as parameter
logInfo(Object) - Method in interface com.ibm.pim.utils.Logger
Log the message object with the INFO level.
logInfo(Throwable) - Method in interface com.ibm.pim.utils.Logger
Log the stack trace of the Throwable t passed as parameter with INFO level.
logWarn(Object, Throwable) - Method in interface com.ibm.pim.utils.Logger
Log a message object with the WARN level including the stack trace of the Throwable t passed as parameter
logWarn(Throwable) - Method in interface com.ibm.pim.utils.Logger
Log the stack trace of the Throwable t passed as parameter with the WARN level.
logWarn(Object) - Method in interface com.ibm.pim.utils.Logger
Log the message object with the WARN level.
LookupSpec - Interface in com.ibm.pim.spec
Interface for the LookupSpec object
LookupTable - Interface in com.ibm.pim.lookuptable
Interface for LookupTable object
LookupTableEntry - Interface in com.ibm.pim.lookuptable
Interface for an entry within a LookupTable
LookupTableManager - Interface in com.ibm.pim.lookuptable
Interface for the Manager of LookupTable objects

M

makeAvailableInLocation(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Make this item available at the given location.
makeAvailableInLocationRecursively(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
Make this item available in given location and all its descendant locations.
makeUnavailableInLocation(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
This will make the item unavailable in the given location.
makeUnavailableInLocationRecursively(Category) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
This will make the item unavailable in the given location and all its descendant locations.
Manager - Interface in com.ibm.pim.common
Read-only interface providing the core operations available on any Manager object
mapToCategory(Category) - Method in interface com.ibm.pim.catalog.item.Item
Map an item to a category.
mapToCategory(Category) - Method in interface com.ibm.pim.collaboration.CollaborationItem
Map an item to a category.
mapToOrganization(Organization) - Method in interface com.ibm.pim.catalog.item.Item
Maps this item to the given Organization
mapToOrganization(Organization) - Method in interface com.ibm.pim.hierarchy.category.Category
Maps this category to the given Organization
moveCursor(int) - Method in interface com.ibm.pim.search.SearchResultSet
Move cursor to the row in the Resultset with index specified in the input parameter.
moveItemsToOtherCollaborationArea(Collection<CollaborationItem>, CollaborationArea) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Move the specified items to another collaboration area.
moveItemsToOtherCollaborationArea(Collection<CollaborationItem>, CollaborationArea, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Move the specified items to another collaboration area.
moveItemToOtherCollaborationArea(CollaborationItem, CollaborationArea) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Move the specified item to another collaboration area.
moveItemToOtherCollaborationArea(CollaborationItem, CollaborationArea, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Move the specified item to another collaboration area, with a comment.
moveTo(String) - Method in interface com.ibm.pim.docstore.Document
Moves this document to documentPath.
moveToCategories(Collection<Category>) - Method in interface com.ibm.pim.catalog.item.Item
Move item from existing categories to new set of categories.
moveToCategories(Collection<Category>) - Method in interface com.ibm.pim.collaboration.CollaborationItem
Move item from existing categories to new set of categories.
moveToCategoriesWithMapping(Collection<Category>) - Method in interface com.ibm.pim.catalog.item.Item
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
moveToCategoriesWithMapping(Collection<Category>) - Method in interface com.ibm.pim.collaboration.CollaborationItem
Move item from existing categories to new set of categories and add mappings.
moveToNextStep(Collection<CollaborationCategory>, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Moves the specified categories to next step.
moveToNextStep(Collection<CollaborationCategory>, CollaborationStep, String, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Moves the specified categories to next step.
moveToNextStep(CollaborationCategory, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Moves the specified category to next step.
moveToNextStep(CollaborationCategory, CollaborationStep, String, String) - Method in interface com.ibm.pim.collaboration.CategoryCollaborationArea
Moves the specified category to next step.
moveToNextStep(Collection<CollaborationItem>, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Move the specified items to next step.
moveToNextStep(Collection<CollaborationItem>, CollaborationStep, String, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Move the specified items to next step, with a comment.
moveToNextStep(CollaborationItem, CollaborationStep, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Move the specified item to next step.
moveToNextStep(CollaborationItem, CollaborationStep, String, String) - Method in interface com.ibm.pim.collaboration.ItemCollaborationArea
Move the specified item to next step.

N

NestedWorkflowStep - Interface in com.ibm.pim.workflow
A NestedWorkflowStep is a special Workflow step where another Workflow is embedded.
next() - Method in interface com.ibm.pim.search.SearchResultSet
Use this method to iterate through rows in result set.
NonPersistedAttributeRuleFunction - Interface in com.ibm.pim.extensionpoints
 

O

OCCURRENCE_DELIMITER - Static variable in interface com.ibm.pim.attribute.AttributeInstance
 
Organization - Interface in com.ibm.pim.organization
Interface for Organization object.
OrganizationHierarchy - Interface in com.ibm.pim.organization
Interface for the Hierarchy object representing a Hierarchy of organizations.
OrganizationManager - Interface in com.ibm.pim.organization
Manager for organizations, organization hierarchies, access control groups, roles, users and companies.
out(WorkflowStepFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.WorkflowStepFunction
Driven by WPC on exit from a step.

P

PATH_DELIMITER - Static variable in interface com.ibm.pim.attribute.AttributeInstance
 
Performer - Interface in com.ibm.pim.organization
An interface representing a role or a user in the system.
Permission - Enum in com.ibm.pim.organization
The authorizations comprised by an AccessControlGroup
PIMAlreadyInTransactionException - Exception in com.ibm.pim.common.exceptions
This exception is thrown when operation is already under a transaction and a new transaction is attempted.
PIMAlreadyInTransactionException(String) - Constructor for exception com.ibm.pim.common.exceptions.PIMAlreadyInTransactionException
 
PIMAuthenticationException - Exception in com.ibm.pim.common.exceptions
PIM Authentication Exception
PIMAuthenticationException(String) - Constructor for exception com.ibm.pim.common.exceptions.PIMAuthenticationException
Constructs a new exception with the specified detail message.
PIMAuthenticationException(String, Throwable) - Constructor for exception com.ibm.pim.common.exceptions.PIMAuthenticationException
Constructs a new exception with the specified detail message.
PIMAuthorizationException - Exception in com.ibm.pim.common.exceptions
PIM Authorization Exception
PIMAuthorizationException(String) - Constructor for exception com.ibm.pim.common.exceptions.PIMAuthorizationException
Constructs a new exception with the specified detail message.
PIMAuthorizationException(String, Throwable) - Constructor for exception com.ibm.pim.common.exceptions.PIMAuthorizationException
Constructs a new exception with the specified detail message.
PIMCollection<E> - Interface in com.ibm.pim.collection
PIM version of java.util.Collection, which can only handle PIM objects (Catalog, Category, Item, Hierarchy, Spec, LookupTable etc.).
PIMContextFactory - Class in com.ibm.pim.context
Factory for retrieving a context for a given set of credentials
PIMContextFactory() - Constructor for class com.ibm.pim.context.PIMContextFactory
 
PIMException - Exception in com.ibm.pim.common.exceptions
Generic PIM Exception
PIMException(String) - Constructor for exception com.ibm.pim.common.exceptions.PIMException
Constructs a new exception with the specified detail message.
PIMException(String, Throwable) - Constructor for exception com.ibm.pim.common.exceptions.PIMException
Constructs a new exception with the specified detail message.
PIMInternalException - Exception in com.ibm.pim.common.exceptions
Internal PIM Exception - e.g.
PIMInternalException(String) - Constructor for exception com.ibm.pim.common.exceptions.PIMInternalException
Constructs a new exception with the specified detail message.
PIMInternalException(String, Throwable) - Constructor for exception com.ibm.pim.common.exceptions.PIMInternalException
Constructs a new exception with the specified detail message.
PIMInvalidOperationException - Exception in com.ibm.pim.common.exceptions
This exception is thrown when an operation not supported by a particular Java API method is attempted by the caller.
PIMInvalidOperationException(String) - Constructor for exception com.ibm.pim.common.exceptions.PIMInvalidOperationException
Constructs a new exception with the specified detail message.
PIMInvalidOperationException(String, Throwable) - Constructor for exception com.ibm.pim.common.exceptions.PIMInvalidOperationException
Constructs a new exception with the specified detail message.
PIMInvalidPathException - Exception in com.ibm.pim.common.exceptions
This exception is thrown when an invalid path is encountered.
PIMInvalidPathException(String) - Constructor for exception com.ibm.pim.common.exceptions.PIMInvalidPathException
Constructs a new exception with the specified detail message.
PIMInvalidPathException(String, Throwable) - Constructor for exception com.ibm.pim.common.exceptions.PIMInvalidPathException
Constructs a new exception with the specified detail message.
PIMProgress - Interface in com.ibm.pim.system
Interface for the PIMProgress object.
PIMScript - Interface in com.ibm.pim.system
Interface for the PIMScript object.
PIMScript.ScriptContext - Enum in com.ibm.pim.system
Script globals pre-defined values
PIMScriptManager - Interface in com.ibm.pim.system
Interface for the manager of PIMScript objects.
PIMSearchException - Exception in com.ibm.pim.common.exceptions
An exception that provides information on MDMPIM Search related errors.
PIMSearchException(String) - Constructor for exception com.ibm.pim.common.exceptions.PIMSearchException
 
PIMSearchException(String, Throwable) - Constructor for exception com.ibm.pim.common.exceptions.PIMSearchException
 
PIMUndefinedValueException - Exception in com.ibm.pim.common.exceptions
This exception can be used when there is no value(null value) for particular column in a row of a result set.
PIMUndefinedValueException(String) - Constructor for exception com.ibm.pim.common.exceptions.PIMUndefinedValueException
 
PIMUndefinedValueException(String, Throwable) - Constructor for exception com.ibm.pim.common.exceptions.PIMUndefinedValueException
 
PIMWebServicesContextFactory - Class in com.ibm.pim.context
Factory for retrieving the context from the current web service.
PIMWebServicesContextFactory() - Constructor for class com.ibm.pim.context.PIMWebServicesContextFactory
 
PIMWriter - Interface in com.ibm.pim.system
Interface for the PIMWriter object.
PostCategorySaveFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to invocation invocations.
PostCollaborationCategorySaveFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to invocation invocations.
PostCollaborationItemSaveFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to invocation invocations.
PostItemSaveFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to invocation invocations.
postsave(PostItemSaveFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.PostSaveFunction
Perform post save processing for item
postsave(PostCategorySaveFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.PostSaveFunction
Perform post save processing for category
postsave(PostCollaborationItemSaveFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.PostSaveFunction
Perform post save processing for collaboration item
postsave(PostCollaborationCategorySaveFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.PostSaveFunction
Perform post save processing for collaboration category
PostSaveFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Post Save function
prePostProcessing(ItemPrePostProcessingFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.PrePostProcessingFunction
Perform Pre or Post Processing for item.
prePostProcessing(CategoryPrePostProcessingFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.PrePostProcessingFunction
Perform Pre or Post Processing for category.
prePostProcessing(CollaborationItemPrePostProcessingFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.PrePostProcessingFunction
Perform Pre or Post Processing for collaboration item.
prePostProcessing(CollaborationCategoryPrePostProcessingFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.PrePostProcessingFunction
Perform Pre or Post Processing for collaboration category.
PrePostProcessingFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Pre & Post Processing function
PrimarySpec - Interface in com.ibm.pim.spec
Interface for the PrimarySpec object
ProcessingOptions - Interface in com.ibm.pim.common
The advanced methods provided via this object represent administrative parameters that affect the way in which items in a catalog are handled from the perspective of functional flows for example saving an item.

Q

qualifyAttributeName(String, int) - Method in interface com.ibm.pim.attribute.AttributePathHelper
Qualify an attribute name or path

R

release(CollaborationObject) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Releases the lock on a collaboration object reserved in this step.
release(Collection<CollaborationObject>) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Releases the lock on every collaboration object in the specified collection reserved in this step.
release(CollaborationObject, String) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Releases the lock on a collaboration object reserved in this step, with a comment.
release(Collection<CollaborationObject>, String) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Releases the lock on every collaboration object in the specified collection reserved in this step, with a comment.
remove(Object) - Method in interface com.ibm.pim.collection.PIMCollection
Remove a single instance of the ID of the specified object from this PIM collection.
removeAll(Collection<?>) - Method in interface com.ibm.pim.collection.PIMCollection
Removes all the elements in the specified collection from this collection.
removeAllAttributes(Spec) - Method in interface com.ibm.pim.attribute.AttributeCollection
Removes all the attributes of the spec from this attribute collection.
removeAllMappings() - Method in interface com.ibm.pim.hierarchy.HierarchyMap
Removes all mappings in the hierarchymap.
removeAttribute(AttributeDefinition) - Method in interface com.ibm.pim.attribute.AttributeCollection
Removes an attribute from the attribute collection by specifying the AttributeDefinition.
removeAttribute(String) - Method in interface com.ibm.pim.attribute.AttributeCollection
Removes an attribute from the attribute collection by specifying the path to the AttributeDefinition.
removeAttributeDefinition(String) - Method in interface com.ibm.pim.spec.Spec
Remove an attribute definition, returns null if attribute definition with the given path is not found
removeCategory(Category) - Method in interface com.ibm.pim.selection.StaticItemSelection
Removes the category from the selection if it is present in the selection.
removeChild(CollaborationCategory) - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Remove the given child Category from this category's children.
removeChild(Category) - Method in interface com.ibm.pim.hierarchy.category.Category
Remove the given child Category from this category's children.
removeChild(Organization) - Method in interface com.ibm.pim.organization.Organization
Remove the given child Organization from this organization's children.
removeCurrencies(List<Currency>) - Method in interface com.ibm.pim.organization.Company
Removes Currencies from those available to this company.
removeDistribution(Distribution) - Method in interface com.ibm.pim.utils.DistributionGroup
Removes a distribution from this distribution group
removeExitValue(ExitValue) - Method in interface com.ibm.pim.workflow.WorkflowStep
Remove an exit value, identified by the ExitValue object passed in, from this Workflow Step.
removeExitValue(String) - Method in interface com.ibm.pim.workflow.WorkflowStep
Remove an exit value, with name identified by the String passed in, from this Workflow Step.
removeFromCategory(Category) - Method in interface com.ibm.pim.catalog.item.Item
Remove an item from a category.
removeFromCategory(Category) - Method in interface com.ibm.pim.collaboration.CollaborationItem
Remove an item from a category.
removeFromTransition(CollaborationObject) - Method in interface com.ibm.pim.collaboration.CollaborationStepTransitionConfiguration
Removes the specified collaboration object from this transition, causing it to stay in its origin step.
removeHierarchyMap(String, String) - Method in interface com.ibm.pim.utils.ImportList
Removes the hierarchy map from this list.
removeItem(Item) - Method in interface com.ibm.pim.selection.StaticItemSelection
Removes the item from the selection if it is present in the selection.
removeItemSecondarySpec(SecondarySpec) - Method in interface com.ibm.pim.hierarchy.category.Category
Disassociates a secondary item spec to from this Category.
removeLink(AttributeDefinition) - Method in interface com.ibm.pim.catalog.Catalog
Removes an existing link between catalogs.
removeLocale(Locale) - Method in interface com.ibm.pim.spec.Spec
Removes the given locale from this spec.
removeLocaleRestriction(Locale) - Method in interface com.ibm.pim.attribute.AttributeCollection
Removes a locale as a restricted locale for this attribute collection.
removeLocales(List<Locale>) - Method in interface com.ibm.pim.organization.Company
Removes Locales from those available to this company.
removeMapping(Category, Category) - Method in interface com.ibm.pim.hierarchy.HierarchyMap
Removes a mapping between two categories in the hierarchymap.
removeObject(ExportList.Type, String) - Method in interface com.ibm.pim.utils.ImportList
Removes the object of specified type and name from this list.
removeObjects(ExportList.Type) - Method in interface com.ibm.pim.utils.ImportList
Removes all the objects of the specified type from this list
removeOccurrence() - Method in interface com.ibm.pim.attribute.AttributeInstance
If this is an occurrence of an attribute instance which has an attribute definition with a max occurrence greater than zero, the AttributeInstance will be deleted.
removeSecondaryHierarchy(OrganizationHierarchy) - Method in interface com.ibm.pim.catalog.Catalog
removes an organization hierarchy from the catalog
removeSecondaryHierarchy(Hierarchy) - Method in interface com.ibm.pim.catalog.Catalog
removes a hierarchy from the catalog
removeSecondarySpec(SecondarySpec) - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Disassociates a secondary spec defining this category’s attributes.
removeSecondarySpec(SecondarySpec) - Method in interface com.ibm.pim.hierarchy.category.Category
Disassociates a secondary spec defining this category’s attributes.
removeSpec(Spec) - Method in interface com.ibm.pim.attribute.AttributeCollection
Removes a spec from this attribute collections list of dynamic attribute sources.
removeTimeout(CollaborationObject) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Removes any existing timeout for the given collaboration object.
replaceLocales(Collection<Locale>) - Method in interface com.ibm.pim.spec.Spec
Removes all of the the existing locales and sets the new ones passed to this method
Report - Interface in com.ibm.pim.job
Interface for Report object.
reportGenerate(ReportGenerateFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.ReportGenerateFunction
Generate a Report.
ReportGenerateFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the function currently provided via the script extension point "Report Generate Script"
ReportGenerateFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to ReportGenerateFunction invocations.
reserve(CollaborationObject) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Acquires a lock to reserve a collaboration object in this step.
reserve(Collection<CollaborationObject>) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Acquires a lock on every collaboration object in the specified collection to reserve them all in this step.
reserve(CollaborationObject, String) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Acquires a lock to reserve a collaboration object in this step, with a comment.
reserve(Collection<CollaborationObject>, String) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Acquires a lock on every collaboration object in the specified collection to reserve them all in this step, with a comment.
resetCursor() - Method in interface com.ibm.pim.search.SearchResultSet
Reset cursor to first row of the Resultset.
resetProcessingOptions() - Method in interface com.ibm.pim.common.ProcessingOptions
Re-enables the default processing options disabled by methods such as disablePreScript, disableMinMaxOccurrenceValidation, etc
retainAll(Collection<?>) - Method in interface com.ibm.pim.collection.PIMCollection
Retains only those elements in this collection that are elements of the specified collection (i.e.
revokePermissions(Role, Set<Permission>) - Method in interface com.ibm.pim.organization.AccessControlGroup
Revokes the given set of permissions to this role.
revokePermissions(AccessControlGroup, Set<Permission>) - Method in interface com.ibm.pim.organization.Role
Revokes the given set of permissions to this role as part of the given access control group.
revokeScreenPrivileges(Set<ScreenPrivilege>) - Method in interface com.ibm.pim.organization.Role
Revokes the given screen privileges
revokeSystemWideAccessPrivileges(Set<SystemWideAccessPrivilege>) - Method in interface com.ibm.pim.organization.Role
Revokes the given system wide access privileges
richSearchReport(RichSearchReportFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.RichSearchReportFunction
Create a rich search report.
RichSearchReportFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Rich Search Report function
RichSearchReportFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to RichSearchReportFunction invocations.
Role - Interface in com.ibm.pim.organization
Role interface.
Role.Privilege - Enum in com.ibm.pim.organization
Access Privileges for use with Catalog and Hierarchy objects
rollback() - Method in interface com.ibm.pim.context.Context
Rollback transaction.
rollbackAsynchronous(VersionInfo) - Method in interface com.ibm.pim.catalog.Catalog
Schedules a catalog rollback.
rollbackAsynchronous(VersionInfo) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Schedules a rollback of this hierarchy.
RoutingManager - Interface in com.ibm.pim.utils
This interface defines methods for RoutingManager.
rule(ItemDefaultValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.DefaultValueRuleFunction
Provide a default value for an Attribute on an Item
rule(CollaborationItemDefaultValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.DefaultValueRuleFunction
Provide a default value for an Attribute on an Item in a CollaborationArea
rule(CategoryDefaultValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.DefaultValueRuleFunction
Provide a default value for an Attribute on a Category
rule(CollaborationCategoryDefaultValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.DefaultValueRuleFunction
Provide a default value for an Attribute on a Category in a CollaborationArea
rule(ItemNonPersistedAttributeRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.NonPersistedAttributeRuleFunction
Provide a value for a non persisted attribute on an Item
rule(CollaborationItemNonPersistedAttributeRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.NonPersistedAttributeRuleFunction
Provide a value for a non persisted attribute on an Item in a CollaborationArea
rule(CategoryNonPersistedAttributeRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.NonPersistedAttributeRuleFunction
Provide a value for a non persisted attribute on a Category
rule(CollaborationCategoryNonPersistedAttributeRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.NonPersistedAttributeRuleFunction
Provide a value for a non persisted attribute on a Category in a CollaborationArea
rule(ItemRunValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.RunValueRuleFunction
Provide a value for an Attribute on an Item.
rule(CollaborationItemRunValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.RunValueRuleFunction
Provide a value for an Attribute on an Item in a CollaborationArea.
rule(CategoryRunValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.RunValueRuleFunction
Provide a value for an Attribute on a category.
rule(CollaborationCategoryRunValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.RunValueRuleFunction
Provide a value for an Attribute on a Category in a CollaborationArea.
rule(ItemStringEnumerationValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.StringEnumerationValueRuleFunction
Obtain the possible string values for an AttributeInstance in an item
rule(CategoryStringEnumerationValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.StringEnumerationValueRuleFunction
Obtain the possible string values for an AttributeInstance in a category
rule(CollaborationItemStringEnumerationValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.StringEnumerationValueRuleFunction
Obtain the possible string values for an AttributeInstance in a collaboration item
rule(CollaborationCategoryStringEnumerationValueRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.StringEnumerationValueRuleFunction
Obtain the possible string values for an AttributeInstance in a collaboration category
rule(ItemValidationRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.ValidationRuleFunction
Perform validation rule for items.
rule(CategoryValidationRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.ValidationRuleFunction
Perform validation rule for categories.
rule(CollaborationItemValidationRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.ValidationRuleFunction
Perform validation rule for collaboration items.
rule(CollaborationCategoryValidationRuleFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.ValidationRuleFunction
Perform validation rule for collaboration categories.
RunValueRuleFunction - Interface in com.ibm.pim.extensionpoints
 

S

save() - Method in interface com.ibm.pim.attribute.AttributeCollection
Saves the attribute collection.
save() - Method in interface com.ibm.pim.catalog.Catalog
Persists the catalog to the database.
save() - Method in interface com.ibm.pim.catalog.item.Item
Saves the item.
save() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Saves changes to collaboration area such as description, administrators, timeout.
save() - Method in interface com.ibm.pim.collaboration.CollaborationItem
Saves the item.
save() - Method in interface com.ibm.pim.hierarchy.Hierarchy
Persist the changes to the given hierarchy object
save() - Method in interface com.ibm.pim.hierarchy.HierarchyMap
Saves the hierarchy map
save() - Method in interface com.ibm.pim.job.Job
Saves the job.
save() - Method in interface com.ibm.pim.job.Schedule
Saves the job schedule.
save() - Method in interface com.ibm.pim.lookuptable.LookupTable
persists the LookupTable to the database
save() - Method in interface com.ibm.pim.lookuptable.LookupTableEntry
Persists this entry to the database
save() - Method in interface com.ibm.pim.organization.AccessControlGroup
Saves this Access Control Group
save() - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Persist the changes to the given hierarchy object
save() - Method in interface com.ibm.pim.organization.Role
Saves this role information
save() - Method in interface com.ibm.pim.organization.User
Saves this User information
save() - Method in interface com.ibm.pim.selection.Selection
Persists the changes to the selection.
save() - Method in interface com.ibm.pim.spec.Spec
Save a spec
save() - Method in interface com.ibm.pim.spec.SpecMap
Save a specMap
save() - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLog
Saves modifications to the UserDefinedLog object
save() - Method in interface com.ibm.pim.utils.DataSource
Saves the changes made to this datasource
save() - Method in interface com.ibm.pim.utils.Distribution
Saves the changes made to this distribution
save() - Method in interface com.ibm.pim.utils.DistributionGroup
Saves the changes done to this distribution group
save() - Method in interface com.ibm.pim.view.View
save changes to any ScreenViews within this Perspective
save() - Method in interface com.ibm.pim.webservice.WebService
Persists the web service to the database
save() - Method in interface com.ibm.pim.workflow.Workflow
Commit changes to the workflow design.
Schedule - Interface in com.ibm.pim.job
This is the interface for a job schedule.
Schedule.Type - Enum in com.ibm.pim.job
This is an enum type for schedule type.
ScheduleStatus - Interface in com.ibm.pim.job
Interface that provides information about job schedule status
ScheduleStatus.Type - Enum in com.ibm.pim.job
This is an enum type for job status.
ScreenPrivilege - Enum in com.ibm.pim.organization
Screen privileges for Views support
ScreenType - Enum in com.ibm.pim.view
ScreenType denotes the different types of Screen in MDMPIM to which the user can specify particular attributes (via ScreenViews within a View)
ScreenView - Interface in com.ibm.pim.view
A ScreenView is a component of a View and denotes the particular attribute collections that are in effect on this type of screen when the owning View is selected.
ScreenViewFilter - Interface in com.ibm.pim.view
A ScreenView Filter applies to a particular ScreenView within a View and describes one grouping of attribute collections that will appear in a separate UI construct (tab, panel etc) The editable/viewable state for each attribute is determined at the ScreenView level.
scriptingSandbox(ScriptingSandboxFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.ScriptingSandboxFunction
Java function that can be invoked via the sandbox.
ScriptingSandboxFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Scripting Sandbox function
ScriptingSandboxFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to ScriptingSandboxFunction invocations.
ScriptInputSpec - Interface in com.ibm.pim.spec
Interface for ScriptInputSpec
ScriptStatistics - Interface in com.ibm.pim.system
Interface for the ScriptStatistics object.
SearchQuery - Interface in com.ibm.pim.search
Read-only, but executable interface for query object.
SearchQuery.ColumnType - Enum in com.ibm.pim.search
 
SearchResultSet - Interface in com.ibm.pim.search
Read-only interface for Query results, contains a set of SearchResultRow
searchSchedules(String, ScheduleStatus.Type, Date, Date, String, String) - Method in interface com.ibm.pim.job.JobManager
Searches job schedules in the system by the given criteria.
SecondarySpec - Interface in com.ibm.pim.spec
Interface for the PrimarySpec object
Selection - Interface in com.ibm.pim.selection
Interface representing Selection objects.
Selection.Type - Enum in com.ibm.pim.selection
Enumeration listing types of Selections
SelectionManager - Interface in com.ibm.pim.selection
Manager for Selection objects
setAccessControlGroup(AccessControlGroup) - Method in interface com.ibm.pim.catalog.Catalog
Sets the Access Control Group for this catalog
setAccessControlGroup(AccessControlGroup) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Sets the specified access control group on the current collaboration area.
setAccessControlGroup(AccessControlGroup) - Method in interface com.ibm.pim.docstore.Document
Sets the access control group for this document.
setAccessControlGroup(AccessControlGroup) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Sets the Access Control Group for this hierarchy
setAccessControlGroup(AccessControlGroup) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Sets the Access Control Group for this hierarchy
setAccessControlGroup(AccessControlGroup) - Method in interface com.ibm.pim.selection.Selection
Sets the AccessControlGroup for the selection
setAccessControlGroup(AccessControlGroup) - Method in interface com.ibm.pim.workflow.Workflow
Set the access control group for a workflow.
setAddress(String) - Method in interface com.ibm.pim.organization.User
Sets the User's address
setAdministrators(Collection<Performer>) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Override/set the administrators for the collaboration area.
setAllowImportIntoStep(boolean) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set the allowImportIntoStep flag for this Workflow Step.
setAllProcessingOptions(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set all processing options: enabled or disabled.
setAttributeCollectionPrivilege(Catalog, Role.Privilege, Collection<AttributeCollection>) - Method in interface com.ibm.pim.organization.Role
Sets the privileges for a role on attribute collections for a catalog.
setAttributeCollectionPrivilege(Hierarchy, Role.Privilege, Collection<AttributeCollection>) - Method in interface com.ibm.pim.organization.Role
Sets the privileges for a role on attribute collections for a hierarchy.
setAttributeCollections(List<AttributeCollection>) - Method in interface com.ibm.pim.catalog.LocationDataConfiguration
Sets inheritance Attribute Collections for this particular Configuration.
setAttributeCollections(List<AttributeCollection>) - Method in interface com.ibm.pim.view.ScreenViewFilter
Set attribute collections for this filter This will overwrite the current attribute collections for the filter with the new set.
setAttributeValue(String, Object) - Method in interface com.ibm.pim.attribute.AttributeOwner
Set an attribute value on this item at the specified Attribute Path.
setAuthenticationRequired(boolean) - Method in interface com.ibm.pim.webservice.WebService
Sets whether this WebService requires authentication.
setBuildScript(Document) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Describes the location of a script with an invocation point defined by the Catalog
setCanModifyLocationHierarchyAvailability(Hierarchy, boolean) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set the "can modify availability" flag for a particular location hierarchy in this workflow, This will affect whether user can modify availability of locations within that hierarchies, for items within the collaboration area based on this workflow This will also cause the location hierarchy to be returned from the getLocationHierarchiesWithCanModifyAvailabilitySettings() method.
setCategoryBuildScript(Document) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Describes the location of a script with an invocation point defined by the Hierarchy
setCategoryLockingForItemSaveProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set lock categories for item save validation processing: enabled or disabled.
setCategorySpecificAttributeProcessing(boolean) - Method in interface com.ibm.pim.catalog.item.Item
Set whether or not category specific attributes should be processed for the item Default would be true to process them
setCategorySpecificAttributeProcessing(boolean) - Method in interface com.ibm.pim.collaboration.CollaborationItem
Set whether or not category specific attributes should be processed for the item Default would be true to process them
setCollaborationAreaLocksValidationProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set collaboration area lock validation processing: enabled or disabled.
setContent(String) - Method in interface com.ibm.pim.docstore.Document
Sets the content of this document.
setContent(InputStream) - Method in interface com.ibm.pim.docstore.Document
Sets the content of this document from the InputStream.
setCustomParameter(String, Object) - Method in interface com.ibm.pim.extensionpoints.FunctionArguments
Set the value of the parameter named key.
setCustomParameter(String, String) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Sets a User Defined Custom Parameter for this Hierarchy.
setDate(Date) - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLogEntry
Sets the date for the UserDefinedLogEntry.
setDefaultValueRulesProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set default value rules processing: enabled or disabled.
setDefaultValuesProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set default values processing: enabled or disabled.
setDeleteWhenEmpty(boolean) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Sets the flag 'Delete when Empty' flag for the current collaboration area.
setDelimiter(String) - Method in interface com.ibm.pim.spec.FileSpec
Set the delimiter character for FileSpec of type DELIMITED
setDeployed(boolean) - Method in interface com.ibm.pim.webservice.WebService
Sets whether this WebService is deployed.
setDescription(String) - Method in interface com.ibm.pim.attribute.AttributeCollection
Sets or changes the description of this attribute collection.
setDescription(String) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Sets the specified description for the current collaboration area.
setDescription(String) - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLog
Sets the description of a UserDefinedLog
setDescription(String) - Method in interface com.ibm.pim.webservice.WebService
Sets the description of the given WebService.
setDescription(String) - Method in interface com.ibm.pim.workflow.Workflow
Set the description of the workflow, overriding the current description.
setDescription(String) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set the description of this Workflow Step.
setDisplayAttribute(AttributeDefinition) - Method in interface com.ibm.pim.catalog.Catalog
Describes the Catalog display attribute
setDisplayAttribute(AttributeDefinition) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Set the attribute to be used as the display attribute for the hierarchy
setDisplayAttribute(AttributeDefinition) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Set the attribute to be used as the display attribute for the hierarchy
setDuplicateItemsFoundCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of duplicate items found.
setEditableAttributeCollections(Collection<AttributeCollection>) - Method in interface com.ibm.pim.view.ScreenView
Set the editable attribute collections for this screen view This will override any existing editable attribute collections that are currently set
setEditableAttributeCollections(Collection<AttributeCollection>, ScreenType) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set/override the editable (but not required) attribute collections for a given screen type on this step.
setEditableAttributeCollections(Collection<AttributeCollection>, Hierarchy) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set/override the editable (but not required) attribute collections on the specified location hierarchy for this step.
setEmail(String) - Method in interface com.ibm.pim.organization.User
Sets the User's email address
setEnabled(boolean) - Method in interface com.ibm.pim.job.Schedule
Enables or disables a schedule.
setEnabled(boolean) - Method in interface com.ibm.pim.organization.User
Sets the User to enabled or not i.e.
setEntranceNotificationAddresses(Collection<String>) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set the email addresses that will be notified when items/categories enter this Workflow Step.
setEntryBuildScriptProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set Entry Build Script processing: enabled or disabled.
setErrorCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of errors during the script execution.
setErrorLineCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of error lines.
setExitValue(CollaborationObject, ExitValue) - Method in interface com.ibm.pim.collaboration.CollaborationStepTransitionConfiguration
Sets a new exit value for the specified collaboration object.
setFailedValidationCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of failed validations.
setFax(String) - Method in interface com.ibm.pim.organization.User
Sets the User's facsimile number
setFilters(Collection<ScreenViewFilter>) - Method in interface com.ibm.pim.view.ScreenView
Set the filters for this screen view, overwriting any existing filters set for this data view.
setFirstName(String) - Method in interface com.ibm.pim.organization.User
Sets the User's first name
setHierarchiesForRecategorization(Collection<Hierarchy>) - Method in interface com.ibm.pim.workflow.Workflow
Set a collection of hierarchies to be used when recategorizing items/categories from within this workflow.
setIgnoreHeaderLineCount(int) - Method in interface com.ibm.pim.spec.FileSpec
Set the number of header lines to ignore
setImplementationClassName(String) - Method in interface com.ibm.pim.webservice.WebService
Sets the fully qualified name of the implementation class of the given WebService.
setImplementationScript(Document) - Method in interface com.ibm.pim.webservice.WebService
Sets the implementation script for the given WebService.
setInputParameterValue(String, String) - Method in interface com.ibm.pim.job.Report
Sets the value for a report parameter
setItemBuildScript(Document) - Method in interface com.ibm.pim.catalog.Catalog
Describes the location of a script with an invocation point defined by the Catalog
setItemCategoryMappingAddedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of item category mapping added.
setItemsAddedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of items added during the script execution.
setItemsAlreadyCheckedOutCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of items already checked out.
setItemsCheckedOutCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of items checkd out.
setItemsDeletedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of items deleted during the script execution.
setItemsModifiedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of items modified during the script execution.
setItemsNotFoundCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of items not found.
setItemsProcessedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of items processed during the script execution.
setLastName(String) - Method in interface com.ibm.pim.organization.User
Sets the User's last name
setLdapEnabled(boolean) - Method in interface com.ibm.pim.organization.User
Specifies if the User is an LDAP user or not
setLdapEntryDn(String) - Method in interface com.ibm.pim.organization.User
Sets the Distinguished name for an LDAP User
setLdapServerUrl(String) - Method in interface com.ibm.pim.organization.User
Sets the URL of the LDAP server the User is authenticated against
setLinesProcessedCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of lines processed during the script execution.
setLocaleRestrictions(Collection<Locale>) - Method in interface com.ibm.pim.attribute.AttributeCollection
Sets the locale restrictions for this attribute collection.
setLocaleRestrictionsForScripts(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
sets or clears the enforcement of locale restrictions for scripts
setLocales(List<Locale>) - Method in interface com.ibm.pim.organization.Role
Sets an array of Locales appropriate for this Role
setLocales(Catalog, List<Locale>) - Method in interface com.ibm.pim.organization.Role
Sets an array of Locales appropriate for this Role and specific catalog.
setLocales(Hierarchy, List<Locale>) - Method in interface com.ibm.pim.organization.Role
Sets an array of Locales appropriate for this Role and specific hierarchy.
setLocalized(boolean) - Method in interface com.ibm.pim.spec.Spec
Sets the localized property of this spec
setLocationAttributeValue(Category, String, Object) - Method in interface com.ibm.pim.attribute.ExtendedAttributeOwner
This will set an attribute value on this AttributeOwner at the specified Attribute Instance Path on the location.
setLockingProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set locking processing: enabled or disabled.
setMergeWithOldVersionProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set merge with old version processing: enabled or disabled.
setMinMaxLengthProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set Min & Max Length processing: enabled or disabled.
setMinMaxOccurrenceValidationProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set Min & Max Occurrence Validation processing: enabled or disabled.
setName(String) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Sets the name for the current collaboration area.
setName(String) - Method in interface com.ibm.pim.selection.Selection
Sets the name for the Selection
setName(String) - Method in interface com.ibm.pim.system.PIMWriter
Sets the name of the writer.
setName(String) - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLog
Sets the name of a UserDefinedLog
setName(String) - Method in interface com.ibm.pim.webservice.WebService
Sets the name of the given WebService.
setName(String) - Method in interface com.ibm.pim.workflow.Workflow
Set the name of the workflow, overriding the current name.
setNextRunningTime(Date) - Method in interface com.ibm.pim.job.Schedule
Sets the next running time of a schedule.
setNextStep(ExitValue, WorkflowStep) - Method in interface com.ibm.pim.workflow.WorkflowStep
Override/set the next step for a particular exit value on this step
setNextStep(String, WorkflowStep) - Method in interface com.ibm.pim.workflow.WorkflowStep
Override/set the next step for a particular exit value
setNextSteps(ExitValue, Collection<WorkflowStep>) - Method in interface com.ibm.pim.workflow.WorkflowStep
Override/set the next steps for a particular exit value on this step
setNextSteps(String, Collection<WorkflowStep>) - Method in interface com.ibm.pim.workflow.WorkflowStep
Override/set the next steps for a particular exit value
setOrdered(boolean) - Method in interface com.ibm.pim.catalog.Catalog
Changes the catalog to allow ordering or not.
setParameterValue(String, String) - Method in interface com.ibm.pim.job.Job
Sets the parameter value for the job schedule.
setParameterValue(String, String) - Method in interface com.ibm.pim.job.Schedule
Sets parameter for the job schedule.
setPassword(String) - Method in interface com.ibm.pim.organization.User
Sets the User's password
setPatternValidationProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set Pattern validation processing: enabled or disabled.
setPhone(String) - Method in interface com.ibm.pim.organization.User
Sets the User's phone number
setPossibleValueProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set Possible Value processing: enabled or disabled.
setPostSaveScript(Document) - Method in interface com.ibm.pim.catalog.Catalog
Describes the location of a script with an invocation point defined by the Catalog
setPostSaveScript(Document) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Describes the location of a script with an invocation point defined by the collaboration area.
setPostSaveScript(Document) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Describes the location of a script with an invocation point defined by the Hierarchy
setPostSaveScriptProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set post-save script processing for this collaboration area: enabled or disabled.
setPostScript(Document) - Method in interface com.ibm.pim.catalog.Catalog
Describes the location of a script with an invocation point defined by the Catalog
setPostScript(Document) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Describes the location of a script with an invocation point defined by the collaboration area.
setPostScript(Document) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Describes the location of a script with an invocation point defined by the Hierarchy
setPostScriptProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set post-script processing: enabled or disabled.
setPreScript(Document) - Method in interface com.ibm.pim.catalog.Catalog
Describes the location of a script with an invocation point defined by the Catalog
setPreScript(Document) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Describes the location of a script with an invocation point defined by the collaboration area
setPreScript(Document) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Describes the location of a script with an invocation point defined by the Hierarchy
setPreScriptProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set pre-script processing: enabled or disabled.
setPrimaryKey(String) - Method in interface com.ibm.pim.catalog.item.Item
Sets the primary key.
setPrimaryKey(String) - Method in interface com.ibm.pim.collaboration.CollaborationItem
Sets the primary key.
setPrimaryKey(String) - Method in interface com.ibm.pim.spec.LookupSpec
Sets the primaryKeyPath of this spec to the given path.
setPrimaryKey(String) - Method in interface com.ibm.pim.spec.PrimarySpec
Sets the primaryKeyPath of this spec to the given path.
setProgress(int) - Method in interface com.ibm.pim.system.PIMProgress
Sets the progress.
setProperty(Document.Property, String) - Method in interface com.ibm.pim.docstore.Document
Sets the value for the property, the property name is specified by propertyName and the value is given by propertyValue.
setProperty(String, String) - Method in interface com.ibm.pim.docstore.Document
Sets the value for the property, the property name is specified by propertyName and the value is given by propertyValue.
setProperty(String, String) - Method in interface com.ibm.pim.system.PIMWriter
Sets the property of the writer.
setProperty(DataSource.Property, String) - Method in interface com.ibm.pim.utils.DataSource
Sets the datasource property
setProperty(Distribution.Property, String) - Method in interface com.ibm.pim.utils.Distribution
Sets the distribution properties
setQuery(String) - Method in interface com.ibm.pim.selection.DynamicCollaborationItemSelection
Sets the query for the dynamic selection on CollaborationObject.
setQuery(String) - Method in interface com.ibm.pim.selection.DynamicItemSelection
Sets the query for the dynamic selection.
setRecategorize(boolean) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set the recategorize flag for this Workflow Step.
setRecurring(boolean) - Method in interface com.ibm.pim.job.Job
Enables or disables the job to be recurring.A job can be recurring if the job can be scheduled to run more than one time, i.e.
setRequiredAttributeCollections(Collection<AttributeCollection>, ScreenType) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set/override the required & editable attribute collections for a given screen type on this step.
setRequiredAttributeCollections(Collection<AttributeCollection>, Hierarchy) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set/override the required & editable attribute collections on the specified location hierarchy for this step.
setReRunPerOccurrence(boolean) - Method in interface com.ibm.pim.extensionpoints.CategoryStringEnumerationValueRuleFunctionArguments.CategoryReRunPerOccurrenceControl
Alter the state of the 'run_rule_per_occurrence' flag
setReRunPerOccurrence(boolean) - Method in interface com.ibm.pim.extensionpoints.CollaborationCategoryStringEnumerationValueRuleFunctionArguments.CollaborationCategoryReRunPerOccurrenceControl
Alter the state of the 'run_rule_per_occurrence' flag
setReRunPerOccurrence(boolean) - Method in interface com.ibm.pim.extensionpoints.CollaborationItemStringEnumerationValueRuleFunctionArguments.CollaborationItemReRunPerOccurrenceControl
Alter the state of the 'run_rule_per_occurrence' flag
setReRunPerOccurrence(boolean) - Method in interface com.ibm.pim.extensionpoints.ItemStringEnumerationValueRuleFunctionArguments.ItemReRunPerOccurrenceControl
Alter the state of the 'run_rule_per_occurrence' flag
setReserveToEdit(boolean) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set the reserveToEdit flag for this Workflow Step.
setRoles(List<Role>) - Method in interface com.ibm.pim.organization.User
Sets the Roles applicable to this User
setRunningLog(boolean) - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLog
Sets or unsets the running log behavior of a UserDefinedLog
setSequencesProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set sequence field completion processing: enabled or disabled.
setSkipRequestValidation(boolean) - Method in interface com.ibm.pim.webservice.WebService
Sets whether the inbound message requires validation against WSDL schema.
setSkipResponseValidation(boolean) - Method in interface com.ibm.pim.webservice.WebService
Sets whether the outbound message requires validation against WSDL schema.
setStepScript(Document) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set script path for this Workflow Step, overriding the current setting.
setStoreRequest(boolean) - Method in interface com.ibm.pim.webservice.WebService
Sets the storeRequest property of the given WebService.
setStoreResponse(boolean) - Method in interface com.ibm.pim.webservice.WebService
Sets the storeResponse of the given WebService.
setStyle(WebService.MessageStyle) - Method in interface com.ibm.pim.webservice.WebService
Sets the message style of the given WebService.
setTimeout(CollaborationObject, Date) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Sets the moment in time at which the specified collaboration object will timeout for this step.
setTimeout(CollaborationObject, int) - Method in interface com.ibm.pim.collaboration.CollaborationStep
Sets the time period until the specified collaboration object will timeout for this step.
setTimeoutDate(Date) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Sets the timeout date for the current collaboration area.
setTimeoutDate(Date) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set the timeout for this step
setTimeoutDuration(int) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Sets the timeout duration for the current collaboration area.
setTimeoutDuration(int) - Method in interface com.ibm.pim.workflow.WorkflowStep
Sets the timeout duration.
setTimeoutNotificationAddresses(Collection<String>) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set the email addresses that will be notified as a result of timeout from this step
setTitle(String) - Method in interface com.ibm.pim.organization.User
Sets the User's title
setTypeValidationProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set type validation processing: enabled or disabled.
setUniquenessValidationProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set uniqueness validation processing: enabled or disabled.
setUserDefinedAttributeCollection(AttributeCollection) - Method in interface com.ibm.pim.catalog.Catalog
Specifies the User Defined Core Attribute Collection for this Catalog
setUserDefinedAttributeCollection(AttributeCollection) - Method in interface com.ibm.pim.collaboration.CollaborationArea
Specifies the User Defined Core Attribute Collection for this Catalog
setUserDefinedAttributeCollection(AttributeCollection) - Method in interface com.ibm.pim.hierarchy.Hierarchy
Associate the User defined Attribute Collection with the hierarchy
setUserDefinedAttributeCollection(AttributeCollection) - Method in interface com.ibm.pim.organization.OrganizationHierarchy
Associate the User defined Core Attribute collection with the hierarchy
setUserName(String) - Method in interface com.ibm.pim.organization.User
Sets the Username
setUserSettingValue(UserSetting, String) - Method in interface com.ibm.pim.organization.User
Sets the value for a user setting
setValidationRulesProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set validation-rule processing: enabled or disabled.
setValue(Object) - Method in interface com.ibm.pim.attribute.AttributeDefinitionProperty
Sets the value of this attribute
setValue(Object) - Method in interface com.ibm.pim.attribute.AttributeInstance
Set the current value of this attribute instance.
setValue(Catalog, String) - Method in interface com.ibm.pim.attribute.AttributeInstance
If this AttributeInstance is of type RELATIONSHIP, this method can set a related item as the value for this instance, specified by catalog and primary key
setValue(Item) - Method in interface com.ibm.pim.attribute.AttributeInstance
If this AttributeInstance is of type RELATIONSHIP, this method can set a related item as the value for this instance, specified by object reference
setValue(String) - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLogEntry
Store a string with this log entry, overwriting any previous string.
setValueByExecutingNonPersistedAttributeRule(boolean) - Method in interface com.ibm.pim.attribute.AttributeInstance
Executes the non-persisted script to set the value for this attribute instance
setValueRulesProcessing(boolean) - Method in interface com.ibm.pim.common.ProcessingOptions
Set value-rule validation processing: enabled or disabled.
setValues(List<Object>) - Method in interface com.ibm.pim.attribute.AttributeDefinitionProperty
Sets the values of a property, if the property in question can have multiple values
setViewableAttributeCollections(Collection<AttributeCollection>) - Method in interface com.ibm.pim.view.ScreenView
Set the viewable attribute collections for this screen view This will override any existing viewable attribute collections that are currently set
setViewableAttributeCollections(Collection<AttributeCollection>, ScreenType) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set/override the viewable attribute collections for a given screen type on this step.
setViewableAttributeCollections(Collection<AttributeCollection>, Hierarchy) - Method in interface com.ibm.pim.workflow.WorkflowStep
Set/override the viewable attribute collections on the specified location hierarchy for this step.
setWarningCount(int) - Method in interface com.ibm.pim.system.ScriptStatistics
Sets the number of warnings during the script execution.
setWsddDocument(Document) - Method in interface com.ibm.pim.webservice.WebService
Sets the WSDD document.
setWsdlDocument(Document) - Method in interface com.ibm.pim.webservice.WebService
Sets the WSDL document.
size() - Method in interface com.ibm.pim.collection.PIMCollection
Return the current number of elements in the collection, regardless of whether all the IDs can be resolved.
size() - Method in interface com.ibm.pim.docstore.Document
Fetches the size of this document
size() - Method in interface com.ibm.pim.search.SearchResultSet
Returns the number of rows in the resultset.
Spec - Interface in com.ibm.pim.spec
Interface for the generic Spec object
Spec.Type - Enum in com.ibm.pim.spec
Possible Spec types
SpecManager - Interface in com.ibm.pim.spec
Manager for Spec objects
SpecMap - Interface in com.ibm.pim.spec
Interface for SpecMap
SpecMap.Type - Enum in com.ibm.pim.spec
Possible SpecMap types
SpecMapEntry - Interface in com.ibm.pim.spec
Interface for SpecMapEntry
startBatchProcessing() - Method in interface com.ibm.pim.common.Batchable
This is the setup method for batch processing.
startTransaction() - Method in interface com.ibm.pim.context.Context
Start a transaction.
StaticItemSelection - Interface in com.ibm.pim.selection
Interface representing a static item selection.
StaticSelection - Interface in com.ibm.pim.selection
Marker interface representing a static selection.
stop() - Method in interface com.ibm.pim.job.Schedule
Stops the specified job schedule if it is currently running.
stopBatchProcessing() - Method in interface com.ibm.pim.common.Batchable
This is the tear-down method for batch processing.
StringEnumerationValueRuleFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the String Enumeration Value Rule function
stripAttributeName(String) - Method in interface com.ibm.pim.attribute.AttributePathHelper
Remove qualifier from attribute name or path
SubSpec - Interface in com.ibm.pim.spec
Interface for SubSpec object
SystemWideAccessPrivilege - Enum in com.ibm.pim.organization
System Wide Access Privileges that can be granted to roles

T

timeout(WorkflowStepFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.WorkflowStepFunction
Driven by WPC on exit from a step due to an expiring timeout.
TimezoneResolver - Interface in com.ibm.pim.utils
 
toArray() - Method in interface com.ibm.pim.collection.PIMCollection
Retrieve the whole collection as an array.
toArray(T[]) - Method in interface com.ibm.pim.collection.PIMCollection
Unsupported method.
toString() - Method in interface com.ibm.pim.workflow.ExitValue
get the String for this exit value
trigger(TriggerFunctionArguments) - Method in interface com.ibm.pim.extensionpoints.TriggerFunction
Perform trigger function.
TriggerFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the (Secure) Trigger function
TriggerFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to TriggerFunction invocations.

U

UIHelper - Interface in com.ibm.pim.system
This interface provides methods for returning the URL for the page requested.
unlock() - Method in interface com.ibm.pim.collaboration.CollaborationArea
Unlocks the collaboration area.
useInheritance(boolean) - Method in interface com.ibm.pim.attribute.LocationAttributeInstance
Sets this location attribute (either value or multi-occurrence), to either override inheritance or to inherit from its parent without providing any values.
User - Interface in com.ibm.pim.organization
Interface for the User object.
UserDefinedLog - Interface in com.ibm.pim.userdefinedlog
Interface for UserDefinedLog object
UserDefinedLogEntry - Interface in com.ibm.pim.userdefinedlog
Interface for a UserDefinedLogEntry object
UserDefinedLogWriter - Interface in com.ibm.pim.userdefinedlog
Interface which can be used in conjunction with the UserDefinedLog interface to write User defined log entries in any required format.
UserJob - Interface in com.ibm.pim.job
This is the super interface for all user job types
UserSetting - Enum in com.ibm.pim.organization
Enumeration listing constants representing user setting attributes.

V

validate() - Method in interface com.ibm.pim.catalog.item.Item
Validates the item.
validate() - Method in interface com.ibm.pim.collaboration.CollaborationCategory
Validates the category.
validate() - Method in interface com.ibm.pim.collaboration.CollaborationItem
Validates the item.
validate() - Method in interface com.ibm.pim.hierarchy.category.Category
Validates the category.
validate() - Method in interface com.ibm.pim.organization.Organization
Validates the organization.
validate() - Method in interface com.ibm.pim.workflow.Workflow
Validate the workflow graph to determine whether it can be saved.
ValidationError - Interface in com.ibm.pim.common
Provides the details of validation error
ValidationError.Type - Enum in com.ibm.pim.common
 
ValidationErrors - Interface in com.ibm.pim.common
Provides the list of validation errors
ValidationRuleFunction - Interface in com.ibm.pim.extensionpoints
 
valueOf(String) - Static method in enum com.ibm.pim.attribute.AttributeDefinition.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.attribute.AttributeDefinitionProperty.Name
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.catalog.item.Item.SaveResult
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.collaboration.CheckoutStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.collaboration.CollaborationItem.SaveResult
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.collaboration.CollaborationObject.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.common.ValidationError.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.common.VersionInfo.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.docstore.Document.Property
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.docstore.DocumentAuditLog.AccessType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.hierarchy.category.Category.SaveResult
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.job.Executable.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.job.Export.ContentDiffType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.job.Export.OptionalArguments
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.job.Export.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.job.Import.OptionalArguments
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.job.ItemImport.ImportSemantics
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.job.Schedule.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.job.ScheduleStatus.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.organization.Permission
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.organization.Role.Privilege
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.organization.ScreenPrivilege
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.organization.SystemWideAccessPrivilege
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.organization.UserSetting
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.search.SearchQuery.ColumnType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.selection.Selection.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.spec.FileSpec.FileType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.spec.Spec.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.spec.SpecMap.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.system.PIMScript.ScriptContext
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.utils.CharSet
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.utils.DataSource.Property
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.utils.DataSource.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.utils.Distribution.Property
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.utils.Distribution.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.utils.ExportList.ActionMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.utils.ExportList.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.view.ScreenType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.view.View.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.webservice.WebService.MessageStyle
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.pim.workflow.WorkflowStep.Type
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ibm.pim.attribute.AttributeDefinition.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.attribute.AttributeDefinitionProperty.Name
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.catalog.item.Item.SaveResult
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.collaboration.CheckoutStatus
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.collaboration.CollaborationItem.SaveResult
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.collaboration.CollaborationObject.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.common.ValidationError.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.common.VersionInfo.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.docstore.Document.Property
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.docstore.DocumentAuditLog.AccessType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.hierarchy.category.Category.SaveResult
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.job.Executable.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.job.Export.ContentDiffType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.job.Export.OptionalArguments
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.job.Export.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.job.Import.OptionalArguments
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.job.ItemImport.ImportSemantics
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.job.Schedule.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.job.ScheduleStatus.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.organization.Permission
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.organization.Role.Privilege
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.organization.ScreenPrivilege
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.organization.SystemWideAccessPrivilege
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.organization.UserSetting
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.search.SearchQuery.ColumnType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.selection.Selection.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.spec.FileSpec.FileType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.spec.Spec.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.spec.SpecMap.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.system.PIMScript.ScriptContext
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.utils.CharSet
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.utils.DataSource.Property
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.utils.DataSource.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.utils.Distribution.Property
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.utils.Distribution.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.utils.ExportList.ActionMode
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.utils.ExportList.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.view.ScreenType
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.view.View.Type
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.webservice.WebService.MessageStyle
Returns an array containing the constants of this enum type, in the order they're declared.
values() - Static method in enum com.ibm.pim.workflow.WorkflowStep.Type
Returns an array containing the constants of this enum type, in the order they're declared.
VersionInfo - Interface in com.ibm.pim.common
Represents a label for a snapshot of a catalog or hierarchy and their content.
Note that no PIMAuthorizationException can be thrown here since access to and authorization for these methods is controlled from the parent.
VersionInfo.Type - Enum in com.ibm.pim.common
Enumeration for the version type
View - Interface in com.ibm.pim.view
A View is applied to a particular Catalog or Hierarchy and affects which attributes can be edited or viewed in the user interface.
View.Type - Enum in com.ibm.pim.view
The type of the View
visit(UserDefinedLog) - Method in interface com.ibm.pim.userdefinedlog.UserDefinedLogWriter
Iterates through the user defined log entries and writes the entries in any required format.

W

warningsCount() - Method in interface com.ibm.pim.common.BatchStatistics
Returns the count of warnings
WebService - Interface in com.ibm.pim.webservice
Interface for the WebService object.
WebService.MessageStyle - Enum in com.ibm.pim.webservice
Enumeration listing the message styles which will be used to create webservice.
WebServiceManager - Interface in com.ibm.pim.webservice
Manager for the WebService objects.
WEBSERVICES_CONTEXT_CLASS - Static variable in class com.ibm.pim.context.PIMWebServicesContextFactory
Current designated implementation WEBSERVICES_CONTEXT_CLASS
WebServiceTransaction - Interface in com.ibm.pim.webservice
Interface for the WebServiceTransaction object.
Workflow - Interface in com.ibm.pim.workflow
Interface for the Workflow object.
WorkflowManager - Interface in com.ibm.pim.workflow
WorkflowManager is an Interface for the manager of Workflow objects.
WorkflowStep - Interface in com.ibm.pim.workflow
The WorkflowStep interface represents a Step in a Workflow.
WorkflowStep.Type - Enum in com.ibm.pim.workflow
 
WorkflowStepFunction - Interface in com.ibm.pim.extensionpoints
Interface that represents the Workflow Step function
WorkflowStepFunctionArguments - Interface in com.ibm.pim.extensionpoints
Interface defining the arguments passed to WorkflowStepFunction invocations.

A B C D E F G H I J L M N O P Q R S T U V W