1. Script object OG.ClassDef

    Article: AN0002157Updated:

    This object offers functions for reading class metadata.

    Script functions

    Name Description
    ClassDef GetById(int id) Function returns class according to the input Id.
    ClassDefList GetAll() Function returns all the class.
    ClassDef GetByCode(string mCode, string clCode) Function returns class according to the input model code and cass code. If the class does not exist, an exception is returned.
    ClassDef GetByCode( int mId, string clCode) Function returns class according to the model Id and class code. If the class does not exist, an exception is returned.
    ClassDef GetByCode(DataRow dr) Function returns class accroding to the input datarow.  If the class does not exist, an exception is returned.
    ClassDef GetByCode(DataRow dr, string clCode)

    Function returns class.  If the class does not exist, an exception is returned.

    Input parameter dr defines class and model. The returned class is defined by the input parameter clCode.

    RoleRight HaveUserRightByClassDef(int classDefId, ClassDefRoleOperation operation) Function returns TRUE, if the logged on user has access right for the iclass/query with the given operation. Otherwise, FALSE is returned.
    RoleRight  HaveUserRightByOperationCode(int classDefId, string operationCode) Function returns TRUE, if the logged on user has access right for the iclass/query with the given operation. Otherwise, FALSE is returned.
    ClassDefRoleOperation ClassDefRoleOperation_ReadList Operation for reading class list records.
    ClassDefRoleOperation ClassDefRoleOperation_ReadDetail Operation for reading record detail.
    ClassDefRoleOperation ClassDefRoleOperation_Insert Operation for creating record in the class.
    ClassDefRoleOperation ClassDefRoleOperation_Update Operation for updating record in the class.
    ClassDefRoleOperation ClassDefRoleOperation_Delete Operation for deleting record in the class.
    ClassDefRoleOperation ClassDefRoleOperation_MultiChange Operation for mass record update in the class.
    ClassDefRoleOperation ClassDefRoleOperation_MultiDelete Operation for mass record deletion in the class.
    RoleRight RoleRight_None User does not have aby acces right in the class.
    RoleRight RoleRight_OnlyRole User has access right by means of assigned role.
    RoleRight RoleRight_RoleWithOrgStructure User has access right by means of assigned role with organisation structure, i.e. only certain records will be accessible.

     Function HaveUserRightByClassDef returns object type RoleRight, that says whether user has assigned a role in the class/query or role with organisation structure or he does not have any right.

    If RoleRight_None is returned, than user cannot read any records from class/query.

    If RoleRight_OnlyRole is returned, than user can read all the records without limitation. This option is returned in case user has a role in the class or role and role with organisation structure.

    If RoleRight_RoleWithOrgStructure is returned, then user can read only some records. This option is returned in case user has a role with organisation structure.

    Object call

    OG.ClassDef

×