com.ibm.jarm.api.core

Interface RMDomain

  • All Superinterfaces:
    BaseEntity


    public interface RMDomain
    extends BaseEntity
    Represents a domain in which repositories reside.

    Typically, user authentication is on a per-domain basis.

    A existing RMDomain can be acquired using the RMFactory.RMDomain factory class.

    See Also:
    RMFactory.RMDomain
    • Method Detail

      • getName

        java.lang.String getName()
        Returns the DisplayName property value.
        Specified by:
        getName in interface BaseEntity
        Returns:
        A String value.
      • fetchContentRepositories

        java.util.List<ContentRepository> fetchContentRepositories(boolean excludeFilePlanRepositories,
                                                                 RMPropertyFilter filter)
        Returns a collection of ContentRepository instances belonging to this domain.

        Since, by default, any file plan repository is also a valid content repository, the exludeFilePlanRepositories parameter is allowed for the exclusion of such, if desired.

        Parameters:
        excludeFilePlanRepositories - if true then any content repository that is also a file plan repository is excluded from the result set.
        filter - a RMPropertyFilter controlling properties to return for each ContentRepository instance. This entry can be null.
        Returns:
        A collection of ContentRepository instances.
      • fetchCombinedRepositories

        java.util.List<Repository> fetchCombinedRepositories(RMPropertyFilter filter)
        Returns a collection of Repository instances belonging to this domain that have both FPOS and ROS data models installed on it. This instance is known as a "Combined" FilePlan/Content repository.
        Parameters:
        filter - A RMPropertyFilter controlling properties to return for each Repository instance.
        Returns:
        A collection of Repository instances.
      • fetchMarkingSets

        java.util.List<RMMarkingSet> fetchMarkingSets()
        Returns a collection of RMMarkingSet instances belonging to this domain.
        Returns:
        A collection of RMMarkingSet instances.
      • fetchRMRoles

        RMRoles fetchRMRoles(Repository repository,
                           java.lang.String applicationName)
        Retrieves a RMRoles collection containing RMRole instances that are defined upon the specified Repository.
        Parameters:
        repository - the Repository from which roles should be fetched.
        applicationName - an optional application name string that is used to restrict the resulting collection members. If a non-null, non-blank string is provided, then only those role instances with the specified application name are returned; otherwise all role instances defined on the specified repository are returned.
        Returns:
        A RMRoles collection. This entry can be empty.
      • fetchCurrentUser

        RMUser fetchCurrentUser()
        Returns the current user of the current thread on which this method is called.
        Returns:
        A RMUser instance.
      • findGroups

        PageableSet<RMGroup> findGroups(java.lang.String searchPattern,
                                      RMPrincipalSearchType searchType,
                                      RMPrincipalSearchAttribute searchAttr,
                                      RMPrincipalSearchSortType sortType,
                                      java.lang.Integer pageSize)
        Returns a collection of RMGroup instances belonging to this domain based upon the search criteria.
        Parameters:
        searchPattern - a search pattern String.
        searchType - specifies how the search pattern is to be applied.
        searchAttr - specifies the RMGroup property to use for the search.
        sortType - defines any desired sorting of the results.
        pageSize - defines the maximum page size for the results.
        Returns:
        A PageableSet collection of RMGroup.
      • findUsers

        PageableSet<RMUser> findUsers(java.lang.String searchPattern,
                                    RMPrincipalSearchType searchType,
                                    RMPrincipalSearchAttribute searchAttr,
                                    RMPrincipalSearchSortType sortType,
                                    java.lang.Integer pageSize)
        Returns a collection of RMUser instances belonging to this domain based upon the search criteria.
        Parameters:
        searchPattern - a search pattern Stringg.
        searchType - specifies how the search pattern is to be applied.
        searchAttr - specifies the RMUser property to use for the search.
        sortType - defines any desired sorting of the results.
        pageSize - defines the maximum page size for the results.
        Returns:
        A PageableSet collection of RMUser.

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