- 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
-
- get(int) - Method in interface com.ibm.jarm.api.core.DispositionPhaseList
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- getAssociatedDispositionSchedules() - Method in interface com.ibm.jarm.api.core.DispositionAction
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- getDomainType() - Method in interface com.ibm.jarm.api.core.RMDomain
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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 RMChoiceItem
s 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
-
- 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
-
- getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionAction
-
- getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionSchedule
-
- getInstance(FilePlanRepository, String) - Static method in class com.ibm.jarm.api.core.RMFactory.DispositionTrigger
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
RMMarkingItem
s 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
-
- 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
-
- 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
-
- getPermissionSource() - Method in interface com.ibm.jarm.api.security.RMPermission
-
- getPhaseAction() - Method in interface com.ibm.jarm.api.core.DispositionPhase
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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.
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- 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
-
- setPhaseAction(DispositionAction) - Method in interface com.ibm.jarm.api.core.DispositionPhase
-
- 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
.
- 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
-