HP.HPTRIM.SDK.TrimAccessControlList Class Reference

The TrimAccessControlList class is used to encapsulate the access controls that can be applied to an object an access control list consists of an array of entries that control who has access to a particular restricted function. These restricted functions may differ depending upon which object the access control list applies to, for example a meeting object may wish to restrict who can 'Take Minutes'. Each object that support access control lists will have an enum describing its set of restricted functions - in this class, the elements of this enum are simple defined as an int. More...

Public Member Functions
bool	GetAccessAllowed (int forFunction)
	Returns a Boolean value indicating whether the currently logged in user is provided access to the specified function. More...
bool	get_AccessAllowed (int forFunction)
bool	GetAccessAllowedForUser (int toFunction, Location forAccessLocation)
	Returns a Boolean value indicating whether the given user is provided access to the specified function. More...
string	GetAsString (int forFunction)
	Gets a string containing a description of the nominated access control for this object. The string consists of a list of location names for this Access Control, delimited by semicolons. More...
string	get_AsString (int forFunction)
LocationList	get_AccessLocations (int forFunction)
	Gets or sets the list of locations that should be given access to the specified function. When updating the list, if the new list is empty or null, access to that function will revert to 'Everyone' or 'Public', otherwise the current user list will be replaced. More...
void	set_AccessLocations (int forFunction, LocationList replaceWith)
LocationList	GetAccessLocations (int forFunction)
void	SetAccessLocations (int forFunction, LocationList replaceWith)
void	SetAccessLocationsOrContainer (int forFunction, LocationList replaceWith)
	A special function that will set access to the specified function to the nominated set of locations, however will also include any locations in the corresponding access control of the container to be included. More...
void	SetPrivate (int forFunction, Location toLocation)
	Sets the access control for the nominated function to be a single location. More...
void	SetPrivateOrContainer (int forFunction, Location toLocation)
	A special function that will set access to the specified function to the nominated location, however will also include any locations in the corresponding access control of the container to be included. More...
void	SetInherited (int forFunction)
	Sets the access control for the nominated function to be inherited from the record's container More...
void	SetPublic (int forFunction)
	Sets the access control for the nominated function to be public More...
AccessControlSettings	get_CurrentSetting (int forFunction)
	Gets or sets an AccessControlSettings enum value indicating whether the Access Control is Inherited, Private (Custom) or Public. Note that the Inherited value only applied to record, indicating that the record's access control is based on the record's container. If you change this value to 'Private', it will be made private to the currently logged in user More...
void	set_CurrentSetting (int forFunction, AccessControlSettings newValue)
AccessControlSettings	GetCurrentAccessControlSettings (int forFunction)
void	SetCurrentAccessControlSettings (int forFunction, AccessControlSettings newValue)
AccessReferenceStyle	get_ReferenceStyle (int forFunction)
	Gets or sets an AccessReferenceStyle enum value indicating how this access control list is is to be applied to the target object which it will be copied to. Reference style only applies to access controls that are to be copied, i.e. the default record access control that is defined for a record type. Check the IsCopied property to see if this is applicable. More...
void	set_ReferenceStyle (int forFunction, AccessReferenceStyle newValue)
AccessReferenceStyle	GetReferenceStyle (int forFunction)
void	SetReferenceStyle (int forFunction, AccessReferenceStyle newValue)
void	SetAllInherited ()
	Allows you to set all the access controls to be based on the record's container More...
void	SetAllPrivate (LocationList toLocations)
	Allows you to set all the access controls to the nominated list of locations More...
void	SetAllPrivate (Location toLocation)
	Allows you to set all the access controls to the nominated single location More...
void	SetAllPrivate ()
	Allows you to set all the access controls to the current user More...
void	SetAllPublic ()
	Allows you to set all the access controls to the 'Public'/'Everyone' same setting. More...

Properties
AllEnumerations	FunctionEnum [get]
	Gets the enumeration which lists the functions that are applicable for this access control list. More...
bool	IsCopied [get]
	Gets a boolean value indicating if this access control list is one that is a copy default list. More...
bool	IsModified [get]
	Gets a boolean parameter indicating if any changes have been made to this access control list since it was first constructed. More...

Detailed Description

The TrimAccessControlList class is used to encapsulate the access controls that can be applied to an object an access control list consists of an array of entries that control who has access to a particular restricted function. These restricted functions may differ depending upon which object the access control list applies to, for example a meeting object may wish to restrict who can 'Take Minutes'. Each object that support access control lists will have an enum describing its set of restricted functions - in this class, the elements of this enum are simple defined as an int.

Member Function Documentation

bool HP.HPTRIM.SDK.TrimAccessControlList.get_AccessAllowed

(

int

forFunction

)

LocationList HP.HPTRIM.SDK.TrimAccessControlList.get_AccessLocations

(

int

forFunction

)

Gets or sets the list of locations that should be given access to the specified function. When updating the list, if the new list is empty or null, access to that function will revert to 'Everyone' or 'Public', otherwise the current user list will be replaced.

string HP.HPTRIM.SDK.TrimAccessControlList.get_AsString

(

int

forFunction

)

