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

A

AccessRole - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Access Role class.
ActionName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ActionType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
activateContainers(FilePlanRepository, List<String>) - Static method in class com.ibm.jarm.api.core.BulkOperation
Performs an activate operation on each of the specified RecordCategory and/or RecordFolder entities.
Active - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
add(AlternateRetention) - Method in interface com.ibm.jarm.api.core.AlternateRetentionList
Adds the given AlternateRetention instance to the end of this collection.
add(DispositionPhase) - Method in interface com.ibm.jarm.api.core.DispositionPhaseList
Adds the specified DispositionPhase instance to the end of this collection.
add(String, DataType, RMCardinality, Object) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds (or updates) a new RMProperty to this collection.
add(RMProperty) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds (or updates) the specified RMProperty instance to this RMProperties collection.
add(RMProperties) - Method in interface com.ibm.jarm.api.property.RMProperties
Each RMProperty member of the given RMProperties collection is added (or updated) to this RMProperties collection.
addDefensiblyDisposableContainer(String, int, int, int, RMProperties, List<RMPermission>, String) - Method in interface com.ibm.jarm.api.core.DefensiblyDisposableContainerParent
Creates a new DefensiblyDisposable container as an immediate child of this container and saves it to the associated FilePlanRepository.
addExcludeProperty(String) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Defines one or more properties to be excluded during an entity retrieval or entity refresh.
addFilePlan(String, RMProperties, List<RMPermission>) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Creates a new FilePlan instance and saves it to this file plan repository.
addFilePlan(String, RMProperties, List<RMPermission>, String) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Creates a new FilePlan instance and saves it to this file plan repository.
addIncludeProperty(RMFilterElement) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Includes properties defined by a FilterElement instance to be returned during an entity retrieval or entity refresh.
addIncludeProperty(Integer, Long, Boolean, String, Integer) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Creates a RMFilterElement instance defining one or more properties to include during an entity retrieval or entity refresh and adds the new RMFilterElement to this RMPropertyFilter instance.
addIncludeType(Integer, Long, Boolean, RMFilteredPropertyType, Integer) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Creates a RMFilterElement instance defining one or more properties to include during an entity retrieval or entity refresh.
addMember(RMPrincipal) - Method in interface com.ibm.jarm.api.security.RMRole
Adds given RMPrincipal to this RMRole.
addNewRole(String, String, String, String) - Method in interface com.ibm.jarm.api.security.RMRoles
Creates a new RMRole member for this collection and saves it to the corresponding repository from which this collection originated.
addRecordCategory(String, RMProperties, List<RMPermission>) - Method in interface com.ibm.jarm.api.core.RecordCategoryContainer
Creates a new RecordCategory instance as an immediate child of this container and saves it to the associated FilePlanRepository.
addRecordCategory(String, RMProperties, List<RMPermission>, String) - Method in interface com.ibm.jarm.api.core.RecordCategoryContainer
Creates a new RecordCategory instance as an immediate child of this container and saves it to the associated FilePlanRepository.
addRecordFolder(String, RMProperties, List<RMPermission>) - Method in interface com.ibm.jarm.api.core.RecordFolderContainer
Creates a new RecordFolder instance as an immediate child of this container and saves it to the associated FilePlanRepository.
addRecordFolder(String, RMProperties, List<RMPermission>, String) - Method in interface com.ibm.jarm.api.core.RecordFolderContainer
Creates a new RecordFolder instance as an immediate child of this container and saves it to the associated FilePlanRepository.
addRecordVolume(String, String, RMProperties, List<RMPermission>) - Method in interface com.ibm.jarm.api.core.RecordVolumeContainer
Creates a new RecordVolume instance as an immediate child of this container and saves it to the FilePlanRepository.
addRecordVolume(String, String, RMProperties, List<RMPermission>, String) - Method in interface com.ibm.jarm.api.core.RecordVolumeContainer
Creates a new RecordVolume instance as an immediate child of this container and saves it to the FilePlanRepository.
addReportQueries(String[], String) - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
addValues(String, String, String) - Method in class com.ibm.jarm.api.query.ReportParameter
Adds a new parameter value to this instance.
Aggregation - Interface in com.ibm.jarm.api.constants
String constant definitions of supported values for the RMPropertyName.Aggregation property value.
Aggregation - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Alias - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AllNonObjectPropertySet - Static variable in class com.ibm.jarm.api.property.RMPropertyFilter
A constant RMPropertyFilter instance that indicates that all non-Object type properties should be retrieved for the entity in question.
AllowedRMContainees - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AllowedRMTypes - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
allowsForeignObject() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionObject
Indicates whether or not value of a property that is based on this property description is allowed to contain a reference to an object from a different repository.
allowsInstances() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Indicates whether or not objects based upon this class description can be instantiated.
AlternateRetention - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Alternate Retention class.
AlternateRetention - Interface in com.ibm.jarm.api.core
An interface that represents an AlternateRetention custom object that can be an optional member of a DispositionPhase instance.
AlternateRetentionList - Interface in com.ibm.jarm.api.core
Represents an ordered collection of AlternateRetention instances defined for a single DispositionPhase.
AlternateRetentions - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ApplicationName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AppliedFor - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AppliedForCategoryOrFolder - Enum in com.ibm.jarm.api.constants
Enumeration of values applicable to auto-naming of record containers.
ApplyToNameOrID - Enum in com.ibm.jarm.api.constants
Enumeration of values applicable to auto-naming of record containers.
ApplyToNameOrId - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AppropvedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
assignDispositionSchedule(DispositionSchedule, SchedulePropagation) - Method in interface com.ibm.jarm.api.core.DispositionAllocatable
Assigns the specified DispositionSchedule to this entity.
assignRecordAsReceiptOfParent(Record) - Method in interface com.ibm.jarm.api.core.Record
Assigns this record as a "receipt" of the specified parent record.
AssociatedFolders - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedPhase - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedRCVitalDisposalTriggers - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedRecordCategories - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedRecordFolders - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedRecords - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedRecordsRT - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedRecordType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedRecordTypes - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedRFVitalDisposalTriggers - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedRIVitalDisposalTriggers - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedSchedule - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedSchedules - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedSchedulesForTrigger - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedVolumeVitalDisposalTriggers - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AssociatedWorkflow - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
associateRecordType(RecordType) - Method in interface com.ibm.jarm.api.core.Record
Associates a RecordType instance with this record.
AuditableEntity - Interface in com.ibm.jarm.api.core
Represents an entity for which audit events can be retrieved.
AuditActionType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
AuditConfiguration - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Audit Configuration class.
AuditEvent - Interface in com.ibm.jarm.api.core
Interface that represents repository instances of "RM Audit" custom events and other "Object Change Event" types.
AuditStatus - Enum in com.ibm.jarm.api.constants
Indicates whether the operation that caused the creation of an audit event was a success or failure.

B

BarcodeID - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
BaseEntity - Interface in com.ibm.jarm.api.core
Base interface for all repository-persisted entities.
Box - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Box folder class.
buildContentQueryStmt() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Abstract method to build the CBR search SQL statement.
buildContentQueryStmt(List<String>, boolean) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Abstract method to build the CBR search SQL statement to search for documents with the given document ID lists.
buildSQLStmt() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Build the metadata search SQL statement based on the data in this search definition.
buildSQLStmtFromCommonCriteria() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Build the metadata search SQL statement using the where clause for common criteria.
BulkItemResult - Interface in com.ibm.jarm.api.core
Represents the success or failure status for an individual entity that is a member of a BulkOperation process.
BulkOperation - Class in com.ibm.jarm.api.core
A class of static bulk operation methods that can apply to one or more entities in a single method call.
BulkOperation.EntityDescription - Class in com.ibm.jarm.api.core
Data structure class used to identify an entity that is a member of a particular bulk operation.
BulkOperation.EntityDescription(EntityType, String) - Constructor for class com.ibm.jarm.api.core.BulkOperation.EntityDescription
Constructor.

C

CalendarDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
canBeUpdated() - Method in interface com.ibm.jarm.api.core.SystemConfiguration
Indicates whether or not this SystemConfiguration instance can be updated using the FilePlanRepository.putSystemConfiguration(String, String) method.
canContain(EntityType) - Method in interface com.ibm.jarm.api.core.Container
Indicates whether or not this Container is allowed to contain a child object of the specified EntityType.
canContainDefensibleDisposalContainer() - Method in interface com.ibm.jarm.api.core.DefensiblyDisposableContainerParent
Indicates whether or not this container is eligible to be the parent of a "Defensibly Disposable" child container.
CanDeclare - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
canIncludeDescendentPropertiesInQuery() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Indicates whether or not this class supports queries that include descendant properties.
canIncludeSubclassesInQuery() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Indicates whether or not this class supports queries that include its subclasses.
CarbonCopy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CBRPageIterator<T> - Interface in com.ibm.jarm.api.collection
A parameterized paging, read-only iterator interface for Content Based Retrieval (CBR) results.
CBRResult - Interface in com.ibm.jarm.api.query
A CBRResult instance represents a single result from a content-based retrieval (CBR) RMSearch.contentBasedRetrieval search operation.
ChoiceItemType - Enum in com.ibm.jarm.api.constants
Enumeration of type values for a RMChoiceItem belonging to a RMChoiceList.
ChoiceList - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Pseudo class name for choice list.
ckInvalidStrParam(String, String) - Static method in class com.ibm.jarm.api.util.Util
Verifies that the given String parameter is not null, is not an empty String and is not a String containing only spaces.
ckNullObjParam(String, Object) - Static method in class com.ibm.jarm.api.util.Util
Verifies that the given object parameter is not null.
ckNullOrInvalidArrayParam(String, Object[]) - Static method in class com.ibm.jarm.api.util.Util
Verifies that the given object array parameter is neither null nor empty and contains no null members.
ckNullOrInvalidCollectionParam(String, Collection<? extends Object>) - Static method in class com.ibm.jarm.api.util.Util
Verifies that the given collection parameter is neither null nor empty and contains no null members.
ClassificationGuide - Static variable in interface com.ibm.jarm.api.constants.RMClassName
DoD Security Classification Guide class.
ClassificationGuide - Interface in com.ibm.jarm.api.core
Represents a Department of Defense (DoD) Security Classification Guide.
ClassificationGuideSection - Static variable in interface com.ibm.jarm.api.constants.RMClassName
DoD Security Classification Guide Section class.
ClassificationGuideSection - Interface in com.ibm.jarm.api.core
Represents a section belonging to a DoD Security Classification Guide.
ClassificationGuideTopic - Static variable in interface com.ibm.jarm.api.constants.RMClassName
DoD Security Classification Guide Topic class.
ClassificationGuideTopic - Interface in com.ibm.jarm.api.core
Represents a guide topic belonging to a DoD Security Classification Guide.
ClassifiedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ClassifyingAgency - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ClassName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
clearDispositionAssignment(SchedulePropagation) - Method in interface com.ibm.jarm.api.core.DispositionAllocatable
Remove any existing DispositionSchedule assignment from this entity.
clone() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
This is to override the clone() method to clone another RMContentSearchDefinition object.
close(String) - Method in interface com.ibm.jarm.api.core.RecordContainer
Closes this RecordContainer.
closeContainers(FilePlanRepository, List<String>, String) - Static method in class com.ibm.jarm.api.core.BulkOperation
Performs a close operation on each of the specified RecordCategory, RecordFolder and/or RecordVolume entities.
ClosedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Code - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
com.ibm.jarm.api.collection - package com.ibm.jarm.api.collection
This package contains the interfaces and classes that support paged access to large collections.
com.ibm.jarm.api.constants - package com.ibm.jarm.api.constants
This package contains various constant and enumerated type definitions.
com.ibm.jarm.api.core - package com.ibm.jarm.api.core
This package contains the primary public interface and class definitions for the various entities that make up the API.
com.ibm.jarm.api.exception - package com.ibm.jarm.api.exception
This package contains exception and error-related types for the API.
com.ibm.jarm.api.meta - package com.ibm.jarm.api.meta
This package contains types that support retrieval of meta data from a repository.
com.ibm.jarm.api.property - package com.ibm.jarm.api.property
This package contains types that support property collections and individual properties.
com.ibm.jarm.api.query - package com.ibm.jarm.api.query
This package contains those types related to searches and their results.
com.ibm.jarm.api.security - package com.ibm.jarm.api.security
This package contains those types related to object access security and functional role-based security.
com.ibm.jarm.api.util - package com.ibm.jarm.api.util
This package contains miscellaneous utility classes common to other parts of the API.
COMMON_ENTITY_TYPE - Static variable in interface com.ibm.jarm.api.core.ReportDefinition
 
completePhaseExecution(Date, boolean) - Method in interface com.ibm.jarm.api.core.Dispositionable
Attempts to complete the currently executing phase for this entity.
ConditionXML - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ConnectorRegistration - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Connector Registration class.
ConnectorRegistration - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Container - Interface in com.ibm.jarm.api.core
The base interface for all IBM Enterprise Records-related containers.
Containers - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ContainerType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
contains(AlternateRetention) - Method in interface com.ibm.jarm.api.core.AlternateRetentionList
Indicates whether or not the specified AlternateRetention instance is contained in this collection.
contains(DispositionPhase) - Method in interface com.ibm.jarm.api.core.DispositionPhaseList
Indicates whether or not the specified DispositionPhase instance is contained in this collection.
contentBasedRetrieval(RMContentSearchDefinition, Integer, Boolean) - Method in class com.ibm.jarm.api.query.RMSearch
Performs a content-based retrieval of a record management system where the source documents with content are typically stored in content repositories and the associated records are declared in a file plan repository.
ContentItem - Interface in com.ibm.jarm.api.core
An interface that represents a content containing entity (e.g., a P8 Content Engine document).
ContentRepository - Interface in com.ibm.jarm.api.core
An interface that represents a content repository whose ContentItem instances might be eligible for record declaration.
ContentXMLExport - Enum in com.ibm.jarm.api.constants
Enumeration of options which control how document content that is associated with a record is exported during P8CE_XML Export operations.
convertToDefensiblyDisposable(String, int, int, int, boolean) - Method in interface com.ibm.jarm.api.core.DefensiblyDisposable
Converts this container into a "Defensibly Disposable" type based upon the specified trigger and retention information.
copy(RecordContainer, RMProperties) - Method in interface com.ibm.jarm.api.core.Record
Creates a new copy of this record and files it into the specified destination RecordContainer.
copyRecords(FilePlanRepository, List<String>, String, String) - Static method in class com.ibm.jarm.api.core.BulkOperation
Creates a copy of each of the specified Record entities in the common specified destination RecordContainer.
createAlternateRetention() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Creates a new AlternateRetention instance that can be further defined and then added to an AlternateRetentionList belonging to a specific DispositionPhase.
createAlternateRetention(String) - Method in interface com.ibm.jarm.api.core.DispositionPhase
Creates a new AlternateRetention instance that can be further defined and then added to an AlternateRetentionList belonging to a specific DispositionPhase.
createIERWorkflowException(RMErrorCode, Object...) - Static method in exception com.ibm.jarm.api.exception.IERWorkflowException
Creates a new IERWorkflowException instance.
createIERWorkflowException(RMErrorCode, RMErrorStack, Object...) - Static method in exception com.ibm.jarm.api.exception.IERWorkflowException
Creates a new IERWorkflowException instance.
createIERWorkflowException(Throwable, RMErrorCode, Object...) - Static method in exception com.ibm.jarm.api.exception.IERWorkflowException
Creates a new IERWorkflowException instance.
createIERWorkflowException(Throwable, RMErrorCode, RMErrorStack, Object...) - Static method in exception com.ibm.jarm.api.exception.IERWorkflowException
Creates a new IERWorkflowException instance.
createInstance(FilePlanRepository, DispositionActionType) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionAction
Creates a DispositionAction instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository, DispositionActionType, String) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionAction
Creates a DispositionAction instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionSchedule
Creates a DispositionSchedule instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionSchedule
Creates a DispositionSchedule instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository, DispositionTriggerType) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionTrigger
Creates a DispositionTrigger instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository, DispositionTriggerType, String) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionTrigger
Creates a DispositionTrigger instance that is associated with the given FilePlanRepository.
createInstance(DomainType, String, Map<String, Object>) - Static method in class com.ibm.jarm.api.core.RMFactory.DomainConnection
Returns an instance of DomainConnection.
createInstance(FilePlanRepository) - Static method in class com.ibm.jarm.api.core.RMFactory.Hold
Creates a Hold instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.Hold
Creates a Hold instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository) - Static method in class com.ibm.jarm.api.core.RMFactory.Location
Creates a Location instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.Location
Creates a Location instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository) - Static method in class com.ibm.jarm.api.core.RMFactory.NamingPattern
Creates a NamingPattern instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.NamingPattern
Creates a NamingPattern instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository) - Static method in class com.ibm.jarm.api.core.RMFactory.NamingPatternSequence
Creates a NamingPatternSequence instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.NamingPatternSequence
Creates a NamingPatternSequence instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository) - Static method in class com.ibm.jarm.api.core.RMFactory.RecordType
Creates a RecordType instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.RecordType
Creates a RecordType instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository) - Static method in class com.ibm.jarm.api.core.RMFactory.ReportDefinition
Creates a ReportDefinition instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.ReportDefinition
Creates a ReportDefinition instance that is associated with the given FilePlanRepository.
createInstance(FilePlanRepository) - Static method in class com.ibm.jarm.api.core.RMFactory.RMCustomObject
Creates a RMCustomObject instance that is associated with the given Repository.
createInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.RMCustomObject
Creates a RMCustomObject instance that is associated with the given Repository.
createInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.RMLink
Creates an instance of a RMLink ready for saving.
createInstance(DomainType) - Static method in class com.ibm.jarm.api.core.RMFactory.RMPermission
Returns a new RMPermission instance.
createInstance(DomainType) - Static method in class com.ibm.jarm.api.core.RMFactory.RMProperties
Returns a new, empty RMProperties collection.
createInstance(RMDomain) - Static method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Create an instance of concrete class that extends this abstract class based on the specified RMDomain.
createNamingPatternLevel() - Method in interface com.ibm.jarm.api.core.NamingPattern
Creates a new NamingPatternLevel instance that can be further defined and then persisted to the repository using its base class save method.
createNamingPatternLevel(String) - Method in interface com.ibm.jarm.api.core.NamingPattern
Creates a new NamingPatternLevel instance that can be further defined and then persisted to the repository using its base class save method.
createNewPhase(String) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Creates a new DispositionPhase instance that can be further defined and then added to a DispositionPhaseList.
createNewPhase(String, String) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Creates a new DispositionPhase instance that can be further defined and then added to a DispositionPhaseList.
createRMRuntimeException(RMErrorCode, Object...) - Static method in exception com.ibm.jarm.api.exception.RMRuntimeException
Creates a new RMRuntimeException instance.
createRMRuntimeException(RMErrorCode, RMErrorStack, Object...) - Static method in exception com.ibm.jarm.api.exception.RMRuntimeException
Creates a new RMRuntimeException instance.
createRMRuntimeException(Throwable, RMErrorCode, Object...) - Static method in exception com.ibm.jarm.api.exception.RMRuntimeException
Creates a new RMRuntimeException instance.
createRMRuntimeException(Throwable, RMErrorCode, RMErrorStack, Object...) - Static method in exception com.ibm.jarm.api.exception.RMRuntimeException
Creates a new RMRuntimeException instance.
createSubject(DomainConnection, String, String, String) - Static method in class com.ibm.jarm.api.util.RMUserContext
Performs standard JAAS authentication and returns a JAAS javax.security.auth.Subject instance.
CreationAuditEvent - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Creation audit event class.
CurrentActionType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CurrentClassification - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CurrentPhaseAction - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CurrentPhaseDecisionDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CurrentPhaseExecutionDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CurrentPhaseExecutionStatus - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CurrentPhaseExportDestination - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CurrentPhaseExportFormat - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CurrentPhaseID - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CurrentPhaseReviewComments - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CurrentPhaseReviewDecision - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CutoffAction - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CutoffBase - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CutoffDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CutoffDispositionTrigger - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CutoffInheritedFrom - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CutoffOffsetDays - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CutoffOffsetMonths - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CutoffOffsetYears - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CycleDays - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CycleMonths - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
CycleYears - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 

