com.ibm.jarm.api.core

Interface Container

    • Method Detail

      • getAllowedContaineeTypes

        EntityType[] getAllowedContaineeTypes()
        Returns an array of EntityType instances that represent the types of child objects allowed to be contained by this Container.
        Returns:
        An array of EntityType.
      • canContain

        boolean canContain(EntityType type)
        Indicates whether or not this Container is allowed to contain a child object of the specified EntityType.
        Parameters:
        type - the specified EntityType.
        Returns:
        true if the type is allowed, false otherwise.
      • getFolderName

        java.lang.String getFolderName()
        Returns the FolderName property value for this Container.
        Returns:
        A String value.
      • getPathName

        java.lang.String getPathName()
        Returns the PathName property value for this Container.
        Returns:
        A String value.
      • getParent

        Container getParent()
        Returns the immediate parent container of this container, if any.
        Returns:
        A Container instance or null if no such parent exists.
      • getImmediateSubContainers

        PageableSet<Container> getImmediateSubContainers(java.lang.Integer pageSize)
        Returns a pageable set of immediate sub-containers belonging to this container.
        Parameters:
        pageSize - optional page size to use. If null then the repository default value is used.
        Returns:
        A PageableSet of Container instances.
      • delete

        void delete(boolean skipValidation,
                  DeleteMode deleteMode,
                  java.lang.String reasonForDelete)
        Deletes the container from its associated repository. If the "skipValidation" input parameter is false, then any validation failure prevents the deletion from occurring and an exception is thrown.

        All sub-containers in this instance's sub-hierarchy are also deleted. All single-filed records contained within this instance's sub-hierarchy are also deleted, however any multi-filed records are simply unfiled from any containers targeted for deletion.

        Parameters:
        skipValidation - true to skip delete validation.
        deleteMode - one of the DeleteMode enumeration values.
        reasonForDelete - text used to support auditing.

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