public interface RMDomain extends BaseEntity
Typically, user authentication is on a per-domain basis.
A existing RMDomain
can be acquired using
the RMFactory.RMDomain
factory class.
RMFactory.RMDomain
Modifier and Type | Method and Description |
---|---|
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. |
java.util.List<ContentRepository> |
fetchContentRepositories(boolean excludeFilePlanRepositories,
RMPropertyFilter filter)
Returns a collection of
ContentRepository instances belonging to this domain. |
RMUser |
fetchCurrentUser()
Returns the current user of the current thread on which this method is called.
|
java.util.List<FilePlanRepository> |
fetchFilePlanRepositories(RMPropertyFilter filter)
Returns a collection of
FilePlanRepository instances belonging to this domain. |
java.util.List<RMMarkingSet> |
fetchMarkingSets()
Returns a collection of
RMMarkingSet instances belonging to this domain. |
RMRoles |
fetchRMRoles(Repository repository,
java.lang.String applicationName)
Retrieves a
RMRoles collection containing
RMRole instances that are defined upon the
specified Repository . |
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. |
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. |
DomainConnection |
getDomainConnection()
Returns the
DomainConnection instance associated with this domain. |
DomainType |
getDomainType()
Returns the
DomainType of this domain. |
java.lang.String |
getName()
Returns the
DisplayName property value. |
getAccessAllowed, getClassDescription, getClassName, getClientIdentifier, getContainedBy, getEntityType, getObjectIdentity, getPermissions, getProperties, getRepository, isCreationPending, isPlaceholder, refresh, refresh, refresh
java.lang.String getName()
DisplayName
property value.getName
in interface BaseEntity
String
value.DomainConnection getDomainConnection()
DomainConnection
instance associated with this domain.DomainConnection
instance.DomainType getDomainType()
DomainType
of this domain.getDomainType
in interface BaseEntity
DomainType
value.java.util.List<FilePlanRepository> fetchFilePlanRepositories(RMPropertyFilter filter)
FilePlanRepository
instances belonging to this domain.filter
- An optional RMPropertyFilter
controlling properties to return for
each FilePlanRepository
instance. This entry can be null
.FilePlanRepository
instances.java.util.List<ContentRepository> fetchContentRepositories(boolean excludeFilePlanRepositories, RMPropertyFilter filter)
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.
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
.ContentRepository
instances.java.util.List<Repository> fetchCombinedRepositories(RMPropertyFilter filter)
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.filter
- A RMPropertyFilter
controlling properties to return for
each Repository
instance.Repository
instances.java.util.List<RMMarkingSet> fetchMarkingSets()
RMMarkingSet
instances belonging to this domain.RMMarkingSet
instances.RMRoles fetchRMRoles(Repository repository, java.lang.String applicationName)
RMRoles
collection containing
RMRole
instances that are defined upon the
specified Repository
.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.RMRoles
collection. This entry can be empty.RMUser fetchCurrentUser()
RMUser
instance.PageableSet<RMGroup> findGroups(java.lang.String searchPattern, RMPrincipalSearchType searchType, RMPrincipalSearchAttribute searchAttr, RMPrincipalSearchSortType sortType, java.lang.Integer pageSize)
RMGroup
instances belonging
to this domain based upon the search criteria.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.PageableSet
collection of
RMGroup
.PageableSet<RMUser> findUsers(java.lang.String searchPattern, RMPrincipalSearchType searchType, RMPrincipalSearchAttribute searchAttr, RMPrincipalSearchSortType sortType, java.lang.Integer pageSize)
RMUser
instances belonging
to this domain based upon the search criteria.searchPattern
- a search pattern String
g.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.PageableSet
collection of
RMUser
.© Copyright IBM Corp. 2010, 2013. All Rights Reserved.