D

DataModelType - Enum in com.ibm.jarm.api.constants
Enumerated data model types.
DataType - Enum in com.ibm.jarm.api.constants
Enumeration of supported data types for describing values of RMProperty and RMPropertyDescription instances.
DataType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DateClosed - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DateDeclared - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DateIssued - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DateLastModified - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DateOpened - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DateTime - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
dbgOutput(String, Object...) - Static method in class com.ibm.jarm.api.util.Util
FOR DEVELOPMENT USE ONLY!
declare(String, RMProperties, List<RMPermission>, List<RecordContainer>) - Method in interface com.ibm.jarm.api.core.RecordContainer
Creates a new Record based upon the specified record class and files it into this RecordContainer.
declare(String, RMProperties, List<RMPermission>, List<RecordContainer>, List<ContentItem>) - Method in interface com.ibm.jarm.api.core.RecordContainer
Creates a new Record based upon the specified record class and files it into this RecordContainer.
declare(String, RMProperties, List<RMPermission>, List<RecordContainer>, ContentRepository, List<String>) - Method in interface com.ibm.jarm.api.core.RecordContainer
Creates a new Record based upon the specified record class and files it into this RecordContainer.
DeclassifiedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DeclassifiedOn - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DeclassifyOnDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DeclassifyOnEvents - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Default - Static variable in interface com.ibm.jarm.api.constants.RMPreventDelete
Indicates that no delete prevention is in effect.
DefaultValue - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DefensiblyDisposable - Interface in com.ibm.jarm.api.core
Represents a container that may be eligible to support "Defensibly Disposable" business processes.
DefensiblyDisposableContainerParent - Interface in com.ibm.jarm.api.core
Represents a parent container that may be eligible of containing a "Defensibly Disposable" child container.
delete(FilePlanRepository, List<BulkOperation.EntityDescription>) - Static method in class com.ibm.jarm.api.core.BulkOperation
Performs deletion of each of the specified RecordCategory, RecordFolder, RecordVolume and/or Record entities.
delete(boolean, DeleteMode, String) - Method in interface com.ibm.jarm.api.core.Container
Deletes the container from its associated repository.
delete() - Method in interface com.ibm.jarm.api.core.ContentItem
Deletes this content item, including all content elements and metadata, from the repository.
delete() - Method in interface com.ibm.jarm.api.core.FilePlan
Deletes this file plan entity.
delete(boolean, DeleteMode, String) - Method in interface com.ibm.jarm.api.core.Record
Deletes the record from its associated repository including any associated content.
delete() - Method in interface com.ibm.jarm.api.core.RMCustomObject
Deletes this custom object from the repository.
delete() - Method in interface com.ibm.jarm.api.core.RMLink
Deletes this RMLink instance from the repository.
delete() - Method in interface com.ibm.jarm.api.security.RMRole
Deletes this RMRole from the repository.
deleteAllVersions() - Method in interface com.ibm.jarm.api.core.ContentItem
Deletes all members of the version series that this content item belongs to.
DeleteMode - Enum in com.ibm.jarm.api.constants
Enumerated values that control the "type" of deletion to take place as part of an entity delete method call.
DeletionAuditEvent - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Deletion audit event class.
DerivedFrom - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
describedIsOfClass(String) - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Indicates whether or not the class described by this RMClassDescription instance is a subclass of the specified parent class.
Description - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DescriptiveText - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
destroy() - Method in interface com.ibm.jarm.api.core.Dispositionable
Performs destruction of the associated entity and any hierarchical children.
destroy(boolean) - Method in interface com.ibm.jarm.api.core.Dispositionable
Performs destruction of the associated entity and any hierarchical children.
Diagnostic - Interface in com.ibm.jarm.api.exception
Represents diagnostic information about a specific RMErrorRecord.
DigitalPhotographRecord - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Digital Photograph Record class.
DisplayName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DisposalAuthorizedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DisposalInstruction - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DisposalPhase - Static variable in interface com.ibm.jarm.api.constants.RMClassName
DisposalPhase class (no longer used).
Dispositionable - Interface in com.ibm.jarm.api.core
An interface for any entity that is affected by the operation of a disposition schedule and/or vital review processing.
DispositionAction - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Disposition Action class.
DispositionAction - Interface in com.ibm.jarm.api.core
An interface that represents a disposition-related "Action1" custom object that is typically associated with a DispositionSchedule and its child DispositionPhase instances.
DispositionActionType - Enum in com.ibm.jarm.api.constants
Enumerated values representing allowable disposition action types.
DispositionAllocatable - Interface in com.ibm.jarm.api.core
Represents an entity that is capable of having a Disposition Schedule assigned to it.
DispositionAuthority - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DispositionInstruction - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DispositionPhase - Interface in com.ibm.jarm.api.core
An interface that represents a "Phase" custom object that acts as a phase member of a DispositionSchedule.
DispositionPhaseException - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Disposition Phase Exception class.
DispositionPhaseList - Interface in com.ibm.jarm.api.core
Represents an ordered collection of DispositionPhase instances defined for a single DispositionSchedule.
DispositionPhases - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DispositionSchedule - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Disposition Schedule class.
DispositionSchedule - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DispositionSchedule - Interface in com.ibm.jarm.api.core
An interface that represents a "DisposalSchedule" custom object.
DispositionScheduleAllocationDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DispositionScheduleInheritedFrom - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DispositionScheduleName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DispositionTrigger - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Disposition Trigger class.
DispositionTrigger - Interface in com.ibm.jarm.api.core
An interface that represents a disposition-related "DisposalTrigger" custom object.
DispositionTriggerName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DispositionTriggerType - Enum in com.ibm.jarm.api.constants
Enumeration of supported Disposition Trigger Types
DistinguishedName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Document - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Base Document class.
DocumentTitle - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DocURI - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DomainConnection - Interface in com.ibm.jarm.api.core
Represents all of the connection information needed for a particular domain (for example, P8 Content Engine, ECM Content Manager 8, and so on).
DomainType - Enum in com.ibm.jarm.api.constants
Enumeration of supported domain types.
DowngradedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DowngradedOn - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DowngradeInstructions - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DowngradeOnDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DowngradeOnEvents - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
DowngradeRemarks - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 

E

EffectiveDateModified - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ElectronicRecord - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Electronic Record class.
ElectronicRecordFolder - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Electronic Record Folder folder class.
EmailName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
EmailRecord - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Email Record class.
EmailSubject - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
EnableRecordMultiFile - Static variable in interface com.ibm.jarm.api.core.SystemConfiguration
 
EntityType - Enum in com.ibm.jarm.api.constants
Enumerated values for the various entity types supported by this API.
error(RMLogCode, Object...) - Method in class com.ibm.jarm.api.util.JarmLogger
Logs a message with the ERROR level.
error(RMLogCode, Throwable, Object...) - Method in class com.ibm.jarm.api.util.JarmLogger
Logs a message with the ERROR level including the stack trace of the included Throwable t parameter.
EventStatus - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
EventType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
executeInterimTransferUsingExternalExport(Location, ExternalExport, boolean) - Method in interface com.ibm.jarm.api.core.Dispositionable
The entity and all it its hierarchical children are exported using the given external export interface instance and then all electronic content is then deleted from the record manager repositories.
executeInterimTransferUsingP8_XML(Location) - Method in interface com.ibm.jarm.api.core.Dispositionable
The metadata and content associated with this entity and all of it hierarchical children are exported as XML files to the local file system and then all electronic content is then deleted from the record manager repositories.
executeVital() - Method in interface com.ibm.jarm.api.core.Vitalable
Calculates the vital review dates and sets the vital review metadata of this object.
Exemptions - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
export(String, String) - Method in interface com.ibm.jarm.api.core.ExternalExport
Perform export of specified entity found on specified object store.
exportAsXML(String, ContentXMLExport) - Method in interface com.ibm.jarm.api.core.ContentItem
Exports the metadata and content data of this content entity as XML file(s) in the local file system.
ExportConfiguration - Static variable in interface com.ibm.jarm.api.core.SystemConfiguration
 
ExportDestination - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ExportFormat - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ExportTransferMapping - Static variable in interface com.ibm.jarm.api.core.SystemConfiguration
 
exportUsingExternalExport(ExternalExport, boolean) - Method in interface com.ibm.jarm.api.core.Dispositionable
Exports the metadata and any content of this entity and of its hierarchical children Using the provided external export mechanism.
exportUsingP8_XML() - Method in interface com.ibm.jarm.api.core.Dispositionable
Exports the metadata and any content of this entity and of its hierarchical children as external XML files based on the legacy P8 Content Engine-3.x export XML schema.
exportUsingP8_XML(String, String, ContentXMLExport) - Method in interface com.ibm.jarm.api.core.Record
Exports the metadata and any associated content of this entity as external XML file(s) based upon the legacy P8 Content Engine-3.x export XML schema.
exportUsingP8_XML(String, String, ContentXMLExport) - Method in interface com.ibm.jarm.api.core.RecordContainer
Exports the metadata and any content of this entity and of its hierarchical children as external XML file(s) based upon the legacy P8 Content Engine-3.x export XML schema.
ExternalEventOccurrenceDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ExternalExport - Interface in com.ibm.jarm.api.core
Interface used by one version of disposition interim transfer to hook into the IER WFL Component's integration with RMTransferAPI.
ExternallyManagedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ExternalManagementAgent - Interface in com.ibm.jarm.api.constants
String constant definitions of supported values for the RMExternallyManagedBy property value.
ExtractLink - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Extract Link class.

F