AccessControlSettings HP.HPTRIM.SDK.TrimAccessControlList.get_CurrentSetting

(

int

forFunction

)

Gets or sets an AccessControlSettings enum value indicating whether the Access Control is Inherited, Private (Custom) or Public. Note that the Inherited value only applied to record, indicating that the record's access control is based on the record's container. If you change this value to 'Private', it will be made private to the currently logged in user

AccessReferenceStyle HP.HPTRIM.SDK.TrimAccessControlList.get_ReferenceStyle

(

int

forFunction

)

Gets or sets an AccessReferenceStyle enum value indicating how this access control list is is to be applied to the target object which it will be copied to. Reference style only applies to access controls that are to be copied, i.e. the default record access control that is defined for a record type. Check the IsCopied property to see if this is applicable.

bool HP.HPTRIM.SDK.TrimAccessControlList.GetAccessAllowed

(

int

forFunction

)

Returns a Boolean value indicating whether the currently logged in user is provided access to the specified function.

bool HP.HPTRIM.SDK.TrimAccessControlList.GetAccessAllowedForUser	(	int	toFunction,
		Location	forAccessLocation
	)

Returns a Boolean value indicating whether the given user is provided access to the specified function.

LocationList HP.HPTRIM.SDK.TrimAccessControlList.GetAccessLocations

(

int

forFunction

)

string HP.HPTRIM.SDK.TrimAccessControlList.GetAsString

(

int

forFunction

)

Gets a string containing a description of the nominated access control for this object. The string consists of a list of location names for this Access Control, delimited by semicolons.

AccessControlSettings HP.HPTRIM.SDK.TrimAccessControlList.GetCurrentAccessControlSettings

(

int

forFunction

)

AccessReferenceStyle HP.HPTRIM.SDK.TrimAccessControlList.GetReferenceStyle

(

int

forFunction

)

void HP.HPTRIM.SDK.TrimAccessControlList.set_AccessLocations	(	int	forFunction,
		LocationList	replaceWith
	)

void HP.HPTRIM.SDK.TrimAccessControlList.set_CurrentSetting	(	int	forFunction,
		AccessControlSettings	newValue
	)

void HP.HPTRIM.SDK.TrimAccessControlList.set_ReferenceStyle	(	int	forFunction,
		AccessReferenceStyle	newValue
	)

void HP.HPTRIM.SDK.TrimAccessControlList.SetAccessLocations	(	int	forFunction,
		LocationList	replaceWith
	)

void HP.HPTRIM.SDK.TrimAccessControlList.SetAccessLocationsOrContainer	(	int	forFunction,
		LocationList	replaceWith
	)

A special function that will set access to the specified function to the nominated set of locations, however will also include any locations in the corresponding access control of the container to be included.

void HP.HPTRIM.SDK.TrimAccessControlList.SetAllInherited

(

)

Allows you to set all the access controls to be based on the record's container

void HP.HPTRIM.SDK.TrimAccessControlList.SetAllPrivate

(

LocationList

toLocations

)

Allows you to set all the access controls to the nominated list of locations

void HP.HPTRIM.SDK.TrimAccessControlList.SetAllPrivate

(

Location

toLocation

)

Allows you to set all the access controls to the nominated single location

void HP.HPTRIM.SDK.TrimAccessControlList.SetAllPrivate

(

)

Allows you to set all the access controls to the current user

void HP.HPTRIM.SDK.TrimAccessControlList.SetAllPublic

(

)

Allows you to set all the access controls to the 'Public'/'Everyone' same setting.

void HP.HPTRIM.SDK.TrimAccessControlList.SetCurrentAccessControlSettings	(	int	forFunction,
		AccessControlSettings	newValue
	)

void HP.HPTRIM.SDK.TrimAccessControlList.SetInherited

(

int

forFunction

)

Sets the access control for the nominated function to be inherited from the record's container

void HP.HPTRIM.SDK.TrimAccessControlList.SetPrivate	(	int	forFunction,
		Location	toLocation
	)

Sets the access control for the nominated function to be a single location.

void HP.HPTRIM.SDK.TrimAccessControlList.SetPrivateOrContainer	(	int	forFunction,
		Location	toLocation
	)

A special function that will set access to the specified function to the nominated location, however will also include any locations in the corresponding access control of the container to be included.

void HP.HPTRIM.SDK.TrimAccessControlList.SetPublic

(

int

forFunction

)

Sets the access control for the nominated function to be public

void HP.HPTRIM.SDK.TrimAccessControlList.SetReferenceStyle	(	int	forFunction,
		AccessReferenceStyle	newValue
	)

Property Documentation

AllEnumerations HP.HPTRIM.SDK.TrimAccessControlList.FunctionEnum

get

Gets the enumeration which lists the functions that are applicable for this access control list.

bool HP.HPTRIM.SDK.TrimAccessControlList.IsCopied

get

Gets a boolean value indicating if this access control list is one that is a copy default list.

bool HP.HPTRIM.SDK.TrimAccessControlList.IsModified

get

Gets a boolean parameter indicating if any changes have been made to this access control list since it was first constructed.