class Salesforce::Types::FieldLevelSecurity

A generic FieldLevelSecurity class that can be extended for specific metadata objects, e.g. ProfileFieldLevelSecurity.

@author Ben Burwell

Public Instance Methods

get_permissions() click to toggle source

Get all the permissions granted as an easy-to-use Array

@author Ben Burwell @return [Array] an array of strings representing the permissions that

are granted.
# File lib/mdata/types/FieldLevelSecurity.rb, line 22
def get_permissions
        permissions = Array.new
        permissions.push 'Editable' if @editable == 'true'
        permissions.push 'Hidden' if @hidden == 'true'
        permissions.push 'Readable' if @readable == 'true'
        permissions
end
to_flag_style() click to toggle source

Produces a string representation of the permissions suitable for displaying in a list, à la `ls -la`. The resulting list might look something like this:

Readable Editable
                  Hidden
Readable

@author Ben Burwell @return [String] the permissions granted on the field, flag-style

# File lib/mdata/types/FieldLevelSecurity.rb, line 48
def to_flag_style
        flags = ''
        if @readable == 'true'
                flags += 'Readable '
        else
                flags += '         '
        end

        if @editable == 'true'
                flags += 'Editable '
        else
                flags += '         '
        end

        if @hidden == 'true'
                flags += 'Hidden'
        else
                flags += '      '
        end

        flags
end
to_s() click to toggle source

Get a string representation of the permissions

@author Ben Burwell @return [String] the permissions granted on the field, comma separated

# File lib/mdata/types/FieldLevelSecurity.rb, line 34
def to_s
        get_permissions.join(', ')
end