fetchChoiceLists() - Method in interface com.ibm.jarm.api.core.Repository
Fetches the collection of choice lists defined on this repository.
fetchClassDescriptions(String[]) - Method in interface com.ibm.jarm.api.core.Repository
Fetches the collection of specified class descriptions defined on this repository.
fetchCombinedRepositories(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.RMDomain
Returns a collection of Repository instances belonging to this domain that have both FPOS and ROS data models installed on it.
fetchContentRepositories(boolean, RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.RMDomain
Returns a collection of ContentRepository instances belonging to this domain.
fetchCurrentUser() - Method in interface com.ibm.jarm.api.core.RMDomain
Returns the current user of the current thread on which this method is called.
fetchFilePlanRepositories(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.RMDomain
Returns a collection of FilePlanRepository instances belonging to this domain.
fetchInstance(Repository, EntityType, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.BaseEntity
Retrieves a generalized BaseEntity from a repository.
fetchInstance(Repository, String, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.BaseEntity
Retrieves a generalized BaseEntity from a repository.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.ClassificationGuide
Retrieves the specified DoD Security Classification Guide from the specified file plan repository.
fetchInstance(FilePlanRepository, EntityType, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.Container
Retrieves a generic Container from a repository.
fetchInstance(Repository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.ContentItem
Retrieves a ContentItem from a repository.
fetchInstance(RMDomain, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.ContentRepository
Retrieves a specific ContentRepository from the specified domain.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionAction
Retrieves a DispositionAction from a file plan repository.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionSchedule
Retrieves a DispositionSchedule from a file plan repository.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionTrigger
Retrieves a DispositionTrigger from a file plan repository.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.FilePlan
Retrieves a specific FilePlan from a file plan repository.
fetchInstance(RMDomain, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.FilePlanRepository
Retrieves a specific FilePlanRepository from the specified domain.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.Hold
Retrieves a specific Hold from the specified file plan repository.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.Location
Retrieves a Location from a file plan repository.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.NamingPattern
Retrieves a specific NamingPattern from the specified domain.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.NamingPatternSequence
Retrieves a specific NamingPatternSequence from the specified domain.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.Record
Retrieves a Record from a file plan repository.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.RecordCategory
Retrieves a RecordCategory from a file plan repository.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.RecordFolder
Retrieves a RecordFolder from a file plan repository.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.RecordType
Retrieves a RecordType from a file plan repository.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.RecordVolume
Retrieves a RecordVolume from a file plan repository.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.ReportDefinition
Retrieves a ReportDefinition from a file plan repository.
fetchInstance(RMDomain, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.Repository
Retrieves a specific Repository from the specified domain.
fetchInstance(Repository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.RMChoiceList
Retrieves a RMChoiceList instance from a repository.
fetchInstance(Repository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.RMClassDescription
Retrieves a RMClassDescription instance from a repository.
fetchInstance(Repository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.RMCustomObject
Retrieves a RMCustomObject from a repository.
fetchInstance(Repository, EntityType, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.RMCustomObject
Retrieves a RMCustomObject from a repository.
fetchInstance(DomainConnection, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.RMDomain
Retrieves a specific RMDomain instance.
fetchInstance(DomainConnection, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.RMGroup
Retrieves a specific RMGroup instance.
fetchInstance(FilePlanRepository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.RMLink
Retrieves a RMLink from a file plan repository.
fetchInstance(RMDomain, String) - Static method in class com.ibm.jarm.api.core.RMFactory.RMMarkingSet
Retrieves a RMMarkingSet instance from a domain.
fetchInstance(DomainConnection, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.RMUser
Retrieves a specific RMUser instance.
fetchInstance(Repository, String, RMPropertyFilter) - Static method in class com.ibm.jarm.api.core.RMFactory.WorkflowDefinition
Retrieves a RMWorkflowDefinition from a repository.
fetchMarkingSets() - Method in interface com.ibm.jarm.api.core.RMDomain
Returns a collection of RMMarkingSet instances belonging to this domain.
fetchObjects(String, EntityType, Integer, RMPropertyFilter, Boolean) - Method in class com.ibm.jarm.api.query.RMSearch
Performs a search query and returns results as a homogeneous collection of BaseEntity subclass instances as defined by the entityType parameter.
fetchRecordCategories(RMPropertyFilter, Integer) - Method in interface com.ibm.jarm.api.core.RecordCategoryContainer
Returns a pageable collection of all RecordCategory instances that are immediate children of this container.
fetchRecordFolders(RMPropertyFilter, Integer) - Method in interface com.ibm.jarm.api.core.RecordFolderContainer
Returns a pageable collection of all RecordFolder instances that are immediate children of this container.
fetchRecordVolumes(RMPropertyFilter, Integer) - Method in interface com.ibm.jarm.api.core.RecordVolumeContainer
Returns a pageable collection of RecordVolume instances that are immediate children of this container.
fetchRMRoles(Repository, String) - Method in interface com.ibm.jarm.api.core.RMDomain
Retrieves a RMRoles collection containing RMRole instances that are defined upon the specified Repository.
fetchRows(String, Integer, RMPropertyFilter, Boolean) - Method in class com.ibm.jarm.api.query.RMSearch
Performs a search query and returns results as a collection of ResultRow.
FilePlan - Static variable in interface com.ibm.jarm.api.constants.RMClassName
File Plan folder class.
FilePlan - Interface in com.ibm.jarm.api.core
This interface represents the top level file plan container.
FilePlanName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
FilePlanRepository - Interface in com.ibm.jarm.api.core
An interface that represents a file plan repository.
FilePlanRoot - Static variable in interface com.ibm.jarm.api.constants.RMClassName
File Plan root folder class.
fileRecord(Record) - Method in interface com.ibm.jarm.api.core.RecordContainer
Files the specified Record into this RecordContainer.
fileRecord(String) - Method in interface com.ibm.jarm.api.core.RecordContainer
Files the specified Record into this RecordContainer.
fileRecords(FilePlanRepository, List<String>, String) - Static method in class com.ibm.jarm.api.core.BulkOperation
Files each of the specified Record entities into the common specified destination RecordContainer.
findGroups(String, RMPrincipalSearchType, RMPrincipalSearchAttribute, RMPrincipalSearchSortType, Integer) - Method in interface com.ibm.jarm.api.core.RMDomain
Returns a collection of RMGroup instances belonging to this domain based upon the search criteria.
findUsers(String, RMPrincipalSearchType, RMPrincipalSearchAttribute, RMPrincipalSearchSortType, Integer) - Method in interface com.ibm.jarm.api.core.RMDomain
Returns a collection of RMUser instances belonging to this domain based upon the search criteria.
FolderName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Format - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
format(String, Object...) - Static method in class com.ibm.jarm.api.util.RMLString
Uses java.text.MessageFormat to generate a formatted String based upon the localized pattern String defined by the key parameter.
format(String, String, Object...) - Static method in class com.ibm.jarm.api.util.RMLString
Uses java.text.MessageFormat to generate a formatted String based upon the localized pattern String defined by the key parameter.
formatDate(Date) - Static method in exception com.ibm.jarm.api.exception.RMRuntimeException
Helper method to format a java.util.Date value as a String for use within an exception message.
FPOS_Setup - Static variable in interface com.ibm.jarm.api.core.SystemConfiguration
 
From - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
fromJARM(DomainConnection) - Static method in class com.ibm.jarm.api.util.P8CE_Convert
Converts a JARM DomainConnection instance into a P8CE com.filenet.api.core.Connection instance, if possible.
fromJARM(RMDomain) - Static method in class com.ibm.jarm.api.util.P8CE_Convert
Converts a JARM RMDomain instance into a P8CE com.filenet.api.core.Domain instance, if possible.
fromJARM(Repository) - Static method in class com.ibm.jarm.api.util.P8CE_Convert
Converts a JARM Repository instance into a P8CE com.filenet.api.core.ObjectStore instance, if possible.
fromJARM(Container) - Static method in class com.ibm.jarm.api.util.P8CE_Convert
Converts a JARM Container instance into a JACE com.filenet.api.core.Folder instance.
fromJARM(ContentItem) - Static method in class com.ibm.jarm.api.util.P8CE_Convert
Converts a JARM ContentItem instance into a JACE com.filenet.api.core.Document instance.
fromP8CE(Connection) - Static method in class com.ibm.jarm.api.util.P8CE_Convert
Converts a P8 Content Engine com.filenet.api.core.Connection instance into a JARM DomainConnection instance.
fromP8CE(Domain) - Static method in class com.ibm.jarm.api.util.P8CE_Convert
Converts a P8CE com.filenet.api.core.Domain instance into a JARM RMDomain instance.
fromP8CE(ObjectStore) - Static method in class com.ibm.jarm.api.util.P8CE_Convert
Converts a P8CE com.filenet.api.core.ObjectStore instance into a JARM Repository instance.
fromP8CE(Folder) - Static method in class com.ibm.jarm.api.util.P8CE_Convert
Converts a P8CE com.filenet.api.core.Folder instance into a JARM Container (or subclass thereof) instance.
fromP8CE(Document) - Static method in class com.ibm.jarm.api.util.P8CE_Convert
Converts a P8CE com.filenet.api.core.Document instance into a JARM ContentItem instance.

G

generateCategoryNameFromPattern(Container) - Static method in class com.ibm.jarm.api.util.NamingUtils
This procedure generates the name for a record category based on the naming pattern specified.
generateFolderNameFromPattern(RecordContainer) - Static method in class com.ibm.jarm.api.util.NamingUtils
This procedure generates the name for a record folder based on the naming pattern specified.
generateNextVolumeName(RecordVolumeContainer) - Static method in class com.ibm.jarm.api.util.NamingUtils
This procedure generates the next name for a record volume based on the parent container specified.
generateRecordNameFromPattern(Container) - Static method in class com.ibm.jarm.api.util.NamingUtils
This procedure generates the name for a record based on the naming pattern specified.
get(int) - Method in interface com.ibm.jarm.api.core.AlternateRetentionList
Returns the AlternateRetention instance at the given 1-based ordinal position.
get(int) - Method in interface com.ibm.jarm.api.core.DispositionPhaseList
Returns the DispositionPhase instance at the given 1-based ordinal position.
get(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Returns the RMProperty as specified by its symbolic name string.
get(String) - Static method in class com.ibm.jarm.api.util.RMLString
Retrieves the localized string defined by the key parameter using the Locale.getDefault() value.
get(String, String) - Static method in class com.ibm.jarm.api.util.RMLString
Retrieves the localized string defined by the key parameter using the Locale.getDefault() value.
get() - Static method in class com.ibm.jarm.api.util.RMUserContext
Returns the RMUserContext instance that is associated with the current thread.
getAccessAllowed() - Method in interface com.ibm.jarm.api.core.BaseEntity
Returns a value representing a bit mask of access rights granted to the current user for this object.
getAccessMask() - Method in interface com.ibm.jarm.api.security.RMPermission
Returns the integer bit mask defining the rights associated with this RMPermission.
getAccessType() - Method in interface com.ibm.jarm.api.security.RMPermission
Returns the RMAccessType of this RMPermission.
getAction() - Method in interface com.ibm.jarm.api.exception.MessageInfo
Returns any available localized user action text.
getActionName() - Method in interface com.ibm.jarm.api.core.DispositionAction
Returns the ActionName property value assigned to this disposition action.
getActionType() - Method in interface com.ibm.jarm.api.core.DispositionAction
Returns the DispositionActionType for this disposition action.
getActiveRecordVolume() - Method in interface com.ibm.jarm.api.core.RecordVolumeContainer
Returns the current "active" child RecordVolume belonging to this container.
getAggregation() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns a string describing the entity-type level to which this disposition trigger applies.
getAllDescendentPropertyDescriptions() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns a collection of all RMPropertyDescription instances that belong to all subclasses of this class.
getAllowedContaineeTypes() - Method in interface com.ibm.jarm.api.core.Container
Returns an array of EntityType instances that represent the types of child objects allowed to be contained by this Container.
getAlternateRetentions() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Returns the collection of any AlternateRetention instances, if any, that are associated with this disposition phase.
getApplicationName() - Method in interface com.ibm.jarm.api.security.RMRole
Returns the ApplicationName property value.
getApplicationName() - Method in interface com.ibm.jarm.api.security.RMRoles
Returns the application name String, if any, that was originally used to fetch this RMRoles collection; see RMDomain.fetchRMRoles(Repository, String).
getAppliedFor() - Method in interface com.ibm.jarm.api.core.NamingPatternLevel
Returns the AppliedFor property value.
getApplyToNameOrId() - Method in interface com.ibm.jarm.api.core.NamingPattern
Returns the ApplyToNameOrId property value.
getApprovedBy() - Method in interface com.ibm.jarm.api.core.ClassificationGuide
The authority who approved this classification guide.
getAssignedSchedule() - Method in interface com.ibm.jarm.api.core.DispositionAllocatable
Retrieves the current DispositionSchedule assigned to this entity.
getAssociatedContainers(Integer) - Method in interface com.ibm.jarm.api.core.Hold
Returns a collection of Container instances that are associated with this hold.
getAssociatedContentItems() - Method in interface com.ibm.jarm.api.core.Record
Returns the collection of ContentItem instances associated with this record.
getAssociatedContentRepositories() - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a collection of ContentRepository instances each of which has had at least one ContentItem declared as a Record which resides in this file plan repository.
getAssociatedDispositionSchedules() - Method in interface com.ibm.jarm.api.core.DispositionAction
Returns all DispositionSchedule instances that are associated with this disposition action.
getAssociatedDispositionSchedules() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns a collection of DispositionSchedule instances where this DispositionTrigger is currently associated.
getAssociatedEntityTypes() - Method in interface com.ibm.jarm.api.core.ReportDefinition
Returns the 'entity types' that are associated with the report definition query.
getAssociatedHolds() - Method in interface com.ibm.jarm.api.core.Holdable
Gets the collection of holds that are directly associated with this object.
getAssociatedRecord() - Method in interface com.ibm.jarm.api.core.ContentItem
Returns the Record instance, if any, that this content entity is associated with due to a previous record declaration operation.
getAssociatedRecordCategories() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns a collection of RecordCategory instances to which this DispositionSchedule instance is directly associated.
getAssociatedRecordFolders() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns a collection of RecordFolder instances to which this DispositionSchedule instance is directly associated.
getAssociatedRecords(Integer) - Method in interface com.ibm.jarm.api.core.Hold
Returns a collection of Record instances that are associated with this hold.
getAssociatedRecords() - Method in interface com.ibm.jarm.api.core.RecordType
Returns a collection of Record instances that are associated with this RecordType.
getAssociatedRecordType() - Method in interface com.ibm.jarm.api.core.Record
Returns an instance of RecordType associated with this record, if any.
getAssociatedRecordTypes() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns a collection of RecordType instances to which this DispositionSchedule instance is directly associated.
getAssociatedSchedule() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Returns the DispositionSchedule with which this disposition phase is associated.
getAssociatedWorkflow() - Method in interface com.ibm.jarm.api.core.DispositionAction
Returns the workflow definition associated with this disposition action.
getAuditActionType() - Method in interface com.ibm.jarm.api.core.AuditEvent
Returns the AuditActionType property value.
getAuditedEvents(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.AuditableEntity
Retrieves all audit events associated with the entity.
getAuditXML() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the SweepAuditXML property value of this disposition schedule.
getAuthenticatedUsersDesignation() - Method in interface com.ibm.jarm.api.security.RMPermission
If supported by a particular domain type, returns the special logical group name that refers to all authenticated users.
getAvailValue(String) - Method in class com.ibm.jarm.api.query.ReportParameter
Returns the parameter value associated with the given identifier.
getAvailValueIds() - Method in class com.ibm.jarm.api.query.ReportParameter
Returns a collection of String identifiers representing key values to this parameter's value map.
getAvailValueLocalizationKey(String) - Method in class com.ibm.jarm.api.query.ReportParameter
Returns a localization key for the specified parameter value.
getBarcode() - Method in interface com.ibm.jarm.api.core.Location
Returns the BarcodeID property value.
getBinaryContentRetrievalName() - Method in interface com.ibm.jarm.api.core.RMContentElement
Typically provides a file system path string representing a binary content element's original location, if available.
getBinaryContentSize() - Method in interface com.ibm.jarm.api.core.RMContentElement
Returns the size of binary content data, in bytes, if available.
getBinaryContentStream() - Method in interface com.ibm.jarm.api.core.RMContentElement
Provides an InputStream to the binary data for a binary content element.
getBinaryDefaultValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionBinary
Indicates the default value, if any, for a DataType.Binary property that is based on this property description.
getBinaryListValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its multi-valued, DataType.Binary value.
getBinaryListValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Binary and cardinality multi-valued.
getBinaryMaximumLength() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionBinary
Indicates the maximum allowed length, if any, in bytes, of the value for a DataType.Binary property that is based on this property description.
getBinarySelectionsList() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionBinary
Specifies a collection of byte[] instances that can be assigned to the value of a property that is based on this property description.
getBinaryValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its single-valued, DataType.Binary value.
getBinaryValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Binary and cardinality single-valued.
getBooleanDefaultValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionBoolean
Indicates the default value, if any, for a DataType.Boolean property that is based on this property description.
getBooleanListValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its multi-valued, DataType.Boolean value.
getBooleanListValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Boolean and cardinality multi-valued.
getBooleanSelectionsList() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionBoolean
Specifies a collection of Boolean instances that can be assigned to the value of a property that is based on this property description.
getBooleanValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its single-valued, DataType.Boolean value.
getBooleanValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Boolean and cardinality single-valued.
getCalendarDate() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the CalendarDate property value of this disposition schedule.
getCardinality() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
The RMCardinality of the property value of a property that is based on this property description.
getCardinality() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the Cardinality defined for this RMProperty instance.
getChildReceipts() - Method in interface com.ibm.jarm.api.core.Record
Returns the collection of Record instances that are currently assigned as child receipts of this record.
getChoiceIntegerValue() - Method in interface com.ibm.jarm.api.meta.RMChoiceItem
The value of the choice item for an integer-type choice list.
getChoiceItemType() - Method in interface com.ibm.jarm.api.meta.RMChoiceItem
Returns the enumerated ChoiceItemType value describing this particular choice item.
getChoiceList() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Returns the RMChoiceList, if any, that is assigned to this property description.
getChoiceListValues() - Method in interface com.ibm.jarm.api.meta.RMChoiceList
Returns the collection of top level RMChoiceItem instances contained by this choice list.
getChoiceStringValue() - Method in interface com.ibm.jarm.api.meta.RMChoiceItem
The value of the choice item for a string-type choice list.
getClassDescription() - Method in interface com.ibm.jarm.api.core.BaseEntity
Returns the RMClassDescription for this entity.
getClassificationGuides(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a collection of available ClassificationGuide instances defined on this file plan repository.
getClassName() - Method in interface com.ibm.jarm.api.core.BaseEntity
Provides the name of the repository class from which the entity is instantiated.
getClientIdentifier() - Method in interface com.ibm.jarm.api.core.BaseEntity
Provides the client-specific identifying string for the entity.
getCode() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The Code property value assigned to this guide section or guide topic.
getCommonWhereClause() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Get the where clause for common criteria.
getConditionXML() - Method in interface com.ibm.jarm.api.core.AlternateRetention
Returns an XML string fragment describing the condition defined for this alternate retention.
getConditionXML() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns an XML string fragment describing the condition defined for this disposition trigger.
getConditionXML() - Method in interface com.ibm.jarm.api.core.Hold
Returns the ConditionXML property value.
getConnectionInfo() - Method in interface com.ibm.jarm.api.core.DomainConnection
Returns an optional Map of key/value pair entries that represents additional information necessary for establishing an active connection to a given domain.
getConstraintMask() - Method in interface com.ibm.jarm.api.meta.RMMarkingItem
Returns a bit mask defining the access permission associated with a given marking.
getContainedBy() - Method in interface com.ibm.jarm.api.core.BaseEntity
Provides the collection of Container instances in which this entity is filed, if any.
getContentElements() - Method in interface com.ibm.jarm.api.core.ContentItem
Returns a collection of RMContentElement instances belonging to this content item.
getContentSearch() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Get content search keyword(s)
getContentSearchOption() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Get cbr search option between the content and property search.
getContentType() - Method in interface com.ibm.jarm.api.core.RMContentElement
Provides an indicator of the type of content that this content element represents.
getCreatorOwnerNameDesignation() - Method in interface com.ibm.jarm.api.security.RMPermission
If supported by a particular domain type, returns the principal name that refers to the user who initially creates a repository object.
getCurrentPage() - Method in interface com.ibm.jarm.api.collection.RMPageIterator
Returns the contents of the iterator's current page.
getCutoffAction() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the DispositionAction instance that defines the Cutoff action for this DispositionSchedule.
getCutoffBase() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the symbolic name of the Date-type property that defines the cutoff base for this DispositionSchedule.
getDataModelType() - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns the DataModelType of this file plan repository.
getDataType() - Method in interface com.ibm.jarm.api.meta.RMChoiceList
Returns the data type of the underlying value for each non-group type choice item in this choice list.
getDataType() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Returns the DataType describing the data type allowed for the property value of a property that is based on this property description.
getDataType() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the DataType defined for this RMProperty instance.
getDateIssued() - Method in interface com.ibm.jarm.api.core.ClassificationGuide
The date when the classification guide was originally issued.
getDateTime() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns a Date value for the disposition trigger's DateTime property, if any.
getDateTimeDefaultValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionDateTime
Indicates the default value, if any, for a DataType.DateTime property that is based on this property description.
getDateTimeListValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its multi-valued, DataType.DateTime value.
getDateTimeListValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.DateTime and cardinality multi-valued.
getDateTimeMaximumValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionDateTime
Indicates the maximum allowed value, if any, for a DataType.DateTime property that is based on this property description.
getDateTimeMinimumValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionDateTime
Indicates the minimum allowed value, if any, for a DataType.DateTime property that is based on this property description.
getDateTimeSelectionsList() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionDateTime
Specifies a collection of Date instances that can be assigned to the value of a property that is based on this property description.
getDateTimeValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its single-valued, DataType.DateTime value.
getDateTimeValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.DateTime and cardinality single-valued.
getDbgOutputStream() - Static method in class com.ibm.jarm.api.util.Util
FOR DEVELOPMENT USE ONLY!
getDeclassifyOnDate() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The DeclassifyOnDate property value assigned to this guide section or guide topic.
getDeclassifyOnEvents() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The DeclassifyOnEvents property value assigned to this guide section or guide topic.
getDefaultInstanceOwner() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns the name of a user or group that is to be the default owner of a new instance of this class.
getDefaultInstancePermissions() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns a collection of RMPermission instances that are to be used as the default set of permissions for a new instance of this class.
getDefaultSettings() - Method in interface com.ibm.jarm.api.core.SystemConfiguration
Returns the DefaultSettings property value.
getDeletionAction() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionObject
Specifies the action to be taken, if any, with respect to a given object-value property that is based on this property description, when an attempt is made to delete the object that contains the property.
getDescription() - Method in interface com.ibm.jarm.api.core.AuditEvent
Returns the RMEntityDescription property value.
getDescription() - Method in interface com.ibm.jarm.api.core.ClassificationGuide
A description string for this classification guide.
getDescription() - Method in interface com.ibm.jarm.api.core.DispositionAction
Returns the RMEntityDescription property value assigned to this disposition action.
getDescription() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Returns the RMEntityDescription property value of this disposition phase.
getDescription() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the RMEntityDescription property value of this disposition schedule.
getDescription() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns the RMEntityDescription property value of this disposition trigger.
getDescription() - Method in interface com.ibm.jarm.api.core.Location
Returns the RMEntityDescription property value.
getDescription() - Method in interface com.ibm.jarm.api.core.NamingPattern
Returns the RMEntityDescription property value.
getDescription() - Method in interface com.ibm.jarm.api.core.RecordType
Returns the RMEntityDescription property value.
getDescription() - Method in interface com.ibm.jarm.api.core.RMLink
Returns the RMEntityDescription property value.
getDescription() - Method in interface com.ibm.jarm.api.exception.RMErrorRecord
Provides a repository-generated description string for this ErrorRecord instance.
getDescription() - Method in interface com.ibm.jarm.api.security.RMRole
Returns the Description property value.
getDescriptiveText() - Method in interface com.ibm.jarm.api.meta.RMChoiceList
Returns any descriptive text for this choice list.
getDescriptiveText() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns any descriptive text for this class.
getDescriptiveText() - Method in interface com.ibm.jarm.api.meta.RMMarkingSet
Returns any descriptive text for this marking set.
getDescriptiveText() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Returns any descriptive text for this property description.
getDiagnosticTypes() - Method in interface com.ibm.jarm.api.exception.RMErrorRecord
Represents specific details used to troubleshoot an error occurrence.
getDisplayName() - Method in interface com.ibm.jarm.api.core.Repository
Returns the DisplayName property value.
getDisplayName() - Method in interface com.ibm.jarm.api.meta.RMChoiceItem
Returns the localized label for this choice item based upon the current thread's locale setting.
getDisplayName() - Method in interface com.ibm.jarm.api.meta.RMChoiceList
Returns a displayable label for this choice list.
getDisplayName() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns a displayable label for this class.
getDisplayName() - Method in interface com.ibm.jarm.api.meta.RMMarkingSet
Returns a displayable label for this marking set.
getDisplayName() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Returns a display label for this property description.
getDisplayName() - Method in interface com.ibm.jarm.api.security.RMPrincipal
A domain-specific display name.
getDisplayNames() - Method in interface com.ibm.jarm.api.meta.RMChoiceItem
Returns a Map of localized labels for this choice item keyed by locale name.
getDispositionActions(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a collection of available DispositionAction instances defined on this file plan repository.
getDispositionAuthority() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the AuthorizingStatute property value of this disposition schedule.
getDispositionEventOffset() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the three Integer values that define the cutoff event offset time period in years, months and days, respectively.
getDispositionPhase() - Method in interface com.ibm.jarm.api.core.AlternateRetention
Returns the parent DispositionPhase instance to which this alternate retention belongs.
getDispositionPhases() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns an ordered collection of existing DispositionPhase instances that define this disposition schedule.
getDispositionSchedules(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a collection of available DispositionSchedule instances defined on this file plan repository.
getDispositionTrigger() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the CutoffDisposalTrigger property value.
getDispositionTriggers(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a collection of available DispositionTrigger instances defined on this file plan repository.
getDistinguishedName() - Method in interface com.ibm.jarm.api.security.RMPrincipal
A domain-specific LDAP distinguished name.
getDoDMaxDeclassifyTimeLimit() - Method in interface com.ibm.jarm.api.core.FilePlanRepository
For a file plan repository based on the DoD Classified data model, returns the current Maximum Declassification time limit value (in years).
getDomain() - Method in interface com.ibm.jarm.api.core.Repository
Returns the RMDomain to which this repository belongs.
getDomainConnection() - Method in interface com.ibm.jarm.api.core.RMDomain
Returns the DomainConnection instance associated with this domain.
getDomainType() - Method in interface com.ibm.jarm.api.core.BaseEntity
Convenience method that indicates the type of RMDomain in which this BaseEntity resides.
getDomainType() - Method in interface com.ibm.jarm.api.core.DomainConnection
The DomainType of the RMDomain that this DomainConnection describes.
getDomainType() - Method in interface com.ibm.jarm.api.core.RMDomain
Returns the DomainType of this domain.
getDoubleDefaultValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionDouble
Indicates the default value, if any, for a DataType.Double property that is based on this property description.
getDoubleListValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its multi-valued, DataType.Double value.
getDoubleListValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Double and cardinality multi-valued.
getDoubleMaximumValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionDouble
Indicates the maximum allowed value, if any, for a DataType.Double property that is based on this property description.
getDoubleMinimumValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionDouble
Indicates the minimum allowed value, if any, for a DataType.Double property that is based on this property description.
getDoubleSelectionsList() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionDouble
Specifies a collection of Double instances that can be assigned to the value of a property that is based on this property description.
getDoubleValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its single-valued, DataType.Double value.
getDoubleValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Double and cardinality single-valued.
getEffectiveDateModified() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the EffectiveDateModified property value of this disposition schedule.
getElementCount() - Method in interface com.ibm.jarm.api.collection.RMPageIterator
Indicates the number of elements in the current page.
getEmailName() - Method in interface com.ibm.jarm.api.security.RMUser
Returns the Email address property value.
getEntityIdent() - Method in interface com.ibm.jarm.api.core.BulkItemResult
Returns the unique identifier for the entity that this BulkItemResult instance represents.
getEntityIdent() - Method in class com.ibm.jarm.api.core.BulkOperation.EntityDescription
Returns the identifying string for this instance.
getEntityType() - Method in interface com.ibm.jarm.api.core.BaseEntity
Provides the entity type of this entity.
getEntityType() - Method in class com.ibm.jarm.api.core.BulkOperation.EntityDescription
Returns the EntityType value for this instance.
getEntityType() - Method in interface com.ibm.jarm.api.core.ClassificationGuide
The entity type of this object.
getEntryHelp() - Method in interface com.ibm.jarm.api.core.ReportDefinition
Returns the value of Report Entry Help property of this instance.
getEntryHelpLocalizationKey() - Method in interface com.ibm.jarm.api.core.ReportDefinition
Returns the value of Report Entry Help Localization Key property of this instance.
getErrorCode() - Method in interface com.ibm.jarm.api.exception.MessageInfo
Returns the RMErrorCode associated with this MessageInfo instance.
getErrorCode() - Method in exception com.ibm.jarm.api.exception.RMRuntimeException
Returns the RMErrorCode associated with this exception.
getErrorRecords() - Method in interface com.ibm.jarm.api.exception.RMErrorStack
Returns the collection of RMErrorRecord instances, if any, associated with a RMRuntimeException.
getErrorStack() - Method in exception com.ibm.jarm.api.exception.RMRuntimeException
Returns a repository-specific RMErrorStack instance, if any, that provides additional repository-related information concerning the exception.
getEventStatus() - Method in interface com.ibm.jarm.api.core.AuditEvent
Returns the event status associated with this AuditEvent instance.
getException() - Method in interface com.ibm.jarm.api.core.BulkItemResult
Returns any available RMRuntimeException associated with a failed operation.
getExcludePropertyNames() - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Returns a collection of excluded property names.
getExemptions() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The Exemptions property value assigned to this guide section or guide topic.
getExplanation() - Method in interface com.ibm.jarm.api.exception.MessageInfo
Returns any available localized explanation text.
getExportDestination() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Returns the ExportDestination property value of this disposition phase.
getExportFormat() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Returns the ExportFormate property value of this disposition phase.
getExternalEventOccurrenceDate() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns a Date value for the disposition trigger's ExternalEventOccurrenceDate property.
getFilePlan() - Method in interface com.ibm.jarm.api.core.Record
Returns the FilePlan instance in the container hierarchy in which this record resides.
getFilePlan() - Method in interface com.ibm.jarm.api.core.RecordContainer
Returns the top level FilePlan instance under which this RecordContainer resides.
getFilePlans(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a collection of available FilePlan instances defined on this file plan repository.
getFilteredPropertyType() - Method in class com.ibm.jarm.api.property.RMFilterElement
Returns the RMFilteredPropertyType value.
getFolderName() - Method in interface com.ibm.jarm.api.core.Container
Returns the FolderName property value for this Container.
getFolderUniqueIdentifier() - Method in interface com.ibm.jarm.api.core.RecordFolder
Returns the RecordFolderIdentifier property value.
getFolderUniqueIdentifier() - Method in interface com.ibm.jarm.api.core.RecordVolume
Returns the RecordFolderIdentifier property value.
getFormattedMessage() - Method in interface com.ibm.jarm.api.exception.MessageInfo
Returns the localized error message string that has been formatted with any message replacement parameter values.
getFromClause() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Get the from clause.
getGranteeName() - Method in interface com.ibm.jarm.api.security.RMPermission
Returns the name of the user or group to which this RMPermission applies.
getGranteeType() - Method in interface com.ibm.jarm.api.security.RMPermission
Indicates whether the getGranteeName return value represents a user, a group or unknown.
getGroupChoiceItems() - Method in interface com.ibm.jarm.api.meta.RMChoiceItem
Returns the collection of nested RMChoiceItems for a group-node choice item.
getGroupMembers() - Method in interface com.ibm.jarm.api.security.RMGroup
Returns the collection of RMGroup instances that are immediate members of this RMGroup.
getGroupMemberships() - Method in interface com.ibm.jarm.api.security.RMGroup
Returns the collection of RMGroup of which this RMGroup is an immediate member.
getGroupMemberships() - Method in interface com.ibm.jarm.api.security.RMUser
Returns the collection of RMGroup instances that this RMUser is an immediate member of.
getGuidDefaultValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionGuid
Indicates the default value, if any, for a DataType.Guid property that is based on this property description.
getGuideID() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The identifier of the classification guide where this guide section or guide topic belongs.
getGuideName() - Method in interface com.ibm.jarm.api.core.ClassificationGuide
The name assigned to this classification guide.
getGuideSections() - Method in interface com.ibm.jarm.api.core.ClassificationGuide
The collection of immediate child guide sections for this classification guide.
getGuideSections() - Method in interface com.ibm.jarm.api.core.ClassificationGuideSection
The collection of immediate child guide sections for this section.
getGuideTopics() - Method in interface com.ibm.jarm.api.core.ClassificationGuide
The collection of immediate child guide topics for this classification guide.
getGuideTopics() - Method in interface com.ibm.jarm.api.core.ClassificationGuideSection
The collection of immediate child guide topics for this section.
getGuidListValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its multi-valued, DataType.Guid value.
getGuidListValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Guid and cardinality multi-valued.
getGuidSelectionsList() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionGuid
Specifies a collection of String instances that can be assigned to the value of a property that is based on this property description.
getGuidValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its single-valued, DataType.Guid value.
getGuidValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Guid and cardinality single-valued.
getHead() - Method in interface com.ibm.jarm.api.core.RMLink
Returns a BaseEntity instance that represents the head of the link relationship.
getHoldName() - Method in interface com.ibm.jarm.api.core.Hold
Returns the HoldName property value.
getHoldReason() - Method in interface com.ibm.jarm.api.core.Hold
Returns the HoldReason property value.
getHolds(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a collection of Hold instances defined on this file plan repository.
getHoldType() - Method in interface com.ibm.jarm.api.core.Hold
Returns the HoldType property value.
getId() - Method in interface com.ibm.jarm.api.core.ClassificationGuide
The unique identifier for this classification guide on its repository.
getId() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The Id property value assigned to this guide section or guide topic.
getId() - Method in interface com.ibm.jarm.api.meta.RMChoiceItem
Returns the repository unique identifier for this choice item.
getId() - Method in interface com.ibm.jarm.api.meta.RMChoiceList
Returns the repository unique identifier for this RMChoiceList.
getId() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns the repository unique identifier for this class description.
getId() - Method in interface com.ibm.jarm.api.meta.RMMarkingItem
Returns the repository unique identifier for this marking item.
getId() - Method in interface com.ibm.jarm.api.meta.RMMarkingSet
Returns the domain unique identifier for this marking set.
getId() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Returns the repository unique identifier for this property description.
getId() - Method in interface com.ibm.jarm.api.security.RMPrincipal
The unique ID String for this RMPrincipal.
getImmediateInheritedPropertyCount() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Specifies the number of RMPropertyDescription instances included in this class description that are inherited from the immediate superclass.
getImmediateSubclassDescriptions() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns a collection of RMClassDescription instances, each of which represents an immediate subclass of this class.
getImmediateSubContainers(Integer) - Method in interface com.ibm.jarm.api.core.Container
Returns a pageable set of immediate sub-containers belonging to this container.
getIncludeProperties() - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Returns a collection of RMFilterElement that define included properties.
getIncrementedBy() - Method in interface com.ibm.jarm.api.core.NamingPatternLevel
Returns the IncrementedBy property value.
getInheritableDepth() - Method in interface com.ibm.jarm.api.security.RMPermission
Returns the inheritable depth level for this RMPermission.
getInitialClassification() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The InitialClassification property value assigned to this guide section or guide topic.
getInitiatingUser() - Method in interface com.ibm.jarm.api.core.AuditEvent
Returns the name of the user that initiated the event.
getInstance(FilePlanRepository, EntityType, String) - Static method in class com.ibm.jarm.api.core.RMFactory.BaseEntity
Constructs a placeholder instance of a specific BaseEntity.
getInstance(FilePlanRepository, String, String) - Static method in class com.ibm.jarm.api.core.RMFactory.BaseEntity
Constructs a placeholder instance of a specific BaseEntity.
getInstance(FilePlanRepository, EntityType, String) - Static method in class com.ibm.jarm.api.core.RMFactory.Container
Constructs a placeholder instance of a specific Container.
getInstance(ContentRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.ContentItem
Constructs a placeholder instance of a specific ContentItem.
getInstance(RMDomain, String) - Static method in class com.ibm.jarm.api.core.RMFactory.ContentRepository
Constructs a placeholder instance of a specific ContentRepository.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionAction
Constructs a placeholder instance of the specified DispositionAction object.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionSchedule
Constructs a placeholder instance of the specified DispositionSchedule object.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionTrigger
Constructs a placeholder instance of the specified DispositionTrigger object.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.FilePlan
Constructs a placeholder instance of a specific FilePlan.
getInstance(RMDomain, String) - Static method in class com.ibm.jarm.api.core.RMFactory.FilePlanRepository
Constructs a placeholder instance of a specific FilePlanRepository.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.Hold
Constructs a placeholder instance of the specified Hold object.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.Location
Constructs a placeholder instance of the specified Location object.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.NamingPattern
Constructs a placeholder instance of the specified NamingPattern object.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.NamingPatternSequence
Constructs a placeholder instance of the specified NamingPatternSequence object.
getInstance(FilePlanRepository, String, EntityType) - Static method in class com.ibm.jarm.api.core.RMFactory.Record
Constructs a placeholder instance of a specific Record.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.RecordCategory
Constructs a placeholder instance of a specific RecordCategory.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.RecordFolder
Constructs a placeholder instance of a specific RecordFolder.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.RecordType
Constructs a placeholder instance of the specified record type object.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.RecordVolume
Constructs a placeholder instance of a specific RecordVolume.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.ReportDefinition
Constructs a placeholder instance of the specified ReportDefinition object.
getInstance(RMDomain, String) - Static method in class com.ibm.jarm.api.core.RMFactory.Repository
Constructs a placeholder instance of a specific Repository.
getInstance(Repository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.RMCustomObject
Constructs a placeholder instance of the specified RMCustomObject object.
getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.RMLink
Constructs a placeholder instance of the specified RMLink object.
getInstance(Repository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.WorkflowDefinition
Constructs a placeholder instance of a specific RMWorkflowDefinition.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.AuditStatus
Provides the AuditStatus instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.ChoiceItemType
Provides the ChoiceItemType instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.ContentXMLExport
Provides the ContentXMLExport instance that corresponds to the given intValue input parameter.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.DataModelType
Returns the DataModelType member for the given integer value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.DataType
Provides the DataType instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.DispositionActionType
Provides the DispositionActionType instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.DispositionTriggerType
Provides the DispositionTriggerType instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.EntityType
Provides the EntityType instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RetainMetadata
Provides the RetainMetadata instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMAccessType
Provides the RMAccessType instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMCardinality
Provides the RMCardinality instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMDeletionAction
Provides the RMDeletionAction instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMGranteeType
Provides the RMGranteeType instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMMergeMode
Provides the RMMergeMode instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMPermissionSource
Provides the RMPermissionSource instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMPrincipalSearchAttribute
Provides the RMPrincipalSearchAttribute instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMPrincipalSearchSortType
Provides the RMPrincipalSearchSortType instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMPrincipalSearchType
Provides the RMPrincipalSearchType instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMPropertySettability
Provides the RMPropertySettability instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMReceiptStatus
Provides the RMReceiptStatus instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMSecurityProxyType
Provides the RMSecurityProxyType instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.RMWorkflowStatus
Provides the RMWorkflowStatus instance that corresponds to the given int value.
getInstanceFromInt(int) - Static method in enum com.ibm.jarm.api.constants.SchedulePropagation
Provides the SchedulePropagation instance that corresponds to the given int value.
getInstanceFromString(String) - Static method in enum com.ibm.jarm.api.constants.DataModelType
Returns the DataModelType member for the given label value.
getIntegerDefaultValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionInteger
Indicates the default value, if any, for a DataType.Integer property that is based on this property description.
getIntegerListValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its multi-valued, DataType.Integer value.
getIntegerListValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Integer and cardinality multi-valued.
getIntegerMaximumValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionInteger
Indicates the maximum allowed value, if any, for a DataType.Integer property that is based on this property description.
getIntegerMinimumValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionInteger
Indicates the minimum allowed value, if any, for a DataType.Integer property that is based on this property description.
getIntegerSelectionsList() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionInteger
Specifies a collection of Integer instances that can be assigned to the value of a property that is based on this property description.
getIntegerValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its single-valued, DataType.Integer value.
getIntegerValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Integer and cardinality single-valued.
getIntValue() - Method in enum com.ibm.jarm.api.constants.AuditStatus
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.ChoiceItemType
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.ContentXMLExport
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.DataModelType
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.DataType
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.DispositionActionType
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.DispositionTriggerType
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.EntityType
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RetainMetadata
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMAccessLevel
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMAccessRight
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMAccessType
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMCardinality
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMDeletionAction
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMGranteeType
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMMergeMode
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMPermissionSource
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMPrincipalSearchAttribute
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMPrincipalSearchSortType
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMPrincipalSearchType
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMPropertySettability
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMReceiptStatus
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMSecurityProxyType
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.RMWorkflowStatus
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.constants.SchedulePropagation
Returns the integer value associated with this member.
getIntValue() - Method in enum com.ibm.jarm.api.property.RMFilteredPropertyType
Provides the int constant value for the RMFilteredPropertyType member.
getIssuedBy() - Method in interface com.ibm.jarm.api.core.ClassificationGuide
The authority who issued this classification guide.
getJarmLogger(String) - Static method in class com.ibm.jarm.api.util.JarmLogger
Static method to acquire a new JarmLogger instance.
getJarmTracer(JarmTracer.SubSystem) - Static method in class com.ibm.jarm.api.util.JarmTracer
Static method used to acquire a new JarmTracer instance.
getLabel() - Method in enum com.ibm.jarm.api.constants.DataModelType
Provides the string label constant for the DataModelType member.
getLabel() - Method in enum com.ibm.jarm.api.util.JarmTracer.SubSystem
Returns the label for a subsystem used to generate trace message strings.
getLastPatternIndex() - Method in interface com.ibm.jarm.api.core.FilePlan
Provides the value of the LastPatternIndex property value of this file plan.
getLastPatternIndex() - Method in interface com.ibm.jarm.api.core.NamingPatternSequence
Returns the value of the LastPatternIndex property for this naming pattern sequence instance.
getLevelDependents() - Method in class com.ibm.jarm.api.property.RMFilterElement
Returns the levelDependents value.
getLevelDependents() - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Returns the global levelDependents value for this RMPropertyFilter.
getLinkName() - Method in interface com.ibm.jarm.api.core.RMLink
Returns the LinkName property value.
getLocale() - Method in class com.ibm.jarm.api.util.RMUserContext
Returns the Locale associated with this user context.
getLocationName() - Method in interface com.ibm.jarm.api.core.Location
Returns the LocationName property value.
getLocations(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a collection of available Location instances defined on this file plan repository.
getMarkings() - Method in interface com.ibm.jarm.api.meta.RMMarkingSet
Returns the collection of RMMarkingItems that make up this marking set.
getMarkingSet() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionString
Specifies the set of markings, if any, applicable to the value of a property that is based on this property description.
getMarkingUseGranted() - Method in interface com.ibm.jarm.api.meta.RMMarkingItem
Returns a bit mask that identifies which access rights have been granted to the current user with respect to this marking.
getMarkingValue() - Method in interface com.ibm.jarm.api.meta.RMMarkingItem
Specifies the value to use when applying a marking to an object that has a property associated with the corresponding RMMarkingSet.
getMaxContentSize() - Method in class com.ibm.jarm.api.property.RMFilterElement
Returns the maxContentSize value.
getMaxContentSize() - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Returns the global maxContentSize value for this RMPropertyFilter.
getMaxRecursion() - Method in class com.ibm.jarm.api.property.RMFilterElement
Returns the maxRecursion value.
getMaxRecursion() - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Returns the global maxRecursion value for this RMPropertyFilter.
getMembers() - Method in interface com.ibm.jarm.api.security.RMRole
Returns the collection of RMPrincipal instances belonging to this RMRole.
getMergeMode() - Method in class com.ibm.jarm.api.query.RMSearch
Returns the MergeMode assigned to this RMSearch instance.
getMessageId() - Method in enum com.ibm.jarm.api.exception.RMErrorCode
Returns the IBM Standard Message ID string for this RMErrorCode.
getMessageInfo() - Method in exception com.ibm.jarm.api.exception.RMRuntimeException
Returns a MessageInfo instance that provides various localized information strings about this RMRuntimeException instance such as a detailed explanation and suggested user action to resolve the exception issue.
getMessageKey() - Method in enum com.ibm.jarm.api.util.RMLogCode
Returns the logging resource key string in its IBM Standard Message Id form, e.g.
getMimeType() - Method in interface com.ibm.jarm.api.core.ContentItem
Returns the MimeType property value associated with a content item.
getModifiedPropertyNames() - Method in interface com.ibm.jarm.api.core.AuditEvent
Returns a list of the symbolic names of the properties modified by the operation that generated this audit event (if available).
getName() - Method in interface com.ibm.jarm.api.core.BaseEntity
Provides a Name property value for the entity, if any.
getName() - Method in interface com.ibm.jarm.api.core.RMDomain
Returns the DisplayName property value.
getName() - Method in interface com.ibm.jarm.api.meta.RMChoiceItem
Returns a label String for this choice item.
getName() - Method in interface com.ibm.jarm.api.meta.RMChoiceList
Returns a name String for this RMChoiceList.
getName() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns a name string for this class description.
getName() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Returns a name string for this property description.
getName() - Method in class com.ibm.jarm.api.query.ReportParameter
Returns the name value for this parameter.
getName() - Method in interface com.ibm.jarm.api.security.RMPrincipal
A domain-specific generalized name value.
getNamePropertyIndex() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Specifies the 0-based index into the class' collection of RMPropertyDescription instances designating the RMPropertyDescription that represents the default "Name" property for the class, if any.
getNamingPattern() - Method in interface com.ibm.jarm.api.core.FilePlan
Returns the associated NamingPattern instance that can be used to support auto-naming of record categories and record folders contained within this file plan.
getNamingPattern() - Method in interface com.ibm.jarm.api.core.NamingPatternLevel
Returns the NamingPattern instance to which this naming pattern level belongs.
getNamingPatternLevel(Integer, AppliedForCategoryOrFolder) - Method in interface com.ibm.jarm.api.core.NamingPattern
Returns the NamingPatternLevel instance associated with this naming pattern for the level and applied for specified.
getNamingPatternLevels() - Method in interface com.ibm.jarm.api.core.NamingPattern
Returns the naming pattern levels that are associated with this naming pattern
getNamingPatternSequence(Container) - Static method in class com.ibm.jarm.api.util.NamingUtils
This procedure will retrieve a naming pattern sequence object associcated with a container
getNextPage() - Method in interface com.ibm.jarm.api.collection.CBRPageIterator
Returns the contents of the iterator's current page.
getObjectIdentity() - Method in interface com.ibm.jarm.api.core.BaseEntity
Provides a unique, repository-specific identifying string for the entity.
getObjectIdentity() - Method in interface com.ibm.jarm.api.security.RMRole
Provides a unique, repository-specific ID for the role.
getObjectListValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its multi-valued, DataType.Object value.
getObjectListValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Object and cardinality multi-valued.
getObjectValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its single-valued, DataType.Object value.
getObjectValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.Object and cardinality single-valued.
getOperator() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns the value of the Operator property for this disposition trigger.
getOperBtwContentAndMetadataSearch() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Get operator between the content and metadata search.
getOrderBy() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Indicates if the search is ordered by metadata, by CBR scores, or no order.
getOrderClause() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Get the order clause.
getOriginalObject() - Method in interface com.ibm.jarm.api.core.AuditEvent
Returns the audit event's RMPropertyName.OriginalObject property value, if available.
getPageMark() - Method in interface com.ibm.jarm.api.collection.RMPageIterator
Returns a PageMark instance representing the iterator's current continuation state.
getPageSize() - Method in interface com.ibm.jarm.api.collection.RMPageIterator
Indicates the current maximum page size defined for the RMPageIterator.
getPageSize() - Method in class com.ibm.jarm.api.property.RMFilterElement
Returns the pageSize value.
getPageSize() - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Returns the global pageSize value for this RMPropertyFilter.
getParent() - Method in interface com.ibm.jarm.api.core.Container
Returns the immediate parent container of this container, if any.
getParentIdentifier() - Method in interface com.ibm.jarm.api.core.NamingPatternSequence
Returns the value of the ParentGUID property that identifies the parent object to which this naming pattern sequence applies.
getParentsOnHold() - Method in interface com.ibm.jarm.api.core.Holdable
Returns a collection of hierarchical parents of this object that are currently on hold.
getPathName() - Method in interface com.ibm.jarm.api.core.Container
Returns the PathName property value for this Container.
getPatternLevelNumber() - Method in interface com.ibm.jarm.api.core.NamingPatternLevel
Returns the LevelNumber property value.
getPatternName() - Method in interface com.ibm.jarm.api.core.NamingPattern
Returns the PatternName property value.
getPatternString() - Method in interface com.ibm.jarm.api.core.NamingPatternLevel
Returns the PatternString property value.
getPermissions() - Method in interface com.ibm.jarm.api.core.BaseEntity
Provides the RMPermission collection for this entity.
getPermissionSource() - Method in interface com.ibm.jarm.api.security.RMPermission
Returns a RMPermissionSource value indicating the source of this permission.
getPhaseAction() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Returns the DispositionAction associated with this disposition phase.
getPhaseName() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Returns the PhaseName property value of this disposition phase.
getPhaseNumber() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Returns the 1-based ordinal position of this disposition phase instance relative to its siblings that are also associated with its corresponding DispositionSchedule.
getPrevPage() - Method in interface com.ibm.jarm.api.collection.CBRPageIterator
Returns the contents of the iterator's previous page.
getPrincipals(Subject) - Static method in class com.ibm.jarm.api.util.RMUserContext
Returns a string containing a list of java.security.Principal instances for the given javax.security.auth.Subject instance.
getPrivileges() - Method in interface com.ibm.jarm.api.security.RMRole
Returns a String version of the Privileges property value.
getProperties() - Method in interface com.ibm.jarm.api.core.BaseEntity
Provides the collection of properties that reflects the state of the property cache of the entity.
getProperties() - Method in interface com.ibm.jarm.api.query.ResultRow
Returns a properties collection representing the ResultRow's values.
getPropertyDataType() - Method in interface com.ibm.jarm.api.core.SystemConfiguration
Returns the PropertyDataType property value.
getPropertyDescription(String) - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns the RMPropertyDescription instance specified by its symbolic name from those property descriptions belonging to this class description.
getPropertyDescriptions() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns the collection of RMPropertyDescriptions belonging to this class.
getPropertyName() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns the PropertyName property value of this disposition trigger.
getPropertyName() - Method in interface com.ibm.jarm.api.core.SystemConfiguration
Returns the PropertyName property value.
getPropertyValue() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns the value of the PropertyValue property for this disposition trigger.
getPropertyValue() - Method in interface com.ibm.jarm.api.core.SystemConfiguration
Returns the PropertyValue property value.
getRALService(BaseEntity) - Static method in class com.ibm.jarm.api.core.RMFactory
Returns the RALService instance associated with the given IBM Enterprise Records base entity.
getRALService(DomainConnection) - Static method in class com.ibm.jarm.api.core.RMFactory
Returns the RALService instance associated with the given domain connection.
getReasonForAction() - Method in interface com.ibm.jarm.api.core.AuditEvent
Returns the ReasonForAction property value.
getReasonForChange() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Returns the ReasonForChange property value of this disposition phase.
getReasonForChange() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the ReasonForChange property value of this disposition schedule.
getReasonsForClassification() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The ReasonsForClassification property value assigned to this guide section or guide topic.
getReceiptParent() - Method in interface com.ibm.jarm.api.core.Record
Returns the parent Record instance, if any, to which this record is currently assigned as a receipt.
getRecordCategoryIdentifier() - Method in interface com.ibm.jarm.api.core.RecordCategory
Returns the RecordCategoryIdentifier property value.
getRecordCategoryName() - Method in interface com.ibm.jarm.api.core.RecordCategory
Returns the RecordCategoryName property value.
getRecordFolderName() - Method in interface com.ibm.jarm.api.core.RecordFolder
Returns the RecordFolderName property value.
getRecords(Integer) - Method in interface com.ibm.jarm.api.core.RecordContainer
Returns a pageable collection of Record instances that are directly contained by this RecordContainer.
getRecordTypeName() - Method in interface com.ibm.jarm.api.core.RecordType
Returns the RecordTypeName property value.
getRecordTypes(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a collection of available RecordType instances defined on this file plan repository.
getRecurringCyclePeriod() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns the three Integer values that define the recurring cycle period in years, months and days, respectively, for a recurring trigger.
getReferenceContentLocation() - Method in interface com.ibm.jarm.api.core.RMContentElement
Provides a location reference to some content (typically a URL string).
getReflectivePropertyId() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionObject
Provides the ID of the property description with which this property description has a reflective relationship, if any.
getRemarks() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The Remarks property value assigned to this guide section or guide topic.
getReportDBTableName() - Method in interface com.ibm.jarm.api.core.ReportDefinition
Returns the value of Report Database Table Name property of this instance.
getReportDefinitions(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a collection of available ReportDefinition instances defined on this file plan repository.
getReportDescription() - Method in interface com.ibm.jarm.api.core.ReportDefinition
Returns the value of Report Description property of this instance.
getReportDescriptionLocalizationKey() - Method in interface com.ibm.jarm.api.core.ReportDefinition
Returns the value of Report Description Localization Key property of this instance.
getReportName() - Method in interface com.ibm.jarm.api.core.ReportDefinition
Returns the value of Report Name property of this instance.
getReportNameLocalizationKey() - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
getReportParameters() - Method in interface com.ibm.jarm.api.core.ReportDefinition
Returns the value of Report Parameters property of this instance.
getReportQueriesByAssociatedEntityType(String) - Method in interface com.ibm.jarm.api.core.ReportDefinition
Returns the list of Report Queries for this instance.
getReportTitle() - Method in interface com.ibm.jarm.api.core.ReportDefinition
Returns the Report Title value.
getReportTitleLocalizationKey() - Method in interface com.ibm.jarm.api.core.ReportDefinition
Returns the value of the Report Title Localization Key property of this instance.
getRepositories() - Method in class com.ibm.jarm.api.query.RMSearch
Returns the collection of Repository instances that this RMSearch applies to.
getRepository() - Method in interface com.ibm.jarm.api.core.BaseEntity
Provides the repository to which this entity belongs.
getRepository() - Method in interface com.ibm.jarm.api.security.RMRoles
Specifies the Repository used to retrieve roles from and save roles to.
getRepositoryType() - Method in interface com.ibm.jarm.api.core.Repository
Returns a RepositoryType value that defines the type of this repostiory.
getRequiredClass() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionObject
Provides the RMClassDescription for the class (or superclass) of object type that the value of a property that is based on this property description must be an instance of.
getResultData() - Method in interface com.ibm.jarm.api.core.BulkItemResult
Returns associated result data, if any, for a successful BulkItemResult.
getResultRow() - Method in interface com.ibm.jarm.api.query.CBRResult
Returns the ResultRow for this result.
getRetainMetadata() - Method in interface com.ibm.jarm.api.core.FilePlan
Provides the value of the RetainMetadata property assigned to this file plan.
getRetentionBase() - Method in interface com.ibm.jarm.api.core.AlternateRetention
Returns the symbolic property name that defines the retention base for this alternate retention instance.
getRetentionNumber() - Method in interface com.ibm.jarm.api.core.AlternateRetention
Returns the 1-based positional order of this alternate retention instance within its containing DispositionPhase parent.
getRetentionPeriod() - Method in interface com.ibm.jarm.api.core.AlternateRetention
Returns the three Integer values that define the retention time period in years, months and days, respectively, for this alternate retention.
getRetentionPeriod() - Method in interface com.ibm.jarm.api.core.DefensiblyDisposable
For a "Defensibly Disposable" container, returns its assigned three-part retention period value.
getRetentionPeriod() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Returns the three Integer values that define the retention time period in years, months and days, respectively, for this disposition phase.
getReviewer() - Method in interface com.ibm.jarm.api.core.AuditEvent
Returns the Reviewer property value.
getReviewer() - Method in interface com.ibm.jarm.api.core.Location
Returns the Reviewer property value.
getRMEntityType() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The entity type of this object.
getRoleById(String) - Method in interface com.ibm.jarm.api.security.RMRoles
Retrieves a RMRole instance from the repository based upon its ID string.
getRoleByNames(String, String) - Method in interface com.ibm.jarm.api.security.RMRoles
Retrieves a RMRole instance from the repository based upon the specified role name and application name values.
getRoleName() - Method in interface com.ibm.jarm.api.security.RMRole
Returns the RoleName property value.
getRoleType() - Method in interface com.ibm.jarm.api.security.RMRole
Returns the RoleType property value.
getScheduleName() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the DisposalScheduleName property value of this disposition schedule.
getScore() - Method in interface com.ibm.jarm.api.query.CBRResult
Returns the CBR score for this result.
getSecurityFolder() - Method in interface com.ibm.jarm.api.core.Record
Returns the Container from which the record inherits security from.
getSelectClause() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Get the select clause.
getSettability() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Specifies at what point in its life cycle a property's value can be set for a property that is based on this property description.
getShortName() - Method in interface com.ibm.jarm.api.security.RMPrincipal
A domain-specific short name.
getSortOrder() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Get the sorting order
getSource() - Method in interface com.ibm.jarm.api.exception.RMErrorRecord
Provides repository-specific exception source information.
getSourceClassId() - Method in interface com.ibm.jarm.api.core.AuditEvent
Returns the Id string for the class description belonging to the audit event's source object.
getSourceObject() - Method in interface com.ibm.jarm.api.core.AuditEvent
Returns the audit event's RMPropertyName.SourceObject property value, if available.
getSourceObjectId() - Method in interface com.ibm.jarm.api.core.AuditEvent
Returns the Id string for the source object associated with this audit event.
getSqlAlias() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Get the SQL alias of record class
getStringDefaultValue() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionString
Specifies the default string value, if any, for a property that is based on this property description.
getStringListValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its multi-valued, DataType.String value.
getStringListValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.String and cardinality multi-valued.
getStringMaximumLength() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionString
Specifies the maximum length, in characters, if any, for the string value of a property that is based on this property description.
getStringSelectionsList() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionString
Specifies a collection of String instances that can be assigned to the value of a property that is based on this property description.
getStringValue(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Locates a property in this collection by its symbolic name and returns its single-valued, DataType.String value.
getStringValue() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the value of a RMProperty of data type DataType.String and cardinality single-valued.
getSubject() - Method in class com.ibm.jarm.api.util.RMUserContext
 
getSuperclassDescription() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns the RMClassDescription of the immediate superclass of this class.
getSupplementalMarkings() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The SupplementalMarkingsStringList property value assigned to this guide section or guide topic.
getSweepState() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the SweepState property value of this disposition schedule.
getSweepState() - Method in interface com.ibm.jarm.api.core.Hold
Returns the SweepState property value.
getSymbolicName() - Method in interface com.ibm.jarm.api.core.Repository
Returns the SymbolicName property value.
getSymbolicName() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Returns the locale-independent, symbolic name of this class.
getSymbolicName() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Returns the locale-independent, symbolic name of the property description.
getSymbolicName() - Method in interface com.ibm.jarm.api.property.RMProperty
Returns the symbolic name of the property.
getSymbolicNames() - Method in class com.ibm.jarm.api.property.RMFilterElement
Returns the symbolicNames string value.
getSystemConfigurations() - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a read-only collection of SystemConfiguration instances that applies to this file plan repository.
getTail() - Method in interface com.ibm.jarm.api.core.RMLink
Returns a BaseEntity instance that represents the tail of the link relationship.
getTopic() - Method in interface com.ibm.jarm.api.core.ClassificationGuideTopic
The Topic property value assigned to this guide section or guide topic.
getTriggerName() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns the DisposalTriggerName property value of this disposition trigger.
getTriggerPropertyName() - Method in interface com.ibm.jarm.api.core.DefensiblyDisposable
For a "Defensibly Disposable" container, returns the symbolic name of the record DateTime-type property assigned as the trigger property.
getTriggerType() - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Returns the DispositionTriggerType enum value that defines the general category of trigger type of this instance.
getType() - Method in interface com.ibm.jarm.api.exception.Diagnostic
Returns the type string for this Diagnostic.
getUrl() - Method in interface com.ibm.jarm.api.core.DomainConnection
The Url string used by this domain connection.
getUserMembers() - Method in interface com.ibm.jarm.api.security.RMGroup
Returns the collection of RMUser instances that are immediate members of this RMGroup.
getValue() - Method in interface com.ibm.jarm.api.exception.Diagnostic
Returns the value string for this Diagnostic instance.
getVolumeName() - Method in interface com.ibm.jarm.api.core.RecordVolume
Returns the VolumeName property value.
getWhereClause() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Get the where clause.
getWorkflowDefinitions(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Returns a collection of available, IER-related RMWorkflowDefinition instances defined on this file plan repository.
GroupMembers - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
GuideID - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
GuideName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 

H

hasContentQueryDefined() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
This method returns true if there is content Search keyword(s) presented.
hasHierarchy() - Method in interface com.ibm.jarm.api.meta.RMChoiceList
Indicates whether or not a choice list has a hierarchical structure or is simply a flat list of choice items.
hasNextPage() - Method in interface com.ibm.jarm.api.collection.CBRPageIterator
Moves the iterator to the next page of the collection.
hasPrevPage() - Method in interface com.ibm.jarm.api.collection.CBRPageIterator
Moves the iterator to the previous page of the collection.
Head - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Hold - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Hold class.
Hold - Interface in com.ibm.jarm.api.core
An interface that represents a Hold custom object.
Holdable - Interface in com.ibm.jarm.api.core
An interface for entities that can be recipients of hold placement and removal operations.
HoldName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
HoldReason - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Holds - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
HoldType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
HomeLocation - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
HybridFolderLink - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Hybrid Folder Link class.
HybridRecordFolder - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Hybrid Record Folder folder class.

I

IBM_PREFIX - Static variable in exception com.ibm.jarm.api.exception.RMRuntimeException
The IBM Message Standard three-character prefix assigned to IBM Enterprise Records products.
Id - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
IERWorkflowException - Exception in com.ibm.jarm.api.exception
Primary exception class for use by the external IER Workflow support components.
ImmediateSubclassDescriptions - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ImplementingClassName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
inactivateContainers(FilePlanRepository, List<String>, String) - Static method in class com.ibm.jarm.api.core.BulkOperation
Performs an inactivate operation on each of the specified RecordCategory and/or RecordFolder entities.
Inactive - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
IncrementedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
info(RMLogCode, Object...) - Method in class com.ibm.jarm.api.util.JarmLogger
Logs a message with the INFO level.
info(RMLogCode, Throwable, Object...) - Method in class com.ibm.jarm.api.util.JarmLogger
Logs a message with the INFO level including the stack trace of the included Throwable t parameter.
InitialClassification - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
initiateDisposition(FilePlanRepository, List<BulkOperation.EntityDescription>, Object) - Static method in class com.ibm.jarm.api.core.BulkOperation
Performs necessary initiate disposition processing for each of the specified entities.
initiateDisposition(Object) - Method in interface com.ibm.jarm.api.core.Dispositionable
Initiates disposition on this entity and its applicable hierarchical children by attempting to launch the appropriate phase workflow(s).
InitiatingUser - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
isAContentReference() - Method in interface com.ibm.jarm.api.core.RMContentElement
Indicates whether this content element represents a reference to some external content (for example, URL) or actual content binary data.
isActive() - Method in interface com.ibm.jarm.api.core.Hold
Returns a Boolean value indicating whether the hold is active.
isADefensiblyDisposableContainer() - Method in interface com.ibm.jarm.api.core.DefensiblyDisposable
Indicates whether or not this container is currently a "Defensibly Disposable" container.
isAnyChildOnHold() - Method in interface com.ibm.jarm.api.core.Holdable
Indicates whether or not any hierarchical child RecordContainer or Record is currently on hold.
isAnyParentClosed() - Method in interface com.ibm.jarm.api.core.RecordContainer
Indicates whether any parent of this RecordContainer up to the file plan level is currently in the closed state.
isAnyParentOnHold() - Method in interface com.ibm.jarm.api.core.Holdable
Indicates whether or not any hierarchical parent container of this entity is currently on hold.
isCategoryNameConsistentWithPattern(String, Container) - Static method in class com.ibm.jarm.api.util.NamingUtils
This procedure validates the proposed name for a record category based on the naming pattern.
isCBRConditionOnly() - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Indicates if this content search definition contains CBR conditions only.
isCBREnabled() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Specifies whether this class (or an included property) is enabled for full text indexing (content-based retrieval).
isCBREnabled() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionString
Specifies whether a property that is based on this property description is enabled for full text indexing (content-based retrieval).
isClosed() - Method in interface com.ibm.jarm.api.core.RecordContainer
Indicates whether or not this RecordContainer is currently in the closed state.
isCreationPending() - Method in interface com.ibm.jarm.api.core.BaseEntity
Returns true if this instance represents a new entity that has not been saved to a repository.
isCurrentUserInAnyRole(List<RMRole>) - Method in interface com.ibm.jarm.api.security.RMRoles
Indicates whether the current user is a member of any of the specified RMRole instances.
isCurrentUserInRole() - Method in interface com.ibm.jarm.api.security.RMRole
Indicates whether the current user is a member of this RMRole.
IsDeleted - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
isDirty() - Method in interface com.ibm.jarm.api.property.RMProperties
Indicates if this property collection has been modified since the last time that its corresponding repository entity has been saved.
isDirty() - Method in interface com.ibm.jarm.api.property.RMProperty
Indicates if the value of this property has been modified since the last time that its corresponding repository entity was saved.
IsDynamicHold - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
isEligibleForConversion(String) - Method in interface com.ibm.jarm.api.core.DefensiblyDisposable
Indicates whether or not this container is eligible for conversion into a "Defensibly Disposable" container.
isEligibleForDeclaration() - Method in interface com.ibm.jarm.api.core.ContentItem
Indicates whether or not this content item is currently eligible for record declaration.
isEmpty() - Method in interface com.ibm.jarm.api.collection.PageableSet
Indicates whether the associated collection is empty or not.
isEmpty() - Method in interface com.ibm.jarm.api.core.AlternateRetentionList
Indicates whether or not this collection is currently empty.
isEmpty() - Method in interface com.ibm.jarm.api.core.DispositionPhaseList
Indicates whether or not this collection is currently empty.
IsFinalPhaseCompleted - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
isFolderNameConsistentWithPattern(String, Container) - Static method in class com.ibm.jarm.api.util.NamingUtils
This procedure validates the name for a record folder based on the naming pattern.
isForClassified() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not the property is a DoD Classified-specific property.
isForDeclare() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not the property should be involved during an initial record declaration process.
isHidden() - Method in interface com.ibm.jarm.api.meta.RMClassDescription
Indicates whether or not this class description describes a hidden class.
isHidden() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not this property description describes a hidden property.
IsHiddenContainer - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
isHierarchical() - Method in interface com.ibm.jarm.api.meta.RMMarkingSet
Indicates whether or not the marking set has a hierarchical nature.
isInactive() - Method in interface com.ibm.jarm.api.core.RecordContainer
Indicates if this RecordContainer has been set to Inactive.
isNamingPatternValid(String) - Static method in class com.ibm.jarm.api.util.NamingUtils
This procedure validates whether a naming pattern is valid.
isOnHold(boolean) - Method in interface com.ibm.jarm.api.core.Holdable
Indicates whether or not this entity is currently on hold.
isOpen() - Method in interface com.ibm.jarm.api.core.RecordContainer
Indicates whether or not this RecordContainer is currently in the open state.
isOrderable() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not a property that is based on this property description can appear within an ORDER BY clause of an SQL query statement.
IsPermanentRecord - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
isPhysicalRecord() - Method in interface com.ibm.jarm.api.core.Record
Indicates whether or not this is a physical record.
isPhysicalRecordContainer() - Method in interface com.ibm.jarm.api.core.RecordContainer
Indicates whether or not this RecordContainer is considered a "physical" record container.
isPlaceholder() - Method in interface com.ibm.jarm.api.core.BaseEntity
Returns true if this instance currently represents a placeholder for an actual repository entity.
isPrincipalInRole(RMPrincipal) - Method in interface com.ibm.jarm.api.security.RMRole
Indicates whether a specific principal is a member of this RMRole.
isPropertyPresent(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Indicates if the collection contains a RMProperty instance corresponding to the specified symbolic name.
isReadOnly() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not this property description describes a read only property.
isReadyForInitiateDisposition() - Method in interface com.ibm.jarm.api.core.Dispositionable
Indicates whether or not this Dispositionable instance is ready for initiation of its next disposition step.
isRecordMultiFilingEnabled() - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Indicates whether or not this file plan repository allows a record to be filed in more than one container.
isRecordNameConsistentWithPattern(String, Container) - Static method in class com.ibm.jarm.api.util.NamingUtils
This procedure validates a proposed name for a record based on the naming pattern for its container.
isReopened() - Method in interface com.ibm.jarm.api.core.RecordContainer
Indicates whether or not this RecordContainer has been reopened from the closed state.
isRequired() - Method in class com.ibm.jarm.api.query.ReportParameter
Indicates whether or not this particular parameter is required.
isRMSystemProperty() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not the property is considered an "RMSystem" property.
IsScreeningRequired - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
isScreeningRequired() - Method in interface com.ibm.jarm.api.core.DispositionPhase
Returns true if screening is required for this disposition phase, false otherwise.
isScreeningRequired() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the IsScreeningRequired property value of this disposition schedule.
isSearchable() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not a property that is based on this property description can be used as part of an SQL query statement's search criteria.
isSelectable() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not a property that is based on this property description can be used as part of an SQL query statement's selection criteria.
isSettable() - Method in interface com.ibm.jarm.api.property.RMProperty
Indicates whether the value of this property can be set.
IssuedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
isSuperseded() - Method in interface com.ibm.jarm.api.core.Record
Indicates whether or not this Record has been superseded by another record.
isSystemGenerated() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not the value of a property that is based on this property description is automatically generated by the repository.
isSystemOwned() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not the value of a property that is based on this property description is originally created by the repository as opposed to being user-created.
IsTriggerChanged - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
isTriggerChanged() - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Returns the IsTriggerChanged property value of this disposition schedule.
isValueRequired() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not a value is required for a property that is based on this property description.
isVital() - Method in interface com.ibm.jarm.api.core.Vitalable
Indicates whether or not this object is actually a Vitalable object.
IsVitalRecord - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
iterator() - Method in interface com.ibm.jarm.api.collection.PageableSet
Provides a parameterized Iterator instance for the elements in the collection.
iterator() - Method in interface com.ibm.jarm.api.core.AlternateRetentionList
Returns an iterator over the contents of this collection.
iterator() - Method in interface com.ibm.jarm.api.core.DispositionPhaseList
Returns an iterator over the contents of this collection.
iterator() - Method in interface com.ibm.jarm.api.security.RMRoles
Returns an Iterator for this collection.

J

JarmLogger - Class in com.ibm.jarm.api.util
For internal use only.
JarmTracer - Class in com.ibm.jarm.api.util
For internal use only.
JarmTracer.SubSystem - Enum in com.ibm.jarm.api.util
Defines subsystems within JARM that are used for trace support.

L

LastPatternIndex - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
LastReviewedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
LastReviewedDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
LastSweepDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
launchWorkflows(List<BaseEntity>, String, int, Object) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Launches one or more PE Workflow instances for the specified entitites.
Link - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Link class.
LinkName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
LocaleName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Location - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Location class.
Location - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Location - Interface in com.ibm.jarm.api.core
An interface that represents a Location custom object.
LocationName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 

M

MarkingSet - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Pseudo class name for marking set.
MaxDeclassificationOffset - Static variable in interface com.ibm.jarm.api.core.SystemConfiguration
 
MaxWorkflowBatchSize - Static variable in interface com.ibm.jarm.api.core.SystemConfiguration
 
MediaType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
MemberOfGroups - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
MESSAGE_ID_PREFIX - Static variable in exception com.ibm.jarm.api.exception.RMRuntimeException
The prefix string for all logging message ID key values.
MESSAGE_ID_SUFFIX - Static variable in exception com.ibm.jarm.api.exception.RMRuntimeException
The Severity suffix character used for all RMRuntimeException Message IDs.
MessageInfo - Interface in com.ibm.jarm.api.exception
This interface provides access to the available set of localized information associated with a given error code for a specific RMRuntimeException.
MethodOfDestruction - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
MimeType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
MinimumPropertySet - Static variable in class com.ibm.jarm.api.property.RMPropertyFilter
A constant RMPropertyFilter instance that indicates that the default minimum set of properties should be retrieved for the entity in question.
ModifiedProperties - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
move(RecordContainer, RecordContainer, String) - Method in interface com.ibm.jarm.api.core.Record
Moves this record from the specified source RecordContainer into the specified destination RecordContainer.
move(RecordCategoryContainer, String) - Method in interface com.ibm.jarm.api.core.RecordCategory
Moves this RecordCategory instance into the specified RecordCategoryContainer parent.
move(RecordFolderContainer, String) - Method in interface com.ibm.jarm.api.core.RecordFolder
Moves this RecordFolder into the specified destination RecordFolderContainer.
moveRecords(FilePlanRepository, List<String>, String, String, String) - Static method in class com.ibm.jarm.api.core.BulkOperation
Moves each of the specified Record entities from the specified source RecordContainer to the specified destination RecordContainer

N

Name - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
NamingPattern - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Naming Pattern class.
NamingPattern - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
NamingPattern - Interface in com.ibm.jarm.api.core
An interface that represents a Pattern custom object.
NamingPatternLevel - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Naming Pattern Level class.
NamingPatternLevel - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
NamingPatternLevel - Interface in com.ibm.jarm.api.core
An interface that represents a PatternLevel custom object.
NamingPatternSequence - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Naming Pattern Sequences class.
NamingPatternSequence - Interface in com.ibm.jarm.api.core
An interface that represents a PatternSequences custom object.
NamingUtils - Class in com.ibm.jarm.api.util
A utility class that provides support for auto-generated entity names and validation of such.
nextPage() - Method in interface com.ibm.jarm.api.collection.RMPageIterator
Moves the iterator to the next page of the collection.
NextVersionRecord - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 

O

ObjectChangeAuditEvent - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Base class for "interesting" audit event classes.
OnHold - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Operator - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
OriginalObject - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
OriginatingOrganization - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 

P

P8_STANZA_EJB - Static variable in class com.ibm.jarm.api.util.RMUserContext
Potential value to use for the stanzaName input parameter of the RMUserContext.createSubject(DomainConnection, String, String, String) method.
P8_STANZA_WSI - Static variable in class com.ibm.jarm.api.util.RMUserContext
Potential value to use for the stanzaName input parameter of the RMUserContext.createSubject(DomainConnection, String, String, String) method.
P8CE_Convert - Class in com.ibm.jarm.api.util
Public utility class that provides static convenience methods to allow for conversions between P8CE (JACE) and JARM for various types.
PageableSet<T> - Interface in com.ibm.jarm.api.collection
A parameterized Set collection that supports paging.
pageIterator() - Method in interface com.ibm.jarm.api.collection.PageableSet
Provides a RMPageIterator that you can use to page through the elements in the collection.
Parent - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ParentIdentifier - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
parseContent() - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
PathName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PatternLevel - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PatternLevelNumber - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PatternName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PatternReference - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PatternString - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PDFRecord - Static variable in interface com.ibm.jarm.api.constants.RMClassName
PDF Record class.
Permissions - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Persistable - Interface in com.ibm.jarm.api.core
An interface to represent those entities whose property and permission state can be persisted to their respective repository.
Phase - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Phase class (as part of a disposition schedule).
PhaseAction - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PhaseEffectiveDateModified - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PhaseName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PhaseNumber - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PhysicalContainer - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Physical Container folder class.
PhysicalRecord - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Physical Record class.
PhysicalRecordFolder - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Physical Record Folder folder class.
placeHold(Hold) - Method in interface com.ibm.jarm.api.core.Holdable
Place the specified Hold on this entity.
placeHolds(FilePlanRepository, List<BulkOperation.EntityDescription>, List<String>) - Static method in class com.ibm.jarm.api.core.BulkOperation
Each specified Hold is placed on each specified RecordCategory, RecordFolder, RecordVolume and/or Record entity.
PreventDelete - Static variable in interface com.ibm.jarm.api.constants.RMPreventDelete
Indicates that delete prevention is in effect.
PreventRMEntityDeletion - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PreviousVersionRecord - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PropertyDataType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PropertyName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PropertyValue - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
PSS_Atlas - Static variable in interface com.ibm.jarm.api.constants.ExternalManagementAgent
Indicates that an entity is under the management control of the IBM PSS Atlas application.
PublicationDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
putBinaryListValue(String, List<byte[]>) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type multi-valued DataType.Binary based on the specified symbolic name.
putBinaryValue(String, byte[]) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type single-valued DataType.Binary based on the specified symbolic name.
putBooleanListValue(String, List<Boolean>) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type multi-valued DataType.Boolean based on the specified symbolic name.
putBooleanValue(String, Boolean) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type single-valued DataType.Boolean based on the specified symbolic name.
putDateTimeListValue(String, List<Date>) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type multi-valued DataType.DateTime based on the specified symbolic name.
putDateTimeValue(String, Date) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type single-valued DataType.DateTime based on the specified symbolic name.
putDoubleListValue(String, List<Double>) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type multi-valued DataType.Double based on the specified symbolic name.
putDoubleValue(String, Double) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type single-valued DataType.Double based on the specified symbolic name.
putGuidListValue(String, List<String>) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type multi-valued DataType.Guid based on the specified symbolic name.
putGuidValue(String, String) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type single-valued DataType.Guid based on the specified symbolic name.
putIntegerListValue(String, List<Integer>) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type multi-valued DataType.Integer based on the specified symbolic name.
putIntegerValue(String, Integer) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type single-valued DataType.Integer based on the specified symbolic name.
putObjectListValue(String, List<Object>) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type multi-valued DataType.Object based on the specified symbolic name.
putObjectValue(String, Object) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type single-valued DataType.Object based on the specified symbolic name.
putStringListValue(String, List<String>) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type multi-valued DataType.String based on the specified symbolic name.
putStringValue(String, String) - Method in interface com.ibm.jarm.api.property.RMProperties
Adds a new property to this collection or updates an existing property of this collection of type single-valued DataType.String based on the specified symbolic name.
putSystemConfiguration(String, String) - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Updates (or adds) the SystemConfiguration instance identified by the propertyName parameter using the given propertyValue parameter to this file plan repository.

R

Reason - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReasonForAction - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReasonForChange - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReasonForClose - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReasonForInactivate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReasonForReclassification - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReasonsForClassification - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReasonsForUpgrade - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
recalculateCutoffDate(Dispositionable) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Recalculates the cutoff date for the given entity based upon this disposition schedule.
RecalculatePhaseRetention - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReceiptOf - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Receipts - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReceiptStatus - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReceivedOn - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RECORD - Static variable in interface com.ibm.jarm.api.constants.Aggregation
Indicates aggregation at the record level.
Record - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Base Record class.
Record - Interface in com.ibm.jarm.api.core
An interface that represents a RecordInfo-class object.
RECORD_CATEGORY - Static variable in interface com.ibm.jarm.api.constants.Aggregation
Indicates aggregation at the record category level.
RECORD_FOLDER - Static variable in interface com.ibm.jarm.api.constants.Aggregation
Indicates aggregation at the record folder level.
RECORD_VOLUME - Static variable in interface com.ibm.jarm.api.constants.Aggregation
Indicates aggregation at the record volume level.
RecordCategory - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Record Category folder class.
RecordCategory - Interface in com.ibm.jarm.api.core
Represents a container that can directly contain other RecordCategory instances or RecordFolder instances, and can also directly contain Record instances.
RecordCategoryContainer - Interface in com.ibm.jarm.api.core
Represents a container capable of containing RecordCategory instances.
RecordCategoryDescription - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RecordCategoryIdentifier - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RecordCategoryName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RecordContainer - Interface in com.ibm.jarm.api.core
Represents a container capable of directly or indirectly containing Record instances.
RecordContainerHoldLink - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Record Container Hold Link class.
RecordCopyLink - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Record Copy Link class.
RecordedDocuments - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RecordFolder - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Record Folder folder class.
RecordFolder - Interface in com.ibm.jarm.api.core
Represents a container that directly contains either other RecordFolder instances or RecordVolume instances, and might also directly contain Record instances (See the RecordContainer.requiresChildVolume() method).
RecordFolderContainer - Interface in com.ibm.jarm.api.core
Represents a container capable of containing RecordFolder instances.
RecordFolderIdentifier - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RecordFolderName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RecordFolderSeeAlsoLink - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Record Folder See Also Link class.
RecordHoldLink - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Record Hold Link class.
RecordInformation - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RecordPattern - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RecordSeeAlsoLink - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Record See Also Link class.
RecordType - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Record Type class.
RecordType - Interface in com.ibm.jarm.api.core
An interface that represents a RecordType custom object that is used to associate a specific DispositionSchedule to an individual Record instance.
RecordTypeName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RecordVersionNumber - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RecordVolume - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Record Volume folder class.
RecordVolume - Interface in com.ibm.jarm.api.core
Represents a sub-container used within some types of RecordFolder instances to container Record instances.
RecordVolumeContainer - Interface in com.ibm.jarm.api.core
Represents a container capable of containing RecordVolume instances.
ReferenceLink - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Reference Link class.
ReferentialContainmentRelationship - Static variable in interface com.ibm.jarm.api.constants.RMClassName
ReferentialContainmentRelationship class.
refresh() - Method in interface com.ibm.jarm.api.core.BaseEntity
Retrieves the entity from its repository updating the values of its existing internally cached properties.
refresh(String[]) - Method in interface com.ibm.jarm.api.core.BaseEntity
Retrieves the entity from its repository updating the values of the specified properties.
refresh(RMPropertyFilter) - Method in interface com.ibm.jarm.api.core.BaseEntity
Retrieves the entity from its repository updating its internal property cached based upon the supplied RMPropertyFilter.
Remarks - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
remove(int) - Method in interface com.ibm.jarm.api.core.AlternateRetentionList
Removes the AlternateRetention instance at the specified 1-based ordinal position.
remove(AlternateRetention) - Method in interface com.ibm.jarm.api.core.AlternateRetentionList
Removes the AlternateRetention instance from this collection.
remove(String) - Method in interface com.ibm.jarm.api.core.AlternateRetentionList
Removes the identified AlternateRetention instance from this collection.
remove(int) - Method in interface com.ibm.jarm.api.core.DispositionPhaseList
Removes the DispositionPhase instance at the specified 1-based ordinal position.
remove(DispositionPhase) - Method in interface com.ibm.jarm.api.core.DispositionPhaseList
Removes the DispositionPhase instance from this collection.
remove(String) - Method in interface com.ibm.jarm.api.core.DispositionPhaseList
Removes the DispositionPhase instance specified by its Id string.
remove(String) - Method in interface com.ibm.jarm.api.property.RMProperties
Removes the specified RMProperty from this collection.
remove(String[]) - Method in interface com.ibm.jarm.api.property.RMProperties
Removes the specified RMProperty instances from this collection as specified by their individual symbolic name.
removeAllReportQueries() - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
removeHold(Hold) - Method in interface com.ibm.jarm.api.core.Holdable
Remove the specified Hold from this entity.
removeHolds(FilePlanRepository, BulkOperation.EntityDescription, List<String>) - Static method in class com.ibm.jarm.api.core.BulkOperation
Each specified Hold is removed from the specified RecordCategory, RecordFolder, RecordVolume or Record entity.
removeMember(RMPrincipal) - Method in interface com.ibm.jarm.api.security.RMRole
Removes the specified RMPrincipal from this RMRole.
RenditionLink - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Rendition Link class.
reopen() - Method in interface com.ibm.jarm.api.core.RecordContainer
Reopens a RecordContainer that is currently closed.
reopenContainers(FilePlanRepository, List<String>) - Static method in class com.ibm.jarm.api.core.BulkOperation
Performs reopen on each of the specified RecordCategory, RecordFolder and/or RecordVolume entities.
ReopenedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReopenedDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReportDefinition - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Report class.
ReportDefinition - Interface in com.ibm.jarm.api.core
An interface that defines an IBM Enterprise Records report definition entity.
ReportHoldings - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Report Holdings class.
ReportParameter - Class in com.ibm.jarm.api.query
Class that represents a single parameter that is used as part of a ReportDefinition.
ReportParameter(String, boolean) - Constructor for class com.ibm.jarm.api.query.ReportParameter
Constructor.
ReportTitle - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Repository - Interface in com.ibm.jarm.api.core
Base repository interface.
RepositoryName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RepositoryType - Enum in com.ibm.jarm.api.constants
Enumerated values that define a particular type of repository with respect to IBM Enterprise Records.
RepositoryType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RequestDefaultDeclassificationDateUpdate - Static variable in interface com.ibm.jarm.api.core.SystemConfiguration
 
requiresChildVolume() - Method in interface com.ibm.jarm.api.core.RecordContainer
Indicates whether or not this RecordContainer requires the use of a child RecordVolume instance to contain Record instances.
requiresUniqueElements() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescription
Indicates whether or not the values of a multi-valued property that is based on this property description must be unique with respect to each other.
reset(RMPageMark) - Method in interface com.ibm.jarm.api.collection.RMPageIterator
Resets the page iterator back to the specified set of results as defined by a RMPageMark instance.
reset() - Method in interface com.ibm.jarm.api.collection.RMPageIterator
Positions the page iterator to a point just before the first page of results.
resetDispositionData() - Method in interface com.ibm.jarm.api.core.Dispositionable
Re-initializes any disposition-related state on the associated entity.
resetVitalData() - Method in interface com.ibm.jarm.api.core.Dispositionable
Re-initializes any vital review-related state on the associated entity.
ResultRow - Interface in com.ibm.jarm.api.query
A ResultRow instance represents a single result from a RMSearch.fetchRows operation.
RetainMetadata - Enum in com.ibm.jarm.api.constants
Enumerated values for Retain Metadata option.
RetainMetadata - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RetentionBase - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RetentionNumber - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RetentionPeriodDays - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RetentionPeriodMonths - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RetentionPeriodYears - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
review(RMProperties) - Method in interface com.ibm.jarm.api.core.Dispositionable
Updates the review state of this entity based on the contents of the given RMProperties collection.
ReviewedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReviewedOn - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Reviewer - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ReviewRemarks - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RMAccessLevel - Enum in com.ibm.jarm.api.constants
Defines common RMAccessRight combinations that can be assigned to a RMPermission instance via the RMPermission.setAccessMask method.
RMAccessRight - Enum in com.ibm.jarm.api.constants
Defines individual access rights that can be assigned to a RMPermission instance using the RMPermission.setAccessMask method or retrieved using the RMPermission.getAccessMask method.
RMAccessType - Enum in com.ibm.jarm.api.constants
Indicates whether a RMPermission instance represents an allowed or denied set of access rights.
RMAuditEvent - Static variable in interface com.ibm.jarm.api.constants.RMClassName
RM Audit Event class.
RMCardinality - Enum in com.ibm.jarm.api.constants
Indicates the cardinality of a RMProperty or RMPropertyDescription instance.
RMChoiceItem - Interface in com.ibm.jarm.api.meta
Represents a single member of a RMChoiceList collection that can be either an individual choice node or a group node of nested choices.
RMChoiceList - Interface in com.ibm.jarm.api.meta
Represents a collection of allowed selection items that can be associated with a particular RMPropertyDescription.
RMClassDescription - Interface in com.ibm.jarm.api.meta
Repository class metadata description.
RMClassName - Interface in com.ibm.jarm.api.constants
Repository-independent class symbolic name string constants.
RMContentElement - Interface in com.ibm.jarm.api.core
Represents a single document content binary or reference type that can be contained by a ContentItem.
RMContentSearchDefinition - Class in com.ibm.jarm.api.query
Abstract class RMContentSearchDefinition defines the content-based retrieval query, such as query conditions for both CBR and metadata, the results to return, the sort order and so on.
RMContentSearchDefinition() - Constructor for class com.ibm.jarm.api.query.RMContentSearchDefinition
Default constructor
RMContentSearchDefinition(String, String, String, String, String, String, RMContentSearchDefinition.SortOrder, RMContentSearchDefinition.OrderBy, boolean) - Constructor for class com.ibm.jarm.api.query.RMContentSearchDefinition
Constructs a new instance.
RMContentSearchDefinition.AndOrOper - Enum in com.ibm.jarm.api.query
Defines an enumeration type of and/or operator.
RMContentSearchDefinition.ContentSearchOption - Enum in com.ibm.jarm.api.query
Defines cbr search on content or on property
RMContentSearchDefinition.OrderBy - Enum in com.ibm.jarm.api.query
Defines an enumeration type of order by: either by metadata, by CBR scores or no order.
RMContentSearchDefinition.SortOrder - Enum in com.ibm.jarm.api.query
Defines an enumeration type of sort order possibilities.
RMCustomObject - Interface in com.ibm.jarm.api.core
Represents the base interface for all CustomObject-based entities.
RMDeletionAction - Enum in com.ibm.jarm.api.constants
Enumeration of applicable values used to describe the delete action associated with an Object-type property that is involved in a reflective relationship.
RMDomain - Interface in com.ibm.jarm.api.core
Represents a domain in which repositories reside.
RMEntityDescription - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RMEntityType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RMErrorCode - Enum in com.ibm.jarm.api.exception
Enumerated values representing the RMRuntimeException exception messages.
RMErrorRecord - Interface in com.ibm.jarm.api.exception
Represents a single repository error condition that is part of a chain of errors.
RMErrorStack - Interface in com.ibm.jarm.api.exception
Represents a collection of RMErrorRecord instances returned from a repository.
RMFactory - Class in com.ibm.jarm.api.core
Main factory used to create/retrieve instances of the various JARM entity types.
RMFactory.BaseEntity - Class in com.ibm.jarm.api.core
Factory for generalized BaseEntity instances.
RMFactory.ClassificationGuide - Class in com.ibm.jarm.api.core
Factory for ClassificationGuide instances.
RMFactory.Container - Class in com.ibm.jarm.api.core
Factory for Container instances.
RMFactory.ContentItem - Class in com.ibm.jarm.api.core
Factory for ContentItem instances.
RMFactory.ContentRepository - Class in com.ibm.jarm.api.core
Factory for ContentRepository instances.
RMFactory.DispositionAction - Class in com.ibm.jarm.api.core
Factory for DispositionAction instances.
RMFactory.DispositionSchedule - Class in com.ibm.jarm.api.core
Factory for DispositionSchedule instances.
RMFactory.DispositionTrigger - Class in com.ibm.jarm.api.core
Factory for DispositionTrigger instances.
RMFactory.DomainConnection - Class in com.ibm.jarm.api.core
Factory for DomainConnection instances.
RMFactory.FilePlan - Class in com.ibm.jarm.api.core
Factory for FilePlan instances.
RMFactory.FilePlanRepository - Class in com.ibm.jarm.api.core
Factory for FilePlanRepository instances.
RMFactory.Hold - Class in com.ibm.jarm.api.core
Factory for Hold instances.
RMFactory.Location - Class in com.ibm.jarm.api.core
Factory for Location instances.
RMFactory.NamingPattern - Class in com.ibm.jarm.api.core
Factory for NamingPattern instances.
RMFactory.NamingPatternSequence - Class in com.ibm.jarm.api.core
Factory for NamingPatternSequence instances.
RMFactory.Record - Class in com.ibm.jarm.api.core
Factory for Record instances.
RMFactory.RecordCategory - Class in com.ibm.jarm.api.core
Factory for RecordCategory instances.
RMFactory.RecordFolder - Class in com.ibm.jarm.api.core
Factory for RecordFolder instances.
RMFactory.RecordType - Class in com.ibm.jarm.api.core
Factory for RecordType instances.
RMFactory.RecordVolume - Class in com.ibm.jarm.api.core
Factory for RecordVolume instances.
RMFactory.ReportDefinition - Class in com.ibm.jarm.api.core
Factory for ReportDefinition instances.
RMFactory.Repository - Class in com.ibm.jarm.api.core
Factory for Repository instances.
RMFactory.RMChoiceList - Class in com.ibm.jarm.api.core
Factory for RMChoiceList instances.
RMFactory.RMClassDescription - Class in com.ibm.jarm.api.core
Factory for RMClassDescription instances.
RMFactory.RMCustomObject - Class in com.ibm.jarm.api.core
Factory for RMCustomObject instances.
RMFactory.RMDomain - Class in com.ibm.jarm.api.core
Factory for RMDomain instances.
RMFactory.RMGroup - Class in com.ibm.jarm.api.core
Factory for RMUser instances.
RMFactory.RMLink - Class in com.ibm.jarm.api.core
Factory for RMLink instances.
RMFactory.RMMarkingSet - Class in com.ibm.jarm.api.core
Factory for RMMarkingSet instances.
RMFactory.RMPermission - Class in com.ibm.jarm.api.core
Factory for RMPermission instances.
RMFactory.RMProperties - Class in com.ibm.jarm.api.core
Factory for RMProperties collection instances.
RMFactory.RMUser - Class in com.ibm.jarm.api.core
Factory for RMUser instances.
RMFactory.WorkflowDefinition - Class in com.ibm.jarm.api.core
Factory for RMWorkflowDefinition instances.
RMFilteredPropertyType - Enum in com.ibm.jarm.api.property
Enumerated type used to optionally define the data-type for a RMPropertyFilter or RMFilterElement instance.
RMFilterElement - Class in com.ibm.jarm.api.property
RMFilterElement instances are used in conjunction with a parent RMPropertyFilter to define the type of property values to be returned for various fetch and query results, including recursion control for object-type property values.
RMFilterElement(Integer, Long, Boolean, RMFilteredPropertyType, Integer) - Constructor for class com.ibm.jarm.api.property.RMFilterElement
Constructs a new RMFilterElement instance.
RMFilterElement(Integer, Long, Boolean, String, Integer) - Constructor for class com.ibm.jarm.api.property.RMFilterElement
Constructs a new RMFilterElement instance.
RMFolder - Static variable in interface com.ibm.jarm.api.constants.RMClassName
RM Folder base class.
RMGranteeType - Enum in com.ibm.jarm.api.constants
Enumerated type defining allowable values for RMPermission grantee type.
RMGroup - Interface in com.ibm.jarm.api.security
Represents an individual user group defined for a domain.
RMLink - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Base RM Link Class.
RMLink - Interface in com.ibm.jarm.api.core
Base interface for all IBM Enterprise Records RMLink instances.
RMLogCode - Enum in com.ibm.jarm.api.util
For internal use only.
RMLString - Class in com.ibm.jarm.api.util
For internal use only. Class used to retrieve localized strings that are used within JARM (as opposed to those used for exception and logging messages).
RMLString() - Constructor for class com.ibm.jarm.api.util.RMLString
 
RMMarkingItem - Interface in com.ibm.jarm.api.meta
Represents a single member of a RMMarkingSet.
RMMarkingSet - Interface in com.ibm.jarm.api.meta
Represents a collection of RMMarkingItem instances.
RMMergeMode - Enum in com.ibm.jarm.api.constants
Controls how non-CBR search results are merged when multiple repositories are involved.
RMPageIterator<T> - Interface in com.ibm.jarm.api.collection
A parameterized paging, read-only iterator interface.
RMPageMark - Interface in com.ibm.jarm.api.collection
Identifies the page representing the current continuation state of a RMPageIterator instance.
RMPermission - Interface in com.ibm.jarm.api.security
A RMPermission instance represents an access control entry (ACE) associated with a repository object that grants or denies specific access rights to a particular user or group.
RMPermissionSource - Enum in com.ibm.jarm.api.constants
Indicates the source of a specific access permission.
RMPreventDelete - Interface in com.ibm.jarm.api.constants
Pre-defined string of constant values for entity prevention.
RMPrincipal - Interface in com.ibm.jarm.api.security
Base interface representing either a user or group.
RMPrincipalSearchAttribute - Enum in com.ibm.jarm.api.constants
Specifies which property attribute a security principal search pattern should be applied against.
RMPrincipalSearchSortType - Enum in com.ibm.jarm.api.constants
Defines the sorting option that should be applied to any RMPrincipal search results.
RMPrincipalSearchType - Enum in com.ibm.jarm.api.constants
Specifies how pattern-matching is to be applied during a search for RMGroup or RMUser
RMProperties - Interface in com.ibm.jarm.api.property
Specialized collection for RMProperty instances.
RMProperty - Interface in com.ibm.jarm.api.property
Represents a single property value that is a member of a RMProperties collection.
RMPropertyDescription - Interface in com.ibm.jarm.api.meta
Base interface for all RMPropertyDescription sub-interfaces.
RMPropertyDescriptionBinary - Interface in com.ibm.jarm.api.meta
Metadata description for a property of type DataType.Binary
RMPropertyDescriptionBoolean - Interface in com.ibm.jarm.api.meta
Metadata description for a property of type DataType.Boolean.
RMPropertyDescriptionDateTime - Interface in com.ibm.jarm.api.meta
Metadata description for a property of type DataType.DateTime
RMPropertyDescriptionDouble - Interface in com.ibm.jarm.api.meta
Metadata description for a property of type DataType.Double
RMPropertyDescriptionGuid - Interface in com.ibm.jarm.api.meta
Metadata description for a property of type DataType.Guid
RMPropertyDescriptionInteger - Interface in com.ibm.jarm.api.meta
Metadata description for a property of type DataType.Integer
RMPropertyDescriptionObject - Interface in com.ibm.jarm.api.meta
Metadata description for a property of type DataType.Object
RMPropertyDescriptionString - Interface in com.ibm.jarm.api.meta
Metadata description for a property of type DataType.String
RMPropertyFilter - Class in com.ibm.jarm.api.property
Defines a specific set of properties to return and/or exclude during an entity retrieval from a repository.
RMPropertyFilter() - Constructor for class com.ibm.jarm.api.property.RMPropertyFilter
Constructs a new RMPropertyFilter instance.
RMPropertyName - Interface in com.ibm.jarm.api.constants
Repository-independent property symbolic name string constants.
RMPropertySettability - Enum in com.ibm.jarm.api.constants
Enumeration of applicable values for a RMPropertyDescription.getSettability method return value.
RMReceiptStatus - Enum in com.ibm.jarm.api.constants
Enumeration of supported Record receipt status values.
RMRefreshMode - Enum in com.ibm.jarm.api.constants
Specifies whether to retrieve refreshed property data from the repository when an object is explicitly saved.
RMReportEntityType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RMReportTitle - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RMRetentionPeriod - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RMRetentionTriggerPropertyName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RMRole - Interface in com.ibm.jarm.api.security
Represents a function access control role consisting of a collection of RMPrincipal members for the custom Role class.
RMRoles - Interface in com.ibm.jarm.api.security
Represents a collection of RMRole instances.
RMRuntimeException - Exception in com.ibm.jarm.api.exception
Primary exception class for the JARM API.
RMSearch - Class in com.ibm.jarm.api.query
Class used to perform non-CBR repository search operations.
RMSearch(Repository) - Constructor for class com.ibm.jarm.api.query.RMSearch
Constructs an RMSearch instance whose search scope is a single given repository.
RMSearch(Repository[], RMMergeMode) - Constructor for class com.ibm.jarm.api.query.RMSearch
Constructs an RMSearch instance whose search scope is a collection of given repositories.
RMSecurityProxyType - Enum in com.ibm.jarm.api.constants
Enumeration of applicable values defining any security proxy behavior associated with an object-type property.
RMSystem - Static variable in interface com.ibm.jarm.api.constants.RMClassName
RMSystem class.
RMUser - Interface in com.ibm.jarm.api.security
Represents an individual user defined for the domain.
RMUserContext - Class in com.ibm.jarm.api.util
This class manages per-thread user locale and authentication information.
RMValidationOptions - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RMVersionInfo - Static variable in interface com.ibm.jarm.api.core.SystemConfiguration
 
RMWorkflowDefinition - Interface in com.ibm.jarm.api.core
Represents an IBM Enterprise Records-related Workflow Definition.
RMWorkflowStatus - Enum in com.ibm.jarm.api.constants
Enumeration of possible Workflow status values.
RoleName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RolePrivileges - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
RoleType - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 

S

save(RMRefreshMode) - Method in interface com.ibm.jarm.api.core.Persistable
Saves the current property and permission state of this entity to its associated repository.
ScannedRecord - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Scanned Record class.
SchedulePropagation - Enum in com.ibm.jarm.api.constants
Enumerated type that controls how a DispositionSchedule assignment change to a given container is propagated to its sub-containers.
ScreeningWorkflow - Static variable in interface com.ibm.jarm.api.core.SystemConfiguration
 
SecuredRole - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SecuredRoleId - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SecurityFolder - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SecurityScriptRunDate - Static variable in interface com.ibm.jarm.api.core.SystemConfiguration
 
SentOn - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
ServerName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
set(RMUserContext) - Static method in class com.ibm.jarm.api.util.RMUserContext
Associates the specified RMUserContext instance with the current thread.
setAccessMask(int) - Method in interface com.ibm.jarm.api.security.RMPermission
Defines the specific rights either allowed or denied by this RMPermission instance.
setAccessMask(RMAccessLevel) - Method in interface com.ibm.jarm.api.security.RMPermission
Defines the specific rights either allowed or denied by this RMPermission instance.
setAccessMask(RMAccessRight...) - Method in interface com.ibm.jarm.api.security.RMPermission
Defines the specific rights either allowed or denied by this RMPermission instance.
setAccessType(RMAccessType) - Method in interface com.ibm.jarm.api.security.RMPermission
Defines the RMAccessType value that determines whether this an an "allow" or "deny" RMPermisson.
setActionName(String) - Method in interface com.ibm.jarm.api.core.DispositionAction
Sets the ActionName property value for this disposition action.
setActive() - Method in interface com.ibm.jarm.api.core.RecordContainer
Sets this RecordContainer as Active.
setActiveState(boolean) - Method in interface com.ibm.jarm.api.core.Hold
Set the active state for this hold instance.
setAggregation(String) - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Defines the required entity-type level to which this disposition trigger applies.
setAppliedFor(AppliedForCategoryOrFolder) - Method in interface com.ibm.jarm.api.core.NamingPatternLevel
Sets the AppliedFor property value.
setApplyToNameOrId(ApplyToNameOrID) - Method in interface com.ibm.jarm.api.core.NamingPattern
Sets the ApplyToNameOrId property value.
setAssociatedWorkflow(RMWorkflowDefinition) - Method in interface com.ibm.jarm.api.core.DispositionAction
Defines the RMWorkflowDefinition instance that is associated with this disposition action.
setBarcode(String) - Method in interface com.ibm.jarm.api.core.Location
Sets the BarcodeId property value.
setBinaryValue(byte[]) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Binary.
setBinaryValue(List<byte[]>) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Binary and whose cardinality is multi-valued.
setBooleanValue(Boolean) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Boolean.
setBooleanValue(List<Boolean>) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Boolean and whose cardinality is multi-valued.
setCalendarDate(Date) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Sets the CalendarDate property value for this disposition schedule.
setCBRConditionOnly(boolean) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set a boolean to indicate this content search definition contains CBR conditions only.
setCommonWhereClause(String) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set the where clause for common criteria.
setConditionXML(String) - Method in interface com.ibm.jarm.api.core.AlternateRetention
Sets the XML string fragment that describes the condition defined for this alternate retention.
setConditionXML(String) - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Sets an XML string fragment that describes the condition defined for this disposition trigger.
setConditionXML(String) - Method in interface com.ibm.jarm.api.core.Hold
Sets the value for the ConditionXML property value.
setContentSearch(String) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set content search keyword(s)
setContentSearchOption(RMContentSearchDefinition.ContentSearchOption) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set cbr search option between the content and property search.
setCutoffAction(DispositionAction) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Sets the DispositionAction that defines the Cutoff action for this DispositionSchedule.
setCutoffBase(String) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Sets the symbolic name of the property to be used as the cutoff base value.
setDateTime(Date) - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Sets the value of the DateTime property for this disposition trigger.
setDateTimeValue(Date) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.DateTime.
setDateTimeValue(List<Date>) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.DateTime and whose cardinality is multi-valued.
setDescription(String) - Method in interface com.ibm.jarm.api.core.DispositionAction
Sets the RMEntityDescription property value for this disposition action.
setDescription(String) - Method in interface com.ibm.jarm.api.core.DispositionPhase
Sets the RMEntityDescription property value for this disposition phase.
setDescription(String) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Sets the RMEntityDescription property value for this disposition schedule.
setDescription(String) - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Sets the RMEntityDescription property value for this disposition trigger.
setDescription(String) - Method in interface com.ibm.jarm.api.core.Location
Sets the RMEntityDescription property value.
setDescription(String) - Method in interface com.ibm.jarm.api.core.NamingPattern
Sets the RMEntityDescription property value.
setDescription(String) - Method in interface com.ibm.jarm.api.core.RecordType
Sets the RMEntityDescription property value.
setDescription(String) - Method in interface com.ibm.jarm.api.security.RMRole
Defines an optional description.
setDispositionAuthority(String) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Sets the AuthorizingStatute property value for this disposition schedule.
setDispositionEventOffset(Integer, Integer, Integer) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Sets the cutoff event offset time period for this disposition schedule.
setDispositionTigger(DispositionTrigger) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Sets the CutoffDisposalTrigger property value for this DispositionSchedule instance.
setDoubleValue(Double) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Double.
setDoubleValue(List<Double>) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Double and whose cardinality is multi-valued.
setEntryHelp(String) - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
setEntryHelpLocalizationKey(String) - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
setExportDestination(String) - Method in interface com.ibm.jarm.api.core.DispositionPhase
Sets the ExportDestination property value for this disposition phase.
setExportFormat(ContentItem) - Method in interface com.ibm.jarm.api.core.DispositionPhase
Sets the ExportFormat property value for this disposition phase.
setExternalEventOccurrenceDate(Date) - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Sets a Date value for the disposition trigger's ExternalEventOccurrenceDate property.
setFromClause(String) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set the from clause.
setGranteeName(String) - Method in interface com.ibm.jarm.api.security.RMPermission
Defines the name of the user or group that this RMPermission applies to.
setGuidValue(String) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Guid.
setGuidValue(List<String>) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Guid and whose cardinality is multi-valued.
setHoldName(String) - Method in interface com.ibm.jarm.api.core.Hold
Sets the HoldName property value.
setHoldReason(String) - Method in interface com.ibm.jarm.api.core.Hold
Sets the value for the HoldReason property value.
setHoldType(String) - Method in interface com.ibm.jarm.api.core.Hold
Sets the value for the HoldType property value.
setInactive(String) - Method in interface com.ibm.jarm.api.core.RecordContainer
Sets this RecordContainer as Inactive.
setIncrementedBy(Integer) - Method in interface com.ibm.jarm.api.core.NamingPatternLevel
Sets the IncrementedBy property value.
setInheritableDepth(Integer) - Method in interface com.ibm.jarm.api.security.RMPermission
Defines the inheritable depth level for this RMPermission.
setIntegerValue(Integer) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Integer.
setIntegerValue(List<Integer>) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Integer and whose cardinality is multi-valued.
setLastPatternIndex(Integer) - Method in interface com.ibm.jarm.api.core.FilePlan
Sets the value of the LastPatternIndex property for this file plan.
setLastPatternIndex(Integer) - Method in interface com.ibm.jarm.api.core.NamingPatternSequence
Sets the LastPatternIndex property value.
setLevelDependents(boolean) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Defines a global levelDependents for the RMPropertyFilter.
setLevelDependents(Boolean) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Defines a global levelDependents for the RMPropertyFilter.
setLocale(Locale) - Method in class com.ibm.jarm.api.util.RMUserContext
Sets the Locale for this user context.
setLocationName(String) - Method in interface com.ibm.jarm.api.core.Location
Sets the LocationName property value.
setMaxContentSize(long) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Defines a global maxContentSize for the RMPropertyFilter.
setMaxContentSize(Long) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Defines a global maxContentSize for the PropertyFilter.
setMaxRecursion(int) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Defines a global maxRecursion for the RMPropertyFilter.
setMaxRecursion(Integer) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Defines a global maxRecursion for the RMPropertyFilter.
setName(String) - Method in class com.ibm.jarm.api.query.ReportParameter
Sets the name value for this parameter.
setNamingPattern(NamingPattern) - Method in interface com.ibm.jarm.api.core.FilePlan
Defines a NamingPattern instance to be used for auto-naming of record categories and record folders contained within this file plan.
setObjectValue(Object) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Object.
setObjectValue(List<Object>) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.Object and whose cardinality is multi-valued.
setOperator(Integer) - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Sets the value of the Operator property for this disposition trigger.
setOperBtwContentAndMetadataSearch(RMContentSearchDefinition.AndOrOper) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set operator between the content and metadata search.
setOrderBy(RMContentSearchDefinition.OrderBy) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set the value to indicate the search is ordered by metadata, by CBR scores, or no order.
setOrderClause(String) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set the order clause.
setPageSize(int) - Method in interface com.ibm.jarm.api.collection.RMPageIterator
Defines the maximum number of elements for any subsequent RMPageIterator.getCurrentPage() method calls.
setPageSize(int) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Defines a global pageSize for the PropertyFilter.
setPageSize(Integer) - Method in class com.ibm.jarm.api.property.RMPropertyFilter
Defines a global pageSize for the PropertyFilter.
setParentIdentifier(String) - Method in interface com.ibm.jarm.api.core.NamingPatternSequence
Sets the ParentGUID property value.
setPatternLevelNumber(Integer) - Method in interface com.ibm.jarm.api.core.NamingPatternLevel
Sets the LevelNumber property value.
setPatternName(String) - Method in interface com.ibm.jarm.api.core.NamingPattern
Sets the PatternName property value.
setPatternString(String) - Method in interface com.ibm.jarm.api.core.NamingPatternLevel
Sets the PatternString property value.
setPermissions(List<RMPermission>) - Method in interface com.ibm.jarm.api.core.Persistable
Sets the given RMPermission collection for this entity.
setPhaseAction(DispositionAction) - Method in interface com.ibm.jarm.api.core.DispositionPhase
Assigns the specified DispositionAction to this disposition phase.
setPrivileges(String) - Method in interface com.ibm.jarm.api.security.RMRole
Sets the Privileges property value.
setPropertyName(String) - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Sets the value of the PropertyName property for this disposition trigger.
setPropertyValue(String) - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Sets the value of the PropertyValue property for this disposition trigger.
setReasonForChange(String) - Method in interface com.ibm.jarm.api.core.DispositionPhase
Sets the ReasonForChange property value for this disposition phase.
setReasonForChange(String) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Assigns a value to the ReasonForChange property.
setRecordTypeName(String) - Method in interface com.ibm.jarm.api.core.RecordType
Sets the RecordTypeName property value.
setRecurringCyclePeriod(Integer, Integer, Integer) - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Sets the recurring cycle period for a recurring trigger.
setReportDBTableName(String) - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
setReportDescription(String) - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
setReportDescriptionLocalizationKey(String) - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
setReportName(String) - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
setReportNameLocalizationKey(String) - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
setReportParameters(List<ReportParameter>) - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
setReportTitle(String) - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
setReportTitleLocalizationKey(String) - Method in interface com.ibm.jarm.api.core.ReportDefinition
 
setRequired(boolean) - Method in class com.ibm.jarm.api.query.ReportParameter
Sets whether or not this parameter is required.
setRetentionBase(String) - Method in interface com.ibm.jarm.api.core.AlternateRetention
Defines the DateTime-type property that is used as the retention base value by this alternate retention instance.
setRetentionPeriod(Integer, Integer, Integer) - Method in interface com.ibm.jarm.api.core.AlternateRetention
Sets the retention time period for this alternate retention.
setRetentionPeriod(int, int, int) - Method in interface com.ibm.jarm.api.core.DefensiblyDisposable
Updates the assigned retention period used by an existing Defensibly Disposable container.
setRetentionPeriod(Integer, Integer, Integer) - Method in interface com.ibm.jarm.api.core.DispositionPhase
Sets the retention time period for this disposition phase.
setReviewer(String) - Method in interface com.ibm.jarm.api.core.Location
Sets the Reviewer property value.
setScheduleName(String) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Sets the DisposalScheduleName property value for this disposition schedule.
setScreeningRequired(boolean) - Method in interface com.ibm.jarm.api.core.DispositionPhase
Set the value for the "Is Screening Required" property.
setScreeningRequired(Boolean) - Method in interface com.ibm.jarm.api.core.DispositionSchedule
Sets the IsScreeningRequired property value for this disposition schedule.
setSelectClause(String) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set the select clause.
setSortOrder(RMContentSearchDefinition.SortOrder) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set the sorting order
setSqlAlias(String) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set the SQL alias of record class
setStringValue(String) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.String.
setStringValue(List<String>) - Method in interface com.ibm.jarm.api.property.RMProperty
Sets the value of a RMProperty instance whose data type is DataType.String and whose cardinality is multi-valued.
setSubject(Subject) - Method in class com.ibm.jarm.api.util.RMUserContext
Associates a JAAS javax.security.auth.Subject instance on this user context for the current thread.
setSweepState(Integer) - Method in interface com.ibm.jarm.api.core.Hold
Sets the value for the SweepState property value.
setTriggerName(String) - Method in interface com.ibm.jarm.api.core.DispositionTrigger
Sets the DisposalTriggerName property value.
setTriggerPropertyName(String) - Method in interface com.ibm.jarm.api.core.DefensiblyDisposable
Updates the assigned record trigger property symbolic name used by an existing Defensibly Disposable container.
setVital(RMProperties) - Method in interface com.ibm.jarm.api.core.Vitalable
Sets the properties related to a vital record for this object.
setWhereClause(String) - Method in class com.ibm.jarm.api.query.RMContentSearchDefinition
Set the where clause.
ShortName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
size() - Method in interface com.ibm.jarm.api.core.AlternateRetentionList
Returns the number of elements in this collection.
size() - Method in interface com.ibm.jarm.api.core.DispositionPhaseList
Returns the number of elements in this collection.
size() - Method in interface com.ibm.jarm.api.property.RMProperties
Returns the current number of property instances in this collection.
size() - Method in interface com.ibm.jarm.api.security.RMRoles
Returns the count of the number of roles in this collection.
SourceClassId - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SourceObject - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SourceObjectId - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SuperclassDescription - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
supersede(Record) - Method in interface com.ibm.jarm.api.core.Record
Causes this record to supersede the specified target record.
SupersededBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SupersededDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
Supersedes - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SupplementalMarkings - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SupplementalMarkingsStringList - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
supportsDefensibleDisposal() - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Indicates whether or not this file plan repository can support "Defensible Disposal" containers and the processes associated with such.
supportsExternalManagement() - Method in interface com.ibm.jarm.api.core.FilePlanRepository
Indicates whether or not this file plan repository supports the "RMExternallyManagedBy" property that allows disposition-related artifacts to be managed by external applications.
supportsPaging() - Method in interface com.ibm.jarm.api.collection.PageableSet
Indicates whether this instance supports paging.
SweepAuditXML - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SweepState - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SWG_ID - Static variable in exception com.ibm.jarm.api.exception.RMRuntimeException
The IBM SWG Component ID assigned to the IBM Enterprise Records API.
SymbolicName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
SystemConfiguration - Static variable in interface com.ibm.jarm.api.constants.RMClassName
File plan repository System Configuration custom object class.
SystemConfiguration - Interface in com.ibm.jarm.api.core
Represents an instance of the IBM Enterprise Records custom object class SystemConfiguration.

T

Tail - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
To - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
toArray() - Method in interface com.ibm.jarm.api.property.RMProperties
Returns an array containing the contents of the property collection.
Topic - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
toString() - Method in interface com.ibm.jarm.api.exception.RMErrorRecord
Returns a string representation of this ErrorRecord instance.
toString() - Method in interface com.ibm.jarm.api.exception.RMErrorStack
Returns a string representation of all contained RMErrorRecord instances.
totalCount() - Method in interface com.ibm.jarm.api.collection.PageableSet
Returns the count requested in a search that includes OPTIONS (COUNT_LIMIT N).
Transcript - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Transcript class.
TransferMapping - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Transfer Mapping class.
transferUsingExternalExport(ExternalExport, boolean) - Method in interface com.ibm.jarm.api.core.Dispositionable
Exports the metadata and any content of this entity and of its hierarchical children using the given external export interface instance.
transferUsingP8_XML() - Method in interface com.ibm.jarm.api.core.Dispositionable
Exports the metadata and any content of this entity and of its hierarchical children as external XML files based on the legacy P8 Content Engine-3.x export schema.

U

unassignRecordAsReceiptOfParent() - Method in interface com.ibm.jarm.api.core.Record
Dissolves the receipt assignment between this record and the parent record to which it is currently assigned.
undeclare() - Method in interface com.ibm.jarm.api.core.Record
Undeclare this record by disconnecting it from any of its associated content items and then performing a hard deletion of the record itself.
undeclareRecords(FilePlanRepository, List<String>) - Static method in class com.ibm.jarm.api.core.BulkOperation
Undeclares each of the specified Record entities.
unfileRecord(Record) - Method in interface com.ibm.jarm.api.core.RecordContainer
Unfiles the specified Record from this RecordContainer.
unfileRecord(String) - Method in interface com.ibm.jarm.api.core.RecordContainer
Unfiles the specified Record from this RecordContainer.
UniqueRecordIdentifier - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
UnsecuredRole - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
UpdateAuditEvent - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Update audit event class.
updatePhaseDataOnEntity() - Method in interface com.ibm.jarm.api.core.Dispositionable
Recalculates the currently executing phase data for this entity and updates the entity accordingly.
updateVitalStatus(Date) - Method in interface com.ibm.jarm.api.core.Vitalable
Updates the VitalRecordNextReviewDate and VitalWorkflowStatus properties for this object.
UpgradedBy - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
UpgradedOn - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
UpgradeOnDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
UpgradeOnEvents - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
UserMembers - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
usesLongColumn() - Method in interface com.ibm.jarm.api.meta.RMPropertyDescriptionString
Specifies whether a string valued property based on this property description is stored in a database column as a short string or as a long string.
Util - Class in com.ibm.jarm.api.util
Static utility methods common to the API and RAL layers.

V

validateForDispositionExport() - Method in interface com.ibm.jarm.api.core.Dispositionable
Performs necessary disposition-related state validation for export and transfer purposes.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.AppliedForCategoryOrFolder
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.ApplyToNameOrID
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.AuditStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.ChoiceItemType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.ContentXMLExport
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.DataModelType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.DataType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.DeleteMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.DispositionActionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.DispositionTriggerType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.DomainType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.EntityType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RepositoryType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RetainMetadata
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMAccessLevel
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMAccessRight
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMAccessType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMCardinality
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMDeletionAction
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMGranteeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMMergeMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMPermissionSource
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMPrincipalSearchAttribute
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMPrincipalSearchSortType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMPrincipalSearchType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMPropertySettability
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMReceiptStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMRefreshMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMSecurityProxyType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.RMWorkflowStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.constants.SchedulePropagation
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.exception.RMErrorCode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.property.RMFilteredPropertyType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.query.RMContentSearchDefinition.AndOrOper
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.query.RMContentSearchDefinition.ContentSearchOption
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.query.RMContentSearchDefinition.OrderBy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.query.RMContentSearchDefinition.SortOrder
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.util.JarmTracer.SubSystem
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.ibm.jarm.api.util.RMLogCode
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.ibm.jarm.api.constants.AppliedForCategoryOrFolder
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.ApplyToNameOrID
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.AuditStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.ChoiceItemType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.ContentXMLExport
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.DataModelType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.DataType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.DeleteMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.DispositionActionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.DispositionTriggerType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.DomainType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.EntityType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RepositoryType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RetainMetadata
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMAccessLevel
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMAccessRight
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMAccessType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMCardinality
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMDeletionAction
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMGranteeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMMergeMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMPermissionSource
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMPrincipalSearchAttribute
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMPrincipalSearchSortType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMPrincipalSearchType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMPropertySettability
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMReceiptStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMRefreshMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMSecurityProxyType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.RMWorkflowStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.constants.SchedulePropagation
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.exception.RMErrorCode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.property.RMFilteredPropertyType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.query.RMContentSearchDefinition.AndOrOper
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.query.RMContentSearchDefinition.ContentSearchOption
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.query.RMContentSearchDefinition.OrderBy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.query.RMContentSearchDefinition.SortOrder
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.util.JarmTracer.SubSystem
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.ibm.jarm.api.util.RMLogCode
Returns an array containing the constants of this enum type, in the order they are declared.
Vitalable - Interface in com.ibm.jarm.api.core
Represents an entity that can be marked as vital to indicate that the object is required for meeting operational responsibilities during an enterprise-wide emergency.
VitalRecordDeclareDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
VitalRecordDisposalTrigger - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
VitalRecordNextReviewDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
VitalRecordReviewAction - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
VitalRecordReviewComments - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
VitalRecordReviewDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
VitalSweepDate - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
VitalWorkflowStatus - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
VolumeName - Static variable in interface com.ibm.jarm.api.constants.RMPropertyName
 
VolumePatternSuffix - Static variable in interface com.ibm.jarm.api.core.SystemConfiguration
 

W

W3C_DATE_FORMAT - Static variable in exception com.ibm.jarm.api.exception.RMRuntimeException
A date format pattern string for the w3c date format standard.
W3C_DATE_FORMAT_WITH_ZONE - Static variable in exception com.ibm.jarm.api.exception.RMRuntimeException
A date format pattern string for the w3c date format standard that includes time zone information.
warn(RMLogCode, Object...) - Method in class com.ibm.jarm.api.util.JarmLogger
Logs a message with the WARN level.
warn(RMLogCode, Throwable, Object...) - Method in class com.ibm.jarm.api.util.JarmLogger
Logs a message with the WARN level including the stack trace of the included Throwable t parameter.
wasSuccessful() - Method in interface com.ibm.jarm.api.core.BulkItemResult
Indicates whether or not the operation was successful for the associated entity.
WebRecord - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Web Record class.
WorkflowDefinition - Static variable in interface com.ibm.jarm.api.constants.RMClassName
Workflow Definition class.
A B C D E F G H I J L M N O P R S T U V W 

© Copyright IBM Corp. 2010, 2013. All Rights Reserved.