Click or drag to resize

IRole Interface

Represents a role - which defines access rights to information. Can be modified if user has UserAdmin rights.

Namespace:  SuperOffice.COM.SuperOfficeDB
Assembly:  SuperOfficeDB.Interop (in SuperOfficeDB.Interop.dll) Version: 8.0.0.0
Syntax
public interface IRole

The IRole type exposes the following members.

Properties
  NameDescription
Public propertyCode exampleChanged
Has object been changed since it was loaded?
Public propertyDataRight
Public propertyCode exampleDeleted
Has the role been deleted?
Public propertyCode exampleDescription
Description of the role.
Public propertyCode exampleFunctionRights
Collection of function rights active for this role
Public propertyCode exampleIdentity
The primary key on the role table. Is zero for new objects. Is set when an object is saved.
Public propertyCode exampleName
Name of the role.
Public propertyCode exampleType
Type of role (associate/external/anonymous/system).
Top
Methods
  NameDescription
Public methodCode exampleAddFunctionRight
Add a function right to the active list. Use the function right id or the function right key-name (like 'admin-users')
Public methodCode exampleCancelChanges
Cancel reverts the changes to the role
Public methodCode exampleDelete
Delete the role. Marks the role as deleted and removes all data and function rights from the role. Users having the deleted role must be assigned a new role. Will throw an error if you do not have user admin rights.
Public methodCode exampleHasFunctionRight
Returns true if the role has the given function right
Public methodCode exampleIsRelationshipCovered
Returns true if the role defines rights for the given type of relationship. The relationships vary according to role type.
Public methodCode exampleIsTableCovered
Returns true if the role defines rights for the given table. The list of tables is the same for all role types.
Public methodCode exampleRemoveFunctionRight
Remove a function right from the active list. (Refresh the list of functionrights in the role before saving.)
Public methodCode exampleSave
Save stores the changes to the role in the database. Will throw an error if you do not have user admin rights.
Top
See Also