com.filenet.rm.api

Interface GuideTopic

  • All Superinterfaces:
    com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.ContainableObject, com.filenet.wcm.api.CreatableObject, com.filenet.wcm.api.Document, com.filenet.wcm.api.GettableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, java.io.Serializable, com.filenet.wcm.api.ValueObject, com.filenet.wcm.api.VersionableObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject


    public interface GuideTopic
    extends com.filenet.wcm.api.Document
    Represents a topic in a classification guide.
    • Field Summary

      • Fields inherited from interface com.filenet.wcm.api.Document

        LIFECYCLE_CLEAR_EXCEPTION, LIFECYCLE_DEMOTE, LIFECYCLE_NO_CHANGE, LIFECYCLE_PROMOTE, LIFECYCLE_RESET, LIFECYCLE_SET_EXCEPTION, UNKNOWN_CONTENT_LENGTH
      • Fields inherited from interface com.filenet.wcm.api.ContainableObject

        INVALID_CONTAINMENT_NAME_CHARACTERS
      • Fields inherited from interface com.filenet.wcm.api.VersionableObject

        APPLY_STATE_ID_IN_PROCESS, APPLY_STATE_ID_RELEASED, APPLY_STATE_ID_RESERVATION, APPLY_STATE_ID_SUPERSEDED, RESERVATION_TYPE_COLLABORATIVE, RESERVATION_TYPE_DEFAULT, RESERVATION_TYPE_EXCLUSIVE, VERSION_STATUS_IN_PROCESS, VERSION_STATUS_RELEASED, VERSION_STATUS_RESERVATION, VERSION_STATUS_SUPERSEDED
      • Fields inherited from interface com.filenet.wcm.api.BaseObject

        EXPORT_DEFAULT, EXPORT_ENCODED_CONTENT, EXPORT_FULL, EXPORT_OBJECT_ID, EXPORT_OBJECT_SECURITY, IMPORT_DEFAULT, IMPORT_OBJECT_ID, IMPORT_OWNER, IMPORT_PERMISSIONS, TYPE_ACTIVE_MARKING, TYPE_ANNOTATION, TYPE_ANY, TYPE_AUDIT_DEFINITION, TYPE_CBR_ENGINE_TYPE, TYPE_CHOICE, TYPE_CHOICELIST, TYPE_CLASS_SUBSCRIPTION, TYPE_CLASSDEFINITION, TYPE_CLASSDESCRIPTION, TYPE_COLUMN_DEFINITION, TYPE_COMPUTER, TYPE_CONTENT_CACHE_SERVICE, TYPE_CONTENT_MGR_SERVICE, TYPE_CONTENT_REFERENCE, TYPE_CONTENT_TRANSFER, TYPE_CUSTOMOBJECT, TYPE_DOCUMENT, TYPE_DOCUMENT_CLASSIFICATION_ACTION, TYPE_DOCUMENT_LIFECYCLE_ACTION, TYPE_DOCUMENT_LIFECYCLE_POLICY, TYPE_DOCUMENTSTATE, TYPE_DOMAIN, TYPE_DYNAMIC_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_ENTIRENETWORK, TYPE_EVENT, TYPE_EVENT_ACTION, TYPE_FEATURE_ADD_ON, TYPE_FILESTORE, TYPE_FOLDER, TYPE_GROUP, TYPE_INSTANCE_SUBSCRIPTION, TYPE_LINK, TYPE_LOCALIZED_STRING, TYPE_MARKING_SET, TYPE_MULTIPLEVALUES, TYPE_OBJECT_STORE, TYPE_OBJECTSET, TYPE_OBJSTORE_SERVICE, TYPE_PERMISSION, TYPE_PROPERTY_DEFINITION, TYPE_PROPERTYDESCRIPTION, TYPE_PROPERTYDESCRIPTIONS, TYPE_PUBLISH_REQUEST, TYPE_PUBLISH_TEMPLATE, TYPE_READONLY_OBJECT_SET, TYPE_REALM, TYPE_REFERENTIAL_CONTAINMENT_RELATIONSHIP, TYPE_SECURITY_POLICY, TYPE_SECURITY_TEMPLATE, TYPE_STORAGE_POLICY, TYPE_STORED_SEARCH, TYPE_STYLE_TEMPLATE, TYPE_SUBSCRIBED_EVENT, TYPE_SUBSCRIPTION, TYPE_TABLE_DEFINITION, TYPE_TRANSIENT, TYPE_USER, TYPE_VERSIONSERIES, TYPE_WORKFLOW_CLASS_SUBSCRIPTION, TYPE_WORKFLOW_INSTANCE_SUBSCRIPTION, TYPE_WORKFLOWDEFINITION, TYPE_XML_PROPERTY_MAPPING_SCRIPT
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      ClassificationGuide getClassificationGuide()
      Retrieves the top-level classification guide for this GuideTopic object.
      void update(com.filenet.wcm.api.Properties aoProps)
      Updates the properties for this GuideTopic object and ensures that the topic name is not duplicated as a result of the update.
      • Methods inherited from interface com.filenet.wcm.api.Document

        applySecurityTemplate, applySecurityTemplate, canDemoteLifeCycleState, changeClass, changeLifeCycleState, delete, delete, deleteContentElement, getContent, getContentElement, getContentElement, getContentElementObjectTypes, getContentElementSequenceNumbers, getContentReferenceElementSequenceNumber, getContentReferenceElementSequenceNumber, getContentReferenceLocation, getContentReferenceLocation, getContentReferenceMimeType, getContentReferenceMimeType, getFilename, getFilename, getHeadLinks, getHeadLinksXML, getLifeCycleStates, getPermissionsXML, getPublications, getPublicationsXML, getPublishTemplates, getPublishTemplatesXML, getSecurityPolicyXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, getVersionSeries, getVersionsXML, isDependent, isPublication, publish, raiseEvent, republish, setContent, setContentReference
      • Methods inherited from interface com.filenet.wcm.api.ContainableObject

        file, file, file, file, getContainers, getContainersXML, getContainmentNames, getContainmentPaths, getSecurityParent, setContainmentName, setContainmentName, setSecurityParent, unfile, unfile
      • Methods inherited from interface com.filenet.wcm.api.VersionableObject

        cancelCheckout, checkin, checkin, checkout, checkout, demoteVersion, freeze, getReservation, getVersions, getVersions, promoteVersion
      • Methods inherited from interface com.filenet.wcm.api.WorkflowTarget

        getWorkflowSubscriptions, getWorkflowSubscriptionsXML, getWorkflowSubscriptionsXML
      • Methods inherited from interface com.filenet.wcm.api.WriteableSecurityObject

        setPermissions, setPermissions
      • Methods inherited from interface com.filenet.wcm.api.WriteableMetadataObject

        setProperties, setProperties
      • Methods inherited from interface com.filenet.wcm.api.ReadableSecurityObject

        getAccessMask, getPermissions, getPermissions
      • Methods inherited from interface com.filenet.wcm.api.ReadableMetadataObject

        getProperties, getProperties, getPropertiesXML, getPropertyBinaryValue, getPropertyBooleanValue, getPropertyDateValue, getPropertyDoubleValue, getPropertyIntValue, getPropertyStringValue, getPropertyValue, getPropertyValuesValue, refresh, refresh
      • Methods inherited from interface com.filenet.wcm.api.BaseObject

        equals, exportObject, getClassId, getId, getName, getObjectStoreId, getObjectType, getSession, hashCode, thisBaseObject
      • Methods inherited from interface com.filenet.wcm.api.LockableObject

        extendLock, extendLock, isLocked, lock, unlock, unlock
    • Method Detail

      • getClassificationGuide

        ClassificationGuide getClassificationGuide()
                                                   throws RMException
        Retrieves the top-level classification guide for this GuideTopic object.
        Returns:
        A ClassificationGuide object representing the top-level classification guide for this object.
        Throws:
        RMException - If a Records Manager error occurs.
      • update

        void update(com.filenet.wcm.api.Properties aoProps)
                    throws RMException
        Updates the properties for this GuideTopic object and ensures that the topic name is not duplicated as a result of the update.
        Parameters:
        aoProps - A Properties collection containing the properties to be updated.
        Throws:
        RMException - If a Records Manager error occurs.

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