IDSSUserSecurityFilterMappings Interface Reference

List of all members.

---

Detailed Description

This interface defines properties and methods of IDSSSecurityFilterMappingS objects, which is a object representation of MDSecurityFilter linkitems related to specific user, possibly specific project, and security filters.

Public Member Functions
HRESULT	Add ([in] IDSSProject *ipProject,[in] IDSSMDSecurityFilter *ipMDSecurityFilter)
	Add a security filter for a specified project to the user.
HRESULT	Count ([out, retval] Int32 *opCount)
	Number of Security Filters of the user.
HRESULT	IncludeGroup ([in] VARIANT_BOOL iIncludeGroup)
	Set the IncludeGroup property.
HRESULT	IncludeGroup ([out, retval] VARIANT_BOOL *opIncludeGroup)
	Get the IncludeGruop property.
HRESULT	Looksup ()
	Refresh security fitler mapping.
HRESULT	MapProject ([in] Int32 iIndex,[out, retval] IDSSProject oppProject)
HRESULT	MapSecurityFilter ([in] Int32 iIndex,[out, retval] IDSSMDSecurityFilter opSecurityFilter)
HRESULT	MapUser ([in] Int32 iIndex,[out, retval] IDSSUser oppUserID)
	The UserSecurityFilterMapping is actually a list of triples.
HRESULT	Project ([in] IDSSProject *ipProject)
	Set the project property.
HRESULT	Project ([out, retval] IDSSProject oppProject)
	Get the project property.
HRESULT	Remove ([in] IDSSProject *ipProject,[in] IDSSMDSecurityFilter *ipMDSecurityFilter)
	Remove the security filter(s).
HRESULT	User ([out, retval] IDSSUser oppUser)
	Get the User.

---

Member Function Documentation

HRESULT IDSSUserSecurityFilterMappings::Add (  [in] IDSSProject *  ipProject, [in] IDSSMDSecurityFilter *  ipMDSecurityFilter )

Add a security filter for a specified project to the user. It will remove the existing security filter for the project. Parameters: ipProject  the project to be associated with the security filter. If it's NULL, the security filter will be associate to all projects for the user. ipMDSecurityFilter  the security filter to be added

HRESULT IDSSUserSecurityFilterMappings::Count (  [out, retval] Int32 *  opCount  )

Number of Security Filters of the user. Need to consult IncludeGroup property to see if inherited SFs are included in the return. Parameters: opCount  return value

HRESULT IDSSUserSecurityFilterMappings::IncludeGroup (  [in] VARIANT_BOOL  iIncludeGroup  )

Set the IncludeGroup property. Parameters: iIncludeGroup  The value to be set

HRESULT IDSSUserSecurityFilterMappings::IncludeGroup (  [out, retval] VARIANT_BOOL *  opIncludeGroup  )

Get the IncludeGruop property. This property indicates if inherited Security filters has been included. Parameters: opIncludeGroup  the return value

HRESULT IDSSUserSecurityFilterMappings::Looksup (   )

Refresh security fitler mapping. This call will retrieve the metadata.

HRESULT IDSSUserSecurityFilterMappings::MapProject (  [in] Int32  iIndex, [out, retval] IDSSProject   oppProject )

HRESULT IDSSUserSecurityFilterMappings::MapSecurityFilter (  [in] Int32  iIndex, [out, retval] IDSSMDSecurityFilter   opSecurityFilter )

HRESULT IDSSUserSecurityFilterMappings::MapUser (  [in] Int32  iIndex, [out, retval] IDSSUser   oppUserID )

The UserSecurityFilterMapping is actually a list of triples. Each triple has a user, a project and a security filter, indicating the relationship of these three objects. The following three methods are used access the triples by index(range from 1 to count()).

HRESULT IDSSUserSecurityFilterMappings::Project (  [in] IDSSProject *  ipProject  )

Set the project property. Parameters: ipProject  The project property to be set, could be NULL.

HRESULT IDSSUserSecurityFilterMappings::Project (  [out, retval] IDSSProject   oppProject  )

Get the project property. This property can be NULL, indicating a wildcard in finding linkitems. Parameters: oppProject  the return value

HRESULT IDSSUserSecurityFilterMappings::Remove (  [in] IDSSProject *  ipProject, [in] IDSSMDSecurityFilter *  ipMDSecurityFilter )

Remove the security filter(s). Triples of the same user ID and security filter ID, matching projectID will be removed. Note that inherited SF will not removed in this operation. Parameters: ipProject  the project to be associated with the security filter. If it's NULL, security filters associating to the user will be processed. ipMDSecurityFilter  the security filter to be removed.

HRESULT IDSSUserSecurityFilterMappings::User (  [out, retval] IDSSUser   oppUser  )

Get the User. User is fixed for each object instance, no propget for this property. Parameters: oppUser  return value, the user object.

---