com.ibm.jarm.api.constants

Enum EntityType

  • java.lang.Object
    • java.lang.Enum<EntityType>
      • com.ibm.jarm.api.constants.EntityType
  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<EntityType>


    public enum EntityType
    extends java.lang.Enum<EntityType>
    Enumerated values for the various entity types supported by this API.

    For the vast majority of the various entities, their entity type value is defined by their read-only property value RMPropertyName.RMEntityType.

    • Enum Constant Detail

      • FilePlan

        public static final EntityType FilePlan
        Represents a file plan.
      • RecordCategory

        public static final EntityType RecordCategory
        Represents a record category.
      • RecordFolder

        public static final EntityType RecordFolder
        Represents a generalized record folder.
      • RecordVolume

        public static final EntityType RecordVolume
        Represents a record volume.
      • ElectronicRecordFolder

        public static final EntityType ElectronicRecordFolder
        Represents a electronic record folder.
      • PhysicalContainer

        public static final EntityType PhysicalContainer
        Represents a generalized physical record container or Box.
      • HybridRecordFolder

        public static final EntityType HybridRecordFolder
        Represents a hybrid record folder.
      • RMFolder

        public static final EntityType RMFolder
        Represents the base records manager folder class.
      • PhysicalRecordFolder

        public static final EntityType PhysicalRecordFolder
        Represents a physical record folder.
      • DispositionAction

        public static final EntityType DispositionAction
        Represents a disposition action.
      • DispositionSchedule

        public static final EntityType DispositionSchedule
        Represents a disposition schedule.
      • DisposalPhase

        public static final EntityType DisposalPhase
        Represents the "DisposalPhase" class (no longer used).
      • DispositionTrigger

        public static final EntityType DispositionTrigger
        Represents a disposition trigger.
      • Pattern

        public static final EntityType Pattern
        Represents a naming pattern.
      • PatternLevel

        public static final EntityType PatternLevel
        Represents a naming pattern level.
      • ReportDefinition

        public static final EntityType ReportDefinition
        Represents a report definition.
      • Reservation

        public static final EntityType Reservation
        Represents a reservation.
      • Phase

        public static final EntityType Phase
        Represents a phase that is a member of a disposition schedule.
      • PhaseException

        public static final EntityType PhaseException
        Represents a phase exception.
      • SystemConfiguration

        public static final EntityType SystemConfiguration
        Represents a system configuration.
      • ConnectorRegistration

        public static final EntityType ConnectorRegistration
        Represents a connector registration.
      • RecordType

        public static final EntityType RecordType
        Represents a record type.
      • Location

        public static final EntityType Location
        Represents a physical location.
      • Hold

        public static final EntityType Hold
        Represents a hold.
      • PatternSequence

        public static final EntityType PatternSequence
        Represents a naming pattern sequence.
      • AlternateRetention

        public static final EntityType AlternateRetention
        Represents an alternate retention member of a disposition phase.
      • RMLog

        public static final EntityType RMLog
        Represents a specialized custom object.
      • RMSystem

        public static final EntityType RMSystem
        Represents a specialized custom object used to support a custom P8 CE event handler.
      • Record

        public static final EntityType Record
        Represents a generalized record.
      • ElectronicRecord

        public static final EntityType ElectronicRecord
        Represents an electronic record.
      • EmailRecord

        public static final EntityType EmailRecord
        Represents an email record.
      • PhysicalRecord

        public static final EntityType PhysicalRecord
        Represents a physical record.
      • Transcript

        public static final EntityType Transcript
        Represents a transcript document.
      • PDFRecord

        public static final EntityType PDFRecord
        Represents a PDF record.
      • Relation

        public static final EntityType Relation
        Represents a generalized link.
      • ExtractLink

        public static final EntityType ExtractLink
        Represents an extraction link.
      • RecordCopyLink

        public static final EntityType RecordCopyLink
        Represents a "copy" record link.
      • RecordSeeAlsoLink

        public static final EntityType RecordSeeAlsoLink
        Represents a "see also" record link.
      • ReferenceLink

        public static final EntityType ReferenceLink
        Represents a generalized reference.
      • SupersedeLink

        public static final EntityType SupersedeLink
        Represents a supersede link.
      • RecordHoldLink

        public static final EntityType RecordHoldLink
        Represents a record hold link.
      • RecordContainerHoldLink

        public static final EntityType RecordContainerHoldLink
        Represents a record container hold link.
      • RMLink

        public static final EntityType RMLink
        Represents a generalized link.
      • ReceiptLink

        public static final EntityType ReceiptLink
        Represents a receipt link.
      • ContentRepository

        public static final EntityType ContentRepository
        Represents a content repository.
      • FilePlanRepository

        public static final EntityType FilePlanRepository
        Represents a file plan repository.
      • Repository

        public static final EntityType Repository
        Represents a generalized repository.
      • Domain

        public static final EntityType Domain
        Represents a generalized domain.
      • AuditEvent

        public static final EntityType AuditEvent
        Represents an audit event.
      • ClassificationGuide

        public static final EntityType ClassificationGuide
        Represents a security classification guide.
      • ClassificationGuideSection

        public static final EntityType ClassificationGuideSection
        Represents a section within a security classification guide.
      • ClassificationGuideTopic

        public static final EntityType ClassificationGuideTopic
        Represents a topic within a security classification guide.
      • AuditConfig

        public static final EntityType AuditConfig
        Represents an audit configuration.
      • TransferMapping

        public static final EntityType TransferMapping
        Represents a transfer mapping definition.
      • Container

        public static final EntityType Container
        Represents a generic container.
      • CustomObject

        public static final EntityType CustomObject
        Represents a generic custom object.
      • SecurityPrincipal

        public static final EntityType SecurityPrincipal
        Represents a user or group object.
      • AccessRole

        public static final EntityType AccessRole
        Represents a functional access role.
      • ContentItem

        public static final EntityType ContentItem
        Represents a generic content item.
      • WorkflowDefinition

        public static final EntityType WorkflowDefinition
        Represents a workflow definition document.
      • MarkingSet

        public static final EntityType MarkingSet
        Represents a marking set.
      • ChoiceList

        public static final EntityType ChoiceList
        Represents a choice list.
      • Unknown

        public static final EntityType Unknown
        Represents an unknown entity type.
    • Method Detail

      • values

        public static EntityType[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (EntityType c : EntityType.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static EntityType valueOf(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • getIntValue

        public int getIntValue()
        Returns the integer value associated with this member.
        Returns:
        An int value.
      • getInstanceFromInt

        public static EntityType getInstanceFromInt(int intValue)
        Provides the EntityType instance that corresponds to the given int value.
        Parameters:
        intValue - the int value to look up.
        Returns:
        An EntityType value or null if no such value corresponds to the given intValue parameter.

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