com.filenet.rm.api

Interface ActivableObject

  • All Superinterfaces:
    com.filenet.wcm.api.BaseObject, com.filenet.wcm.api.Folder, com.filenet.wcm.api.GettableObject, com.filenet.wcm.api.LockableObject, com.filenet.wcm.api.ReadableMetadataObject, com.filenet.wcm.api.ReadableSecurityObject, RMFolder, RMObject, java.io.Serializable, com.filenet.wcm.api.ValueObject, com.filenet.wcm.api.WorkflowTarget, com.filenet.wcm.api.WriteableMetadataObject, com.filenet.wcm.api.WriteableSecurityObject
    All Known Subinterfaces:
    RecordCategory, RecordFolder, Volume


    public interface ActivableObject
    extends RMFolder
    Defines the behavior of any Records Manager container object that can be activated or inactivated.

    When a container object is inactivated

    • The child objects within that container are also inactivated. For example, if you inactivate a record category, all the record folders and volumes within that record category are inactivated.

    • No child objects can be added to the container. For example, if a record category is inactivated, you cannot add record categories, record folders, or records to that category.

    When an inactive container object is activated again, the child objects within that container object remain inactive.

    To inactivate or inactivate an ActivableObject object, call the inActivate method.

    • Field Summary

      • 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
      RMFolders getInActiveParents(boolean abFirstParentOnly)
      Returns a collection of containing either the first inactive parent of this container object or all inactive parents.
      void inActivate(boolean abInactive, java.lang.String asReasonforInActivate)
      Inactivates or activates this container object.
      boolean isAnyParentInActive()
      Returns a boolean value indicating whether any parent of this container object is inactive.
      boolean isInActive(boolean abCheckParents)
      Returns a boolean value indicating whether this container object or, optionally, any parent of this object is inactive.
      • Methods inherited from interface com.filenet.wcm.api.Folder

        addSubFolder, addSubFolder, applySecurityTemplate, changeClass, delete, getContainees, getContainees, getContainees, getContainees, getContainees, getContainees, getContaineesXML, getContaineesXML, getHeadLinks, getHeadLinksXML, getParentFolder, getParentFolderXML, getPermissionsXML, getSubscriptions, getTailLinks, getTailLinksXML, getUserAccess, getUserAccess, getUserAccess, move, raiseEvent
      • 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

      • inActivate

        void inActivate(boolean abInactive,
                      java.lang.String asReasonforInActivate)
                        throws RMException
        Inactivates or activates this container object.
        Parameters:
        abInactive - A boolean value set to true to inactivate this object or false to activate this object.
        asReasonforInActivate - A String specifying the reason this object is to be inactivated or activated. This parameter cannot be null if you are inactivating the object.
        Throws:
        RMException - If a Records Manager error occurs.
      • isInActive

        boolean isInActive(boolean abCheckParents)
                           throws RMException
        Returns a boolean value indicating whether this container object or, optionally, any parent of this object is inactive.
        Parameters:
        abCheckParents - A boolean value set to true to check the active state of the parents of this object or false to check only the state of this object.
        Returns:
        true if this object or one of its parents is inactive; otherwise, returns false.
        Throws:
        RMException - If a Records Manager error occurs.
      • isAnyParentInActive

        boolean isAnyParentInActive()
                                    throws RMException
        Returns a boolean value indicating whether any parent of this container object is inactive.
        Returns:
        true if any parent of this object is inactive; otherwise, returns false.
        Throws:
        RMException - If a Records Manager error occurs.
      • getInActiveParents

        RMFolders getInActiveParents(boolean abFirstParentOnly)
                                     throws RMException
        Returns a collection of containing either the first inactive parent of this container object or all inactive parents.
        Parameters:
        abFirstParentOnly - A boolean value set to true to return only the first inactive parent in the hierarchy or false to return all inactive parents.
        Returns:
        A collection containing either the first or all inactive parents of this container object.
        Throws:
        RMException - If a Records Manager error occurs.